org.apache.jetspeed.portalsite.menu
Class DefaultMenuOptionsDefinition

java.lang.Object
  org.apache.jetspeed.om.folder.impl.StandardMenuOptionsDefinitionImpl
      org.apache.jetspeed.portalsite.menu.DefaultMenuOptionsDefinition

All Implemented Interfaces:

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

private int	depth depth - inclusion depth for menu options
private String	options options - options path specification for menu
private String	order order - comma separated regexp ordering patterns for menu options
private boolean	paths paths - generate ordered paths flag for menu options
private String	profile profile - profile locator for menu options
private boolean	regexp regexp - regexp flag for menu options

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

ANY_PROFILE_LOCATOR

Constructor Summary

DefaultMenuOptionsDefinition(String options, int depth, boolean paths, boolean regexp, String locatorName, String order)
DefaultMenuOptionsDefinition - 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	getOrder() getOrder - get comma separated regexp ordering patterns
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

Field Detail

options

private String options

options - options path specification for menu

depth

private int depth

depth - inclusion depth for menu options

paths

private boolean paths

paths - generate ordered paths flag for menu options

regexp

private boolean regexp

regexp - regexp flag for menu options

profile

private String profile

profile - profile locator for menu options

order

private String order

order - comma separated regexp ordering patterns for menu options

Constructor Detail

DefaultMenuOptionsDefinition

public DefaultMenuOptionsDefinition(String options,
                                    int depth,
                                    boolean paths,
                                    boolean regexp,
                                    String locatorName,
                                    String order)

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

Overrides:

getDepth in class StandardMenuOptionsDefinitionImpl

Returns:

inclusion depth

isPaths

public boolean isPaths()

isPaths - get generate ordered path options

Specified by:

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

Overrides:

isRegexp in class StandardMenuOptionsDefinitionImpl

Returns:

regexp flag

getProfile

public String getProfile()

getProfile - get profile locator used to filter specified options

Specified by:

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

Overrides:

getProfile in class StandardMenuOptionsDefinitionImpl

Returns:

profile locator name

getOrder

public String getOrder()

getOrder - get comma separated regexp ordering patterns

Specified by:

getOrder in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition

Overrides:

getOrder in class StandardMenuOptionsDefinitionImpl

Returns:

ordering patterns list