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

java.lang.Object
  extended by org.apache.jetspeed.om.folder.impl.BaseMenuDefinitionElement
      extended by org.apache.jetspeed.om.folder.impl.BaseMenuDefinitionMetadata
          extended by org.apache.jetspeed.om.folder.impl.BaseMenuDefinitionImpl
All Implemented Interfaces:
MenuDefinition
Direct Known Subclasses:
FolderMenuDefinitionImpl, PageMenuDefinitionImpl

public abstract class BaseMenuDefinitionImpl
extends BaseMenuDefinitionMetadata
implements MenuDefinition

BaseMenuDefinitionImpl

Version:
$Id:$
Author:
Randy Watler

Field Summary
 
Fields inherited from interface org.apache.jetspeed.om.folder.MenuDefinition
ANY_PROFILE_LOCATOR
 
Constructor Summary
BaseMenuDefinitionImpl()
           
 
Method Summary
 java.util.List accessElements()
          accessElements Access mutable persistent collection member for List wrappers.
 boolean equals(java.lang.Object o)
           
 int getDepth()
          getDepth - get depth of inclusion for folder menu options
abstract  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
 int hashCode()
           
 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 org.apache.jetspeed.om.folder.impl.BaseMenuDefinitionMetadata
getMetadata, getPageMetadata, getShortTitle, getText, getText, getTitle, newPageMetadata
 
Methods inherited from class org.apache.jetspeed.om.folder.impl.BaseMenuDefinitionElement
getElementOrder, setElementOrder
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.om.folder.MenuDefinition
getMetadata, getShortTitle, getTitle
 

Constructor Detail

BaseMenuDefinitionImpl

public BaseMenuDefinitionImpl()
Method Detail

accessElements

public java.util.List accessElements()
accessElements Access mutable persistent collection member for List wrappers.

Returns:
persistent collection

getName

public java.lang.String getName()
Description copied from interface: MenuDefinition
getName - get menu name

Specified by:
getName in interface MenuDefinition
Returns:
menu name

setName

public void setName(java.lang.String name)
Description copied from interface: MenuDefinition
setName - set menu name

Specified by:
setName in interface MenuDefinition
Parameters:
name - menu name

getOptions

public java.lang.String getOptions()
Description copied from interface: MenuDefinition
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)
Description copied from interface: MenuDefinition
setOptions - set comma separated menu options if not specified as elements

Specified by:
setOptions in interface MenuDefinition

getDepth

public int getDepth()
Description copied from interface: MenuDefinition
getDepth - get depth of inclusion for folder menu options

Specified by:
getDepth in interface MenuDefinition
Returns:
inclusion depth

setDepth

public void setDepth(int depth)
Description copied from interface: MenuDefinition
setDepth - set depth of inclusion for folder menu options

Specified by:
setDepth in interface MenuDefinition
Parameters:
depth - inclusion depth

isPaths

public boolean isPaths()
Description copied from interface: MenuDefinition
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)
Description copied from interface: MenuDefinition
setPaths - set generate ordered path options for specified options

Specified by:
setPaths in interface MenuDefinition
Parameters:
paths - paths options flag

isRegexp

public boolean isRegexp()
Description copied from interface: MenuDefinition
isRegexp - get regexp flag for interpreting specified options

Specified by:
isRegexp in interface MenuDefinition
Returns:
regexp flag

setRegexp

public void setRegexp(boolean regexp)
Description copied from interface: MenuDefinition
setRegexp - set regexp flag for interpreting specified options

Specified by:
setRegexp in interface MenuDefinition
Parameters:
regexp - regexp flag

getProfile

public java.lang.String getProfile()
Description copied from interface: MenuDefinition
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)
Description copied from interface: MenuDefinition
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()
Description copied from interface: MenuDefinition
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)
Description copied from interface: MenuDefinition
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()
Description copied from interface: MenuDefinition
getSkin - get skin name for menu

Specified by:
getSkin in interface MenuDefinition
Returns:
skin name

setSkin

public void setSkin(java.lang.String name)
Description copied from interface: MenuDefinition
setSkin - set skin name for menu

Specified by:
setSkin in interface MenuDefinition
Parameters:
name - skin name

getTitle

public java.lang.String getTitle()
Description copied from interface: MenuDefinition
getTitle - get default title for menu

Specified by:
getTitle in interface MenuDefinition
Overrides:
getTitle in class BaseMenuDefinitionMetadata
Returns:
title text

setTitle

public void setTitle(java.lang.String title)
Description copied from interface: MenuDefinition
setTitle - set default title for menu

Specified by:
setTitle in interface MenuDefinition
Parameters:
title - title text

getShortTitle

public java.lang.String getShortTitle()
Description copied from interface: MenuDefinition
getShortTitle - get default short title for menu

Specified by:
getShortTitle in interface MenuDefinition
Overrides:
getShortTitle in class BaseMenuDefinitionMetadata
Returns:
short title text

setShortTitle

public void setShortTitle(java.lang.String title)
Description copied from interface: MenuDefinition
setShortTitle - set default short title for menu

Specified by:
setShortTitle in interface MenuDefinition
Parameters:
title - short title text

getMenuElements

public abstract java.util.List getMenuElements()
Description copied from interface: MenuDefinition
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)
Description copied from interface: MenuDefinition
setMenuElements - set ordered list of menu options

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

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


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