org.apache.jetspeed.portalsite
Interface MenuOption

All Superinterfaces:

MenuElement, java.io.Serializable

public interface MenuOption
extends MenuElement

This interface describes the portal-site menu option elements constructed and returned to decorators.

Version:

$Id: MenuOption.java 537314 2007-05-11 23:08:36Z taylor $

Author:

Randy Watler

Field Summary

static java.lang.String	FOLDER_OPTION_TYPE FOLDER_OPTION_TYPE - type of folder menu option
static java.lang.String	LINK_OPTION_TYPE LINK_OPTION_TYPE - type of link menu option
static java.lang.String	PAGE_OPTION_TYPE PAGE_OPTION_TYPE - type of page menu option

Fields inherited from interface org.apache.jetspeed.portalsite.MenuElement

MENU_ELEMENT_TYPE, OPTION_ELEMENT_TYPE, SEPARATOR_ELEMENT_TYPE

Method Summary

java.lang.String	getDefaultPage() getDefaultPage - get target for url of menu option
java.lang.String	getTarget() getTarget - get target for url of menu option
java.lang.String	getType() getType - get type of menu option
java.lang.String	getUrl() getUrl - get url of menu option
boolean	isHidden() isHidden - get hidden state of menu option
boolean	isSelected(PortalSiteRequestContext context) isSelected - return true if menu option is selected in the specified request context

Methods inherited from interface org.apache.jetspeed.portalsite.MenuElement

getElementType, getManagedNode, getMetadata, getNode, getParentMenu, getShortTitle, getShortTitle, getSkin, getTitle, getTitle, isEditable

Field Detail

FOLDER_OPTION_TYPE

static final java.lang.String FOLDER_OPTION_TYPE

FOLDER_OPTION_TYPE - type of folder menu option

See Also:

Constant Field Values

PAGE_OPTION_TYPE

static final java.lang.String PAGE_OPTION_TYPE

PAGE_OPTION_TYPE - type of page menu option

See Also:

Constant Field Values

LINK_OPTION_TYPE

static final java.lang.String LINK_OPTION_TYPE

LINK_OPTION_TYPE - type of link menu option

See Also:

Constant Field Values

Method Detail

getType

java.lang.String getType()

getType - get type of menu option

Returns:

FOLDER_OPTION_TYPE, PAGE_OPTION_TYPE, or LINK_OPTION_TYPE

getUrl

java.lang.String getUrl()

getUrl - get url of menu option

Returns:

folder, page, or link url

getTarget

java.lang.String getTarget()

getTarget - get target for url of menu option

Returns:

url target

getDefaultPage

java.lang.String getDefaultPage()

getDefaultPage - get target for url of menu option

Returns:

url target

isHidden

boolean isHidden()

isHidden - get hidden state of menu option

Returns:

hidden state

isSelected

boolean isSelected(PortalSiteRequestContext context)

isSelected - return true if menu option is selected in the specified request context

Parameters:

context - request context

Returns:

selected state