org.apache.jetspeed.portalsite
Interface MenuElement

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

Menu, MenuOption, MenuSeparator

public interface MenuElement
extends java.io.Serializable

This interface describes common features of portal-site menu elements constructed and returned to decorators.

Version:

$Id: MenuElement.java 919260 2010-03-05 01:25:15Z rwatler $

Author:

Randy Watler

Field Summary

static java.lang.String	MENU_ELEMENT_TYPE MENU_ELEMENT_TYPE - element type of menu elements
static java.lang.String	OPTION_ELEMENT_TYPE OPTION_ELEMENT_TYPE - element type of menu elements
static java.lang.String	SEPARATOR_ELEMENT_TYPE SEPARATOR_ELEMENT_TYPE - element type of separator elements

Method Summary

java.lang.String	getElementType() getElementType - get type of menu element
Node	getManagedNode() getManagedNode - get underlying managed concrete Node associated with menu element; note that the node returned is not necessarily deterministic if the mapping of profiled folders, pages, and links is not mapped 1:1
GenericMetadata	getMetadata() getMetadata - get generic metadata for menu element
Node	getNode() getNode - get Node proxy from site view associated with element
Menu	getParentMenu() getParentMenu - get menu that contains menu element
java.lang.String	getShortTitle() getShortTitle - get default short title for menu element
java.lang.String	getShortTitle(java.util.Locale locale) getShortTitle - get locale specific short title for menu element from metadata
java.lang.String	getSkin() getSkin - get skin name for menu element
java.lang.String	getTitle() getTitle - get default title for menu element
java.lang.String	getTitle(java.util.Locale locale) getTitle - get locale specific title for menu element from metadata
boolean	isEditable() isEditable - get editable access flag for menu option

Field Detail

MENU_ELEMENT_TYPE

static final java.lang.String MENU_ELEMENT_TYPE

MENU_ELEMENT_TYPE - element type of menu elements

See Also:

Constant Field Values

OPTION_ELEMENT_TYPE

static final java.lang.String OPTION_ELEMENT_TYPE

OPTION_ELEMENT_TYPE - element type of menu elements

See Also:

Constant Field Values

SEPARATOR_ELEMENT_TYPE

static final java.lang.String SEPARATOR_ELEMENT_TYPE

SEPARATOR_ELEMENT_TYPE - element type of separator elements

See Also:

Constant Field Values

Method Detail

getElementType

java.lang.String getElementType()

getElementType - get type of menu element

Returns:

MENU_ELEMENT_TYPE, OPTION_ELEMENT_TYPE, or SEPARATOR_ELEMENT_TYPE

getParentMenu

Menu getParentMenu()

getParentMenu - get menu that contains menu element

Returns:

parent menu

getTitle

java.lang.String getTitle()

getTitle - get default title for menu element

Returns:

title text

getShortTitle

java.lang.String getShortTitle()

getShortTitle - get default short title for menu element

Returns:

short title text

getTitle

java.lang.String getTitle(java.util.Locale locale)

getTitle - get locale specific title for menu element from metadata

Parameters:

locale - preferred locale

Returns:

title text

getShortTitle

java.lang.String getShortTitle(java.util.Locale locale)

getShortTitle - get locale specific short title for menu element from metadata

Parameters:

locale - preferred locale

Returns:

short title text

getMetadata

GenericMetadata getMetadata()

getMetadata - get generic metadata for menu element

Returns:

metadata

getSkin

java.lang.String getSkin()

getSkin - get skin name for menu element

Returns:

skin name

isEditable

boolean isEditable()

isEditable - get editable access flag for menu option

Returns:

editable flag

getNode

Node getNode()

getNode - get Node proxy from site view associated with element

Returns:

proxy folder, page, or link node

getManagedNode

Node getManagedNode()

getManagedNode - get underlying managed concrete Node associated with menu element; note that the node returned is not necessarily deterministic if the mapping of profiled folders, pages, and links is not mapped 1:1

Returns:

concrete folder, page, or link node