org.apache.jetspeed.portalsite
Interface MenuOption

All Superinterfaces:

MenuElement

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 String	FOLDER_OPTION_TYPE FOLDER_OPTION_TYPE - type of folder menu option
static String	LINK_OPTION_TYPE LINK_OPTION_TYPE - type of link menu option
static 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

String	getDefaultPage() getDefaultPage - get target for url of menu option
String	getTarget() getTarget - get target for url of menu option
String	getType() getType - get type of menu option
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, getMetadata, getParentMenu, getShortTitle, getShortTitle, getSkin, getTitle, getTitle

Field Detail

FOLDER_OPTION_TYPE

static final String FOLDER_OPTION_TYPE

FOLDER_OPTION_TYPE - type of folder menu option

See Also:

Constant Field Values

PAGE_OPTION_TYPE

static final String PAGE_OPTION_TYPE

PAGE_OPTION_TYPE - type of page menu option

See Also:

Constant Field Values

LINK_OPTION_TYPE

static final String LINK_OPTION_TYPE

LINK_OPTION_TYPE - type of link menu option

See Also:

Constant Field Values

Method Detail

getType

String getType()

getType - get type of menu option

Returns:

FOLDER_OPTION_TYPE, PAGE_OPTION_TYPE, or LINK_OPTION_TYPE

getUrl

String getUrl()

getUrl - get url of menu option

Returns:

folder, page, or link url

getTarget

String getTarget()

getTarget - get target for url of menu option

Returns:

url target

getDefaultPage

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