org.apache.jetspeed.portalsite.menu
Class DefaultMenuDefinition

java.lang.Object
  org.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl
      org.apache.jetspeed.portalsite.menu.DefaultMenuDefinition

All Implemented Interfaces:

org.apache.jetspeed.om.folder.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

private int	depth depth - inclusion depth for menu
private String	options options - options path specification for menu
private String	profile profile - profile locator for menu and its elements

Fields inherited from interface org.apache.jetspeed.om.folder.MenuDefinition

ANY_PROFILE_LOCATOR

Constructor Summary

DefaultMenuDefinition(String options, int depth, String locatorName)
DefaultMenuDefinition - constructor

Method Summary

int	getDepth() getDepth - get depth of inclusion for folder menu options
String	getOptions() getOptions - get comma separated menu options if not specified as elements
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

Field Detail

options

private String options

options - options path specification for menu

depth

private int depth

depth - inclusion depth for menu

profile

private String profile

profile - profile locator for menu and its elements

Constructor Detail

DefaultMenuDefinition

public DefaultMenuDefinition(String options,
                             int depth,
                             String locatorName)

DefaultMenuDefinition - constructor

Method Detail

getOptions

public String getOptions()

getOptions - get comma separated menu options if not specified as elements

Specified by:

getOptions in interface org.apache.jetspeed.om.folder.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 org.apache.jetspeed.om.folder.MenuDefinition

Overrides:

getDepth in class StandardMenuDefinitionImpl

Returns:

inclusion depth

getProfile

public String getProfile()

getProfile - get profile locator used to filter specified options

Specified by:

getProfile in interface org.apache.jetspeed.om.folder.MenuDefinition

Overrides:

getProfile in class StandardMenuDefinitionImpl

Returns:

profile locator name