org.apache.jetspeed.om.folder
Interface MenuDefinition

public interface MenuDefinition

This interface describes the object used to define portal site menus comprised of nested menus, options, and separators.

Version:

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

Author:

Randy Watler

Field Summary

static String

ANY_PROFILE_LOCATOR ANY_PROFILE_LOCATOR - wildcard value for profile locator names

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
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
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

Field Detail

ANY_PROFILE_LOCATOR

static final String ANY_PROFILE_LOCATOR

ANY_PROFILE_LOCATOR - wildcard value for profile locator names

See Also:

Constant Field Values

Method Detail

getName

String getName()

getName - get menu name

Returns:

menu name

setName

void setName(String name)

setName - set menu name

Parameters:

name - menu name

getOptions

String getOptions()

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

Returns:

option paths specification

setOptions

void setOptions(String options)

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

Parameters:

option - option paths specification

getDepth

int getDepth()

getDepth - get depth of inclusion for folder menu options

Returns:

inclusion depth

setDepth

void setDepth(int depth)

setDepth - set depth of inclusion for folder menu options

Parameters:

depth - inclusion depth

isPaths

boolean isPaths()

isPaths - get generate ordered path options for specified options

Returns:

paths options flag

setPaths

void setPaths(boolean paths)

setPaths - set generate ordered path options for specified options

Parameters:

paths - paths options flag

isRegexp

boolean isRegexp()

isRegexp - get regexp flag for interpreting specified options

Returns:

regexp flag

setRegexp

void setRegexp(boolean regexp)

setRegexp - set regexp flag for interpreting specified options

Parameters:

regexp - regexp flag

getProfile

String getProfile()

getProfile - get profile locator used to filter specified options

Returns:

profile locator name

setProfile

void setProfile(String locatorName)

setProfile - set profile locator used to filter specified options

Parameters:

locatorName - profile locator name

getOrder

String getOrder()

getOrder - get comma separated regexp ordering patterns for options

Returns:

ordering patterns list

setOrder

void setOrder(String order)

setOrder - set comma separated regexp ordering patterns for options

Parameters:

order - ordering patterns list

getSkin

String getSkin()

getSkin - get skin name for menu

Returns:

skin name

setSkin

void setSkin(String name)

setSkin - set skin name for menu

Parameters:

name - skin name

getTitle

String getTitle()

getTitle - get default title for menu

Returns:

title text

setTitle

void setTitle(String title)

setTitle - set default title for menu

Parameters:

title - title text

getShortTitle

String getShortTitle()

getShortTitle - get default short title for menu

Returns:

short title text

setShortTitle

void setShortTitle(String title)

setShortTitle - set default short title for menu

Parameters:

title - short title text

getTitle

String getTitle(Locale locale)

getTitle - get locale specific title for menu from metadata

Parameters:

locale - preferred locale

Returns:

title text

getShortTitle

String getShortTitle(Locale locale)

getShortTitle - get locale specific short title for menu from metadata

Parameters:

locale - preferred locale

Returns:

short title text

getMetadata

GenericMetadata getMetadata()

getMetadata - get generic metadata instance for menu

Returns:

metadata instance

getMenuElements

List getMenuElements()

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

Returns:

element list

setMenuElements

void setMenuElements(List elements)

setMenuElements - set ordered list of menu options

Parameters:

elements - element list