org.apache.jetspeed.portalsite
Interface MenuElement

All Known Subinterfaces:
Menu, MenuOption, MenuSeparator

public interface MenuElement

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

Version:
$Id: MenuElement.java 516448 2007-03-09 16:25:47Z ate $
Author:
Randy Watler

Field Summary
static String MENU_ELEMENT_TYPE
          MENU_ELEMENT_TYPE - element type of menu elements
static String OPTION_ELEMENT_TYPE
          OPTION_ELEMENT_TYPE - element type of menu elements
static String SEPARATOR_ELEMENT_TYPE
          SEPARATOR_ELEMENT_TYPE - element type of separator elements
 
Method Summary
 String getElementType()
          getElementType - get type of menu element
 GenericMetadata getMetadata()
          getMetadata - get generic metadata for menu element
 Menu getParentMenu()
          getParentMenu - get menu that contains menu element
 String getShortTitle()
          getShortTitle - get default short title for menu element
 String getShortTitle(Locale locale)
          getShortTitle - get locale specific short title for menu element from metadata
 String getSkin()
          getSkin - get skin name for menu element
 String getTitle()
          getTitle - get default title for menu element
 String getTitle(Locale locale)
          getTitle - get locale specific title for menu element from metadata
 

Field Detail

MENU_ELEMENT_TYPE

static final String MENU_ELEMENT_TYPE
MENU_ELEMENT_TYPE - element type of menu elements

See Also:
Constant Field Values

OPTION_ELEMENT_TYPE

static final String OPTION_ELEMENT_TYPE
OPTION_ELEMENT_TYPE - element type of menu elements

See Also:
Constant Field Values

SEPARATOR_ELEMENT_TYPE

static final String SEPARATOR_ELEMENT_TYPE
SEPARATOR_ELEMENT_TYPE - element type of separator elements

See Also:
Constant Field Values
Method Detail

getElementType

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

String getTitle()
getTitle - get default title for menu element

Returns:
title text

getShortTitle

String getShortTitle()
getShortTitle - get default short title for menu element

Returns:
short title text

getTitle

String getTitle(Locale locale)
getTitle - get locale specific title for menu element from metadata

Parameters:
locale - preferred locale
Returns:
title text

getShortTitle

String getShortTitle(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

String getSkin()
getSkin - get skin name for menu element

Returns:
skin name


Copyright © 1999-2007 Apache Software Foundation. All Rights Reserved.