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

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

All Implemented Interfaces:

org.apache.jetspeed.om.folder.MenuDefinition

Direct Known Subclasses:

DefaultMenuDefinition, StandardBackMenuDefinition, StandardNavigationsMenuDefinition, StandardPagesMenuDefinition

public abstract class StandardMenuDefinitionImpl
extends Object
implements org.apache.jetspeed.om.folder.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
List	getMenuElements() getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements
org.apache.jetspeed.om.common.GenericMetadata	getMetadata() getMetadata - get generic metadata instance for menu
String	getName() getName - get menu name
String	getOptions() getOptions - get comma separated menu options if not specified as elements
String	getOrder() getOrder - get comma separated regexp ordering patterns for options
String	getProfile() getProfile - get profile locator used to filter specified options
String	getShortTitle() getShortTitle - get default short title for menu
String	getShortTitle(Locale locale) getShortTitle - get locale specific short title for menu from metadata
String	getSkin() getSkin - get skin name for menu
String	getTitle() getTitle - get default title for menu
String	getTitle(Locale locale) getTitle - get locale specific title for menu from metadata
protected String	getTitle(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(List elements) setMenuElements - set ordered list of menu options
void	setName(String name) setName - set menu name
void	setOptions(String options) setOptions - set comma separated menu options if not specified as elements
void	setOrder(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(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(String title) setShortTitle - set default short title for menu
void	setSkin(String name) setSkin - set skin name for menu
void	setTitle(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 String getName()

getName - get menu name

Specified by:

getName in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

menu name

setName

public void setName(String name)

setName - set menu name

Specified by:

setName in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

name - menu name

getOptions

public String getOptions()

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

Specified by:

getOptions in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

option paths specification

setOptions

public void setOptions(String options)

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

Specified by:

setOptions in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

option - option paths specification

getDepth

public int getDepth()

getDepth - get depth of inclusion for folder menu options

Specified by:

getDepth in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

inclusion depth

setDepth

public void setDepth(int depth)

setDepth - set depth of inclusion for folder menu options

Specified by:

setDepth in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

depth - inclusion depth

isPaths

public boolean isPaths()

isPaths - get generate ordered path options for specified options

Specified by:

isPaths in interface org.apache.jetspeed.om.folder.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 org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

paths - paths options flag

isRegexp

public boolean isRegexp()

isRegexp - get regexp flag for interpreting specified options

Specified by:

isRegexp in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

regexp flag

setRegexp

public void setRegexp(boolean regexp)

setRegexp - set regexp flag for interpreting specified options

Specified by:

setRegexp in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

regexp - regexp flag

getProfile

public String getProfile()

getProfile - get profile locator used to filter specified options

Specified by:

getProfile in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

profile locator name

setProfile

public void setProfile(String locatorName)

setProfile - set profile locator used to filter specified options

Specified by:

setProfile in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

locatorName - profile locator name

getOrder

public String getOrder()

getOrder - get comma separated regexp ordering patterns for options

Specified by:

getOrder in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

ordering patterns list

setOrder

public void setOrder(String order)

setOrder - set comma separated regexp ordering patterns for options

Specified by:

setOrder in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

order - ordering patterns list

getSkin

public String getSkin()

getSkin - get skin name for menu

Specified by:

getSkin in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

skin name

setSkin

public void setSkin(String name)

setSkin - set skin name for menu

Specified by:

setSkin in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

name - skin name

getTitle

public String getTitle()

getTitle - get default title for menu

Specified by:

getTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

title text

setTitle

public void setTitle(String title)

setTitle - set default title for menu

Specified by:

setTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

title - title text

getShortTitle

public String getShortTitle()

getShortTitle - get default short title for menu

Specified by:

getShortTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

short title text

setShortTitle

public void setShortTitle(String title)

setShortTitle - set default short title for menu

Specified by:

setShortTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

title - short title text

getTitle

public String getTitle(Locale locale)

getTitle - get locale specific title for menu from metadata

Specified by:

getTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

locale - preferred locale

Returns:

title text

getTitle

protected String getTitle(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 String getShortTitle(Locale locale)

getShortTitle - get locale specific short title for menu from metadata

Specified by:

getShortTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

locale - preferred locale

Returns:

short title text

getMetadata

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

getMetadata - get generic metadata instance for menu

Specified by:

getMetadata in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

metadata instance

getMenuElements

public List getMenuElements()

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

Specified by:

getMenuElements in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

element list

setMenuElements

public void setMenuElements(List elements)

setMenuElements - set ordered list of menu options

Specified by:

setMenuElements in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

elements - element list