| org.apache.jetspeed.om.folder.MenuDefinition
All known Subclasses: org.apache.jetspeed.om.folder.impl.BaseMenuDefinitionImpl, org.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl, org.apache.jetspeed.om.folder.impl.FolderMenuDefinitionImpl, org.apache.jetspeed.om.page.impl.PageMenuDefinitionImpl, org.apache.jetspeed.om.folder.psml.MenuDefinitionImpl,
| MenuDefinition | | public interface MenuDefinition (Code) | | This interface describes the object used to define
portal site menus comprised of nested menus, options,
and separators.
author:
Randy Watler
version:
$Id: MenuDefinition.java 516448 2007-03-09 16:25:47Z ate $ |
| ANY_PROFILE_LOCATOR | | String ANY_PROFILE_LOCATOR(Code) | | ANY_PROFILE_LOCATOR - wildcard value for profile locator names
|
| getDepth | | int getDepth()(Code) | | getDepth - get depth of inclusion for folder menu options
inclusion depth |
| getMenuElements | | List getMenuElements()(Code) | | getMenuElements - get ordered list of menu options,
nested menus, separators, included
menu, and excluded menu elements
element list |
| getMetadata | | GenericMetadata getMetadata()(Code) | | getMetadata - get generic metadata instance for menu
metadata instance |
| getName | | String getName()(Code) | | getName - get menu name
menu name |
| getOptions | | String getOptions()(Code) | | getOptions - get comma separated menu options if not specified as elements
option paths specification |
| getOrder | | String getOrder()(Code) | | getOrder - get comma separated regexp ordering patterns for options
ordering patterns list |
| getProfile | | String getProfile()(Code) | | getProfile - get profile locator used to filter specified options
profile locator name |
| getShortTitle | | String getShortTitle()(Code) | | getShortTitle - get default short title for menu
short title text |
| getShortTitle | | String getShortTitle(Locale locale)(Code) | | getShortTitle - get locale specific short title for menu from metadata
Parameters:
locale - preferred locale short title text |
| getSkin | | String getSkin()(Code) | | getSkin - get skin name for menu
skin name |
| getTitle | | String getTitle()(Code) | | getTitle - get default title for menu
title text |
| getTitle | | String getTitle(Locale locale)(Code) | | getTitle - get locale specific title for menu from metadata
Parameters:
locale - preferred locale title text |
| isPaths | | boolean isPaths()(Code) | | isPaths - get generate ordered path options for specified options
paths options flag |
| isRegexp | | boolean isRegexp()(Code) | | isRegexp - get regexp flag for interpreting specified options
regexp flag |
| setDepth | | void setDepth(int depth)(Code) | | setDepth - set depth of inclusion for folder menu options
Parameters:
depth - inclusion depth |
| setMenuElements | | void setMenuElements(List elements)(Code) | | setMenuElements - set ordered list of menu options
Parameters:
elements - element list |
| setName | | void setName(String name)(Code) | | setName - set menu name
Parameters:
name - menu name |
| setOptions | | void setOptions(String options)(Code) | | setOptions - set comma separated menu options if not specified as elements
Parameters:
option - option paths specification |
| setOrder | | void setOrder(String order)(Code) | | setOrder - set comma separated regexp ordering patterns for options
Parameters:
order - ordering patterns list |
| setPaths | | void setPaths(boolean paths)(Code) | | setPaths - set generate ordered path options for specified options
Parameters:
paths - paths options flag |
| setProfile | | void setProfile(String locatorName)(Code) | | setProfile - set profile locator used to filter specified options
Parameters:
locatorName - profile locator name |
| setRegexp | | void setRegexp(boolean regexp)(Code) | | setRegexp - set regexp flag for interpreting specified options
Parameters:
regexp - regexp flag |
| setShortTitle | | void setShortTitle(String title)(Code) | | setShortTitle - set default short title for menu
Parameters:
title - short title text |
| setSkin | | void setSkin(String name)(Code) | | setSkin - set skin name for menu
Parameters:
name - skin name |
| setTitle | | void setTitle(String title)(Code) | | setTitle - set default title for menu
Parameters:
title - title text |
|
|