org.apache.jetspeed.portalsite.impl
Class MenuElementImpl

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

All Implemented Interfaces:

Cloneable, org.apache.jetspeed.portalsite.MenuElement

Direct Known Subclasses:

MenuImpl, MenuOptionImpl, MenuSeparatorImpl

public abstract class MenuElementImpl

extends Object

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

This abstract class implements common features of portal-site menu elements constructed and returned to decorators.

Version:

$Id: MenuElementImpl.java 216120 2005-07-13 06:40:27Z rwatler $

Author:

Randy Watler

Field Summary

private org.apache.jetspeed.page.document.Node	node node - underlying node proxy associated with this menu element in the site view
private MenuImpl	parent parentMenu - parent menu implementation
private String	skin skin - inherited skin name for menu element
private boolean	skinInherited skinInherited - flag indicating whether skin value has been inherited by propagating from parent menu

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

MENU_ELEMENT_TYPE, OPTION_ELEMENT_TYPE, SEPARATOR_ELEMENT_TYPE

Constructor Summary

protected	MenuElementImpl(MenuImpl parent) MenuElementImpl - constructor
protected	MenuElementImpl(MenuImpl parent, org.apache.jetspeed.page.document.Node node) MenuElementImpl - node proxy constructor

Method Summary

Object	clone() clone - clone this instance
boolean	equals(Object obj) equals - compare menu element implementations
abstract String	getElementType() getElementType - get type of menu element
org.apache.jetspeed.om.common.GenericMetadata	getMetadata() getMetadata - get generic metadata for menu element
String	getName() getName - get name of menu element used for default title
protected org.apache.jetspeed.page.document.Node	getNode() getNode - get menu element node proxy in the site view
org.apache.jetspeed.portalsite.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
String	getUrl() getUrl - get url of menu element used for comparison
protected void	setNode(org.apache.jetspeed.page.document.Node node) setNode - set menu element node proxy in the site view
protected void	setParentMenu(org.apache.jetspeed.portalsite.Menu parentMenu) setParentMenu - set menu that contains menu element

Methods inherited from class java.lang.Object

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

Field Detail

parent

private MenuImpl parent

parentMenu - parent menu implementation

node

private org.apache.jetspeed.page.document.Node node

node - underlying node proxy associated with this menu element in the site view

skin

private String skin

skin - inherited skin name for menu element

skinInherited

private boolean skinInherited

skinInherited - flag indicating whether skin value has been inherited by propagating from parent menu

Constructor Detail

MenuElementImpl

protected MenuElementImpl(MenuImpl parent)

MenuElementImpl - constructor

Parameters:

parent - containing menu implementation

MenuElementImpl

protected MenuElementImpl(MenuImpl parent,
                          org.apache.jetspeed.page.document.Node node)

MenuElementImpl - node proxy constructor

Parameters:

parent - containing menu implementation

node - menu element node proxy

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

clone - clone this instance

Returns:

unparented copy

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

equals - compare menu element implementations

Returns:

equals result

getElementType

public abstract String getElementType()

getElementType - get type of menu element

Specified by:

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

Returns:

MENU_ELEMENT_TYPE, OPTION_ELEMENT_TYPE, or SEPARATOR_ELEMENT_TYPE

getParentMenu

public org.apache.jetspeed.portalsite.Menu getParentMenu()

getParentMenu - get menu that contains menu element

Specified by:

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

Returns:

parent menu

setParentMenu

protected void setParentMenu(org.apache.jetspeed.portalsite.Menu parentMenu)

setParentMenu - set menu that contains menu element

Parameters:

parentMenu - parent menu

getName

public String getName()

getName - get name of menu element used for default title

Returns:

menu element name

getUrl

public String getUrl()

getUrl - get url of menu element used for comparison

Returns:

folder, page, or link url

getTitle

public String getTitle()

getTitle - get default title for menu element

Specified by:

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

Returns:

title text

getShortTitle

public String getShortTitle()

getShortTitle - get default short title for menu element

Specified by:

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

Returns:

short title text

getTitle

public String getTitle(Locale locale)

getTitle - get locale specific title for menu element from metadata

Specified by:

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

Parameters:

locale - preferred locale

Returns:

title text

getShortTitle

public String getShortTitle(Locale locale)

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

Specified by:

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

Parameters:

locale - preferred locale

Returns:

short title text

getMetadata

public org.apache.jetspeed.om.common.GenericMetadata getMetadata()

getMetadata - get generic metadata for menu element

Specified by:

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

Returns:

metadata

getSkin

public String getSkin()

getSkin - get skin name for menu element

Specified by:

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

Returns:

skin name

getNode

protected org.apache.jetspeed.page.document.Node getNode()

getNode - get menu element node proxy in the site view

Returns:

node proxy

setNode

protected void setNode(org.apache.jetspeed.page.document.Node node)

setNode - set menu element node proxy in the site view

Parameters:

node - node proxy