org.apache.jetspeed.portalsite.menu
Class DefaultMenuDefinition

java.lang.Object
  extended by org.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl
      extended by org.apache.jetspeed.portalsite.menu.DefaultMenuDefinition
All Implemented Interfaces:
MenuDefinition

public class DefaultMenuDefinition
extends StandardMenuDefinitionImpl

This class provides a menu definition for default menus constructed from folders within menus with depth expansion specified.

Version:
$Id: DefaultMenuDefinition.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
DefaultMenuDefinition(java.lang.String options, int depth, java.lang.String locatorName)
          DefaultMenuDefinition - 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 getProfile()
          getProfile - get profile locator used to filter specified options
 
Methods inherited from class org.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl
getMenuElements, getMetadata, getName, getOrder, getShortTitle, getShortTitle, getSkin, getTitle, getTitle, getTitle, isPaths, isRegexp, setDepth, setMenuElements, setName, setOptions, setOrder, setPaths, setProfile, setRegexp, setShortTitle, setSkin, setTitle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultMenuDefinition

public DefaultMenuDefinition(java.lang.String options,
                             int depth,
                             java.lang.String locatorName)
DefaultMenuDefinition - 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 MenuDefinition
Overrides:
getOptions in class StandardMenuDefinitionImpl
Returns:
option paths specification

getDepth

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

Specified by:
getDepth in interface MenuDefinition
Overrides:
getDepth in class StandardMenuDefinitionImpl
Returns:
inclusion depth

getProfile

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

Specified by:
getProfile in interface MenuDefinition
Overrides:
getProfile in class StandardMenuDefinitionImpl
Returns:
profile locator name


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