org.apache.jetspeed.om.folder.psml
Class MenuDefinitionImpl

java.lang.Object
  extended by org.apache.jetspeed.om.folder.psml.MenuMetadataImpl
      extended by org.apache.jetspeed.om.folder.psml.MenuDefinitionImpl
All Implemented Interfaces:
MenuDefinition

public class MenuDefinitionImpl
extends MenuMetadataImpl
implements MenuDefinition

This class implements the MenuDefinition interface in a persistent object form for use by the page manager component.

Version:
$Id: MenuDefinitionImpl.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
MenuDefinitionImpl()
          MenuDefinitionImpl - constructor
 
Method Summary
 int getDepth()
          getDepth - get depth of inclusion for folder menu options
 java.util.List getMenuElementImpls()
          getMenuElementImpls - get ordered list of wrapped menu elements
 java.util.List getMenuElements()
          getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements
 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 getSkin()
          getSkin - get skin name for menu
 java.lang.String getTitle()
          getTitle - get default title for menu
 boolean isPaths()
          isPaths - get generate ordered path options for specified options
 boolean isRegexp()
          isRegexp - get regexp flag for interpreting specified options
 void marshalling()
          marshalling - notification that this instance is to be saved to the persistent store
 void setDepth(int depth)
          setDepth - set depth of inclusion for folder menu options
 void setMenuElementImpls(java.util.List elements)
          setMenuElementImpls - set ordered list of menu elements using a list of wrapped menu elements
 void setMenuElements(java.util.List elements)
          setMenuElements - set ordered list of menu elements
 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
 void unmarshalled()
          unmarshalled - notification that this instance has been loaded from the persistent store
 
Methods inherited from class org.apache.jetspeed.om.folder.psml.MenuMetadataImpl
getMetadata, getMetadataFields, getShortTitle, getText, getText, getTitle, setMetadataFields
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.om.folder.MenuDefinition
getMetadata, getShortTitle, getTitle
 

Constructor Detail

MenuDefinitionImpl

public MenuDefinitionImpl()
MenuDefinitionImpl - 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:
options - 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
Overrides:
getTitle in class MenuMetadataImpl
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
Overrides:
getShortTitle in class MenuMetadataImpl
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

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 elements

Specified by:
setMenuElements in interface MenuDefinition
Parameters:
elements - element list

getMenuElementImpls

public java.util.List getMenuElementImpls()
getMenuElementImpls - get ordered list of wrapped menu elements

Returns:
element list

setMenuElementImpls

public void setMenuElementImpls(java.util.List elements)
setMenuElementImpls - set ordered list of menu elements using a list of wrapped menu elements

Parameters:
elements - element list

unmarshalled

public void unmarshalled()
unmarshalled - notification that this instance has been loaded from the persistent store

Overrides:
unmarshalled in class MenuMetadataImpl

marshalling

public void marshalling()
marshalling - notification that this instance is to be saved to the persistent store



Copyright © 1999-2010 Apache Software Foundation. All Rights Reserved.