org.apache.jetspeed.portalsite.impl
Class MenuOptionImpl

java.lang.Object
  org.apache.jetspeed.portalsite.impl.MenuElementImpl
      org.apache.jetspeed.portalsite.impl.MenuOptionImpl

All Implemented Interfaces:

Cloneable, org.apache.jetspeed.portalsite.MenuElement, org.apache.jetspeed.portalsite.MenuOption

public class MenuOptionImpl
extends MenuElementImpl
implements org.apache.jetspeed.portalsite.MenuOption, Cloneable

This class implements the portal-site menu option elements constructed and returned to decorators.

Version:

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

Author:

Randy Watler

Field Summary

private org.apache.jetspeed.om.folder.MenuOptionsDefinition

definition definition - menu option definition

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

FOLDER_OPTION_TYPE, LINK_OPTION_TYPE, PAGE_OPTION_TYPE

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

MENU_ELEMENT_TYPE, OPTION_ELEMENT_TYPE, SEPARATOR_ELEMENT_TYPE

Constructor Summary

MenuOptionImpl(MenuImpl parent, org.apache.jetspeed.page.document.Node node, org.apache.jetspeed.om.folder.MenuOptionsDefinition definition)
MenuOptionImpl - constructor

Method Summary

String	getDefaultPage() getDefaultPage - get default page for a folder (if folder) of menu option
String	getElementType() getElementType - get type of menu element
String	getSkin() getSkin - get skin name for menu element
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(org.apache.jetspeed.portalsite.PortalSiteRequestContext context) isSelected - return true if menu option is selected by the specified request context

Methods inherited from class org.apache.jetspeed.portalsite.impl.MenuElementImpl

clone, equals, getMetadata, getName, getNode, getParentMenu, getShortTitle, getShortTitle, getTitle, getTitle, setNode, setParentMenu

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMetadata, getParentMenu, getShortTitle, getShortTitle, getTitle, getTitle

Field Detail

definition

private org.apache.jetspeed.om.folder.MenuOptionsDefinition definition

definition - menu option definition

Constructor Detail

MenuOptionImpl

public MenuOptionImpl(MenuImpl parent,
                      org.apache.jetspeed.page.document.Node node,
                      org.apache.jetspeed.om.folder.MenuOptionsDefinition definition)

MenuOptionImpl - constructor

Parameters:

parent - containing menu implementation

node - menu option node proxy

definition - menu option definition

Method Detail

getElementType

public String getElementType()

getElementType - get type of menu element

Specified by:

getElementType in interface org.apache.jetspeed.portalsite.MenuElement

Specified by:

getElementType in class MenuElementImpl

Returns:

OPTION_ELEMENT_TYPE

getType

public String getType()

getType - get type of menu option

Specified by:

getType in interface org.apache.jetspeed.portalsite.MenuOption

Returns:

FOLDER_OPTION_TYPE, PAGE_OPTION_TYPE, or LINK_OPTION_TYPE

getSkin

public String getSkin()

getSkin - get skin name for menu element

Specified by:

getSkin in interface org.apache.jetspeed.portalsite.MenuElement

Overrides:

getSkin in class MenuElementImpl

Returns:

skin name

getUrl

public String getUrl()

getUrl - get url of menu option

Specified by:

getUrl in interface org.apache.jetspeed.portalsite.MenuOption

Overrides:

getUrl in class MenuElementImpl

Returns:

folder, page, or link url

getTarget

public String getTarget()

getTarget - get target for url of menu option

Specified by:

getTarget in interface org.apache.jetspeed.portalsite.MenuOption

Returns:

url target

getDefaultPage

public String getDefaultPage()

getDefaultPage - get default page for a folder (if folder) of menu option

Specified by:

getDefaultPage in interface org.apache.jetspeed.portalsite.MenuOption

Returns:

url target

isHidden

public boolean isHidden()

isHidden - get hidden state of menu option

Specified by:

isHidden in interface org.apache.jetspeed.portalsite.MenuOption

Returns:

hidden state

isSelected

public boolean isSelected(org.apache.jetspeed.portalsite.PortalSiteRequestContext context)

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

Specified by:

isSelected in interface org.apache.jetspeed.portalsite.MenuOption

Parameters:

context - request context

Returns:

selected state