org.apache.jetspeed.om.folder.impl
Class StandardMenuDefinitionImpl

java.lang.Object
  org.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl

All Implemented Interfaces:

MenuDefinition

Direct Known Subclasses:

DefaultMenuDefinition, StandardBackMenuDefinition, StandardNavigationsMenuDefinition, StandardPagesMenuDefinition

public abstract class StandardMenuDefinitionImpl
extends java.lang.Object
implements MenuDefinition

This abstract class implements the menu definition interface in a default manner to allow derived classes to easily describe standard menu definitions supported natively by the portal site component.

Version:

$Id: StandardMenuDefinitionImpl.java 516448 2007-03-09 16:25:47Z ate $

Author:

Randy Watler

Field Summary

Fields inherited from interface org.apache.jetspeed.om.folder.MenuDefinition

ANY_PROFILE_LOCATOR

Constructor Summary

StandardMenuDefinitionImpl()
StandardMenuDefinitionImpl - constructor

Method Summary

int	getDepth() getDepth - get depth of inclusion for folder menu options
java.util.List	getMenuElements() getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements
GenericMetadata	getMetadata() getMetadata - get generic metadata instance for menu
java.lang.String	getName() getName - get menu name
java.lang.String	getOptions() getOptions - get comma separated menu options if not specified as elements
java.lang.String	getOrder() getOrder - get comma separated regexp ordering patterns for options
java.lang.String	getProfile() getProfile - get profile locator used to filter specified options
java.lang.String	getShortTitle() getShortTitle - get default short title for menu
java.lang.String	getShortTitle(java.util.Locale locale) getShortTitle - get locale specific short title for menu from metadata
java.lang.String	getSkin() getSkin - get skin name for menu
java.lang.String	getTitle() getTitle - get default title for menu
java.lang.String	getTitle(java.util.Locale locale) getTitle - get locale specific title for menu from metadata
protected java.lang.String	getTitle(java.util.Locale locale, boolean fallback) getTitle - get locale specific title for menu from metadata protocol, with or without falback enabled
boolean	isPaths() isPaths - get generate ordered path options for specified options
boolean	isRegexp() isRegexp - get regexp flag for interpreting specified options
void	setDepth(int depth) setDepth - set depth of inclusion for folder menu options
void	setMenuElements(java.util.List elements) setMenuElements - set ordered list of menu options
void	setName(java.lang.String name) setName - set menu name
void	setOptions(java.lang.String options) setOptions - set comma separated menu options if not specified as elements
void	setOrder(java.lang.String order) setOrder - set comma separated regexp ordering patterns for options
void	setPaths(boolean paths) setPaths - set generate ordered path options for specified options
void	setProfile(java.lang.String locatorName) setProfile - set profile locator used to filter specified options
void	setRegexp(boolean regexp) setRegexp - set regexp flag for interpreting specified options
void	setShortTitle(java.lang.String title) setShortTitle - set default short title for menu
void	setSkin(java.lang.String name) setSkin - set skin name for menu
void	setTitle(java.lang.String title) setTitle - set default title for menu

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardMenuDefinitionImpl

public StandardMenuDefinitionImpl()

StandardMenuDefinitionImpl - constructor

Method Detail

getName

public java.lang.String getName()

getName - get menu name

Specified by:

getName in interface MenuDefinition

Returns:

menu name

setName

public void setName(java.lang.String name)

setName - set menu name

Specified by:

setName in interface MenuDefinition

Parameters:

name - menu name

getOptions

public java.lang.String getOptions()

getOptions - get comma separated menu options if not specified as elements

Specified by:

getOptions in interface MenuDefinition

Returns:

option paths specification

setOptions

public void setOptions(java.lang.String options)

setOptions - set comma separated menu options if not specified as elements

Specified by:

setOptions in interface MenuDefinition

Parameters:

option - option paths specification

getDepth

public int getDepth()

getDepth - get depth of inclusion for folder menu options

Specified by:

getDepth in interface MenuDefinition

Returns:

inclusion depth

setDepth

public void setDepth(int depth)

setDepth - set depth of inclusion for folder menu options

Specified by:

setDepth in interface MenuDefinition

Parameters:

depth - inclusion depth

isPaths

public boolean isPaths()

isPaths - get generate ordered path options for specified options

Specified by:

isPaths in interface MenuDefinition

Returns:

paths options flag

setPaths

public void setPaths(boolean paths)

setPaths - set generate ordered path options for specified options

Specified by:

setPaths in interface MenuDefinition

Parameters:

paths - paths options flag

isRegexp

public boolean isRegexp()

isRegexp - get regexp flag for interpreting specified options

Specified by:

isRegexp in interface MenuDefinition

Returns:

regexp flag

setRegexp

public void setRegexp(boolean regexp)

setRegexp - set regexp flag for interpreting specified options

Specified by:

setRegexp in interface MenuDefinition

Parameters:

regexp - regexp flag

getProfile

public java.lang.String getProfile()

getProfile - get profile locator used to filter specified options

Specified by:

getProfile in interface MenuDefinition

Returns:

profile locator name

setProfile

public void setProfile(java.lang.String locatorName)

setProfile - set profile locator used to filter specified options

Specified by:

setProfile in interface MenuDefinition

Parameters:

locatorName - profile locator name

getOrder

public java.lang.String getOrder()

getOrder - get comma separated regexp ordering patterns for options

Specified by:

getOrder in interface MenuDefinition

Returns:

ordering patterns list

setOrder

public void setOrder(java.lang.String order)

setOrder - set comma separated regexp ordering patterns for options

Specified by:

setOrder in interface MenuDefinition

Parameters:

order - ordering patterns list

getSkin

public java.lang.String getSkin()

getSkin - get skin name for menu

Specified by:

getSkin in interface MenuDefinition

Returns:

skin name

setSkin

public void setSkin(java.lang.String name)

setSkin - set skin name for menu

Specified by:

setSkin in interface MenuDefinition

Parameters:

name - skin name

getTitle

public java.lang.String getTitle()

getTitle - get default title for menu

Specified by:

getTitle in interface MenuDefinition

Returns:

title text

setTitle

public void setTitle(java.lang.String title)

setTitle - set default title for menu

Specified by:

setTitle in interface MenuDefinition

Parameters:

title - title text

getShortTitle

public java.lang.String getShortTitle()

getShortTitle - get default short title for menu

Specified by:

getShortTitle in interface MenuDefinition

Returns:

short title text

setShortTitle

public void setShortTitle(java.lang.String title)

setShortTitle - set default short title for menu

Specified by:

setShortTitle in interface MenuDefinition

Parameters:

title - short title text

getTitle

public java.lang.String getTitle(java.util.Locale locale)

getTitle - get locale specific title for menu from metadata

Specified by:

getTitle in interface MenuDefinition

Parameters:

locale - preferred locale

Returns:

title text

getTitle

protected java.lang.String getTitle(java.util.Locale locale,
                                    boolean fallback)

getTitle - get locale specific title for menu from metadata protocol, with or without falback enabled

Parameters:

locale - preferred locale

fallback - whether to return default title

Returns:

title text

getShortTitle

public java.lang.String getShortTitle(java.util.Locale locale)

getShortTitle - get locale specific short title for menu from metadata

Specified by:

getShortTitle in interface MenuDefinition

Parameters:

locale - preferred locale

Returns:

short title text

getMetadata

public GenericMetadata getMetadata()

getMetadata - get generic metadata instance for menu

Specified by:

getMetadata in interface MenuDefinition

Returns:

metadata instance

getMenuElements

public java.util.List getMenuElements()

getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements

Specified by:

getMenuElements in interface MenuDefinition

Returns:

element list

setMenuElements

public void setMenuElements(java.util.List elements)

setMenuElements - set ordered list of menu options

Specified by:

setMenuElements in interface MenuDefinition

Parameters:

elements - element list