org.apache.jetspeed.portalsite.menu
Class DefaultMenuOptionsDefinition

java.lang.Object
  extended by org.apache.jetspeed.om.folder.impl.StandardMenuOptionsDefinitionImpl
      extended by org.apache.jetspeed.portalsite.menu.DefaultMenuOptionsDefinition
All Implemented Interfaces:
MenuOptionsDefinition

public class DefaultMenuOptionsDefinition
extends StandardMenuOptionsDefinitionImpl

This class provides a menu options definition for options constructed directly from menu definitions.

Version:
$Id: DefaultMenuOptionsDefinition.java 516448 2007-03-09 16:25:47Z ate $
Author:
Randy Watler

Field Summary
 
Fields inherited from interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
ANY_PROFILE_LOCATOR
 
Constructor Summary
DefaultMenuOptionsDefinition(java.lang.String options, int depth, boolean paths, boolean regexp, java.lang.String locatorName, java.lang.String order)
          DefaultMenuOptionsDefinition - constructor
 
Method Summary
 int getDepth()
          getDepth - get depth of inclusion for folder menu options
 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
 java.lang.String getProfile()
          getProfile - get profile locator used to filter specified options
 boolean isPaths()
          isPaths - get generate ordered path options
 boolean isRegexp()
          isRegexp - get regexp flag for interpreting options
 
Methods inherited from class org.apache.jetspeed.om.folder.impl.StandardMenuOptionsDefinitionImpl
getSkin, setDepth, setOptions, setOrder, setPaths, setProfile, setRegexp, setSkin
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultMenuOptionsDefinition

public DefaultMenuOptionsDefinition(java.lang.String options,
                                    int depth,
                                    boolean paths,
                                    boolean regexp,
                                    java.lang.String locatorName,
                                    java.lang.String order)
DefaultMenuOptionsDefinition - constructor

Method Detail

getOptions

public java.lang.String getOptions()
getOptions - get comma separated menu options if not specified as elements

Specified by:
getOptions in interface MenuOptionsDefinition
Overrides:
getOptions in class StandardMenuOptionsDefinitionImpl
Returns:
option paths specification

getDepth

public int getDepth()
getDepth - get depth of inclusion for folder menu options

Specified by:
getDepth in interface MenuOptionsDefinition
Overrides:
getDepth in class StandardMenuOptionsDefinitionImpl
Returns:
inclusion depth

isPaths

public boolean isPaths()
isPaths - get generate ordered path options

Specified by:
isPaths in interface MenuOptionsDefinition
Overrides:
isPaths in class StandardMenuOptionsDefinitionImpl
Returns:
paths options flag

isRegexp

public boolean isRegexp()
isRegexp - get regexp flag for interpreting options

Specified by:
isRegexp in interface MenuOptionsDefinition
Overrides:
isRegexp in class StandardMenuOptionsDefinitionImpl
Returns:
regexp flag

getProfile

public java.lang.String getProfile()
getProfile - get profile locator used to filter specified options

Specified by:
getProfile in interface MenuOptionsDefinition
Overrides:
getProfile in class StandardMenuOptionsDefinitionImpl
Returns:
profile locator name

getOrder

public java.lang.String getOrder()
getOrder - get comma separated regexp ordering patterns

Specified by:
getOrder in interface MenuOptionsDefinition
Overrides:
getOrder in class StandardMenuOptionsDefinitionImpl
Returns:
ordering patterns list


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