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

java.lang.Object
  org.apache.jetspeed.om.folder.impl.BaseMenuDefinitionElement
      org.apache.jetspeed.om.folder.impl.BaseMenuOptionsDefinitionImpl

All Implemented Interfaces:

MenuOptionsDefinition

Direct Known Subclasses:

FolderMenuOptionsDefinitionImpl, PageMenuOptionsDefinitionImpl

public abstract class BaseMenuOptionsDefinitionImpl
extends BaseMenuDefinitionElement
implements MenuOptionsDefinition

BaseMenuOptionsDefinitionImpl

Version:

$Id:$

Author:

Randy Watler

Field Summary

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

ANY_PROFILE_LOCATOR

Constructor Summary

BaseMenuOptionsDefinitionImpl()

Method Summary

int	getDepth() getDepth - get depth of inclusion for folder options
java.lang.String	getOptions() getOptions - get comma separated menu options
java.lang.String	getOrder() getOrder - get comma separated regexp ordering patterns
java.lang.String	getProfile() getProfile - get profile locator used to filter options
java.lang.String	getSkin() getSkin - get skin name for options
boolean	isPaths() isPaths - get generate ordered path options
boolean	isRegexp() isRegexp - get regexp flag for interpreting options
void	setDepth(int depth) setDepth - set depth of inclusion for folder options
void	setOptions(java.lang.String options) setOptions - set comma separated menu options
void	setOrder(java.lang.String order) setOrder - set comma separated regexp ordering patterns
void	setPaths(boolean paths) setPaths - set generate ordered path options
void	setProfile(java.lang.String locatorName) setProfile - set profile locator used to filter options
void	setRegexp(boolean regexp) setRegexp - set regexp flag for interpreting options
void	setSkin(java.lang.String name) setSkin - set skin name for options

Methods inherited from class org.apache.jetspeed.om.folder.impl.BaseMenuDefinitionElement

getElementOrder, setElementOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseMenuOptionsDefinitionImpl

public BaseMenuOptionsDefinitionImpl()

Method Detail

getOptions

public java.lang.String getOptions()

Description copied from interface: MenuOptionsDefinition

getOptions - get comma separated menu options

Specified by:

getOptions in interface MenuOptionsDefinition

Returns:

option paths specification

setOptions

public void setOptions(java.lang.String options)

Description copied from interface: MenuOptionsDefinition

setOptions - set comma separated menu options

Specified by:

setOptions in interface MenuOptionsDefinition

Parameters:

options - option paths specification

getDepth

public int getDepth()

Description copied from interface: MenuOptionsDefinition

getDepth - get depth of inclusion for folder options

Specified by:

getDepth in interface MenuOptionsDefinition

Returns:

inclusion depth

setDepth

public void setDepth(int depth)

Description copied from interface: MenuOptionsDefinition

setDepth - set depth of inclusion for folder options

Specified by:

setDepth in interface MenuOptionsDefinition

Parameters:

depth - inclusion depth

isPaths

public boolean isPaths()

Description copied from interface: MenuOptionsDefinition

isPaths - get generate ordered path options

Specified by:

isPaths in interface MenuOptionsDefinition

Returns:

paths options flag

setPaths

public void setPaths(boolean paths)

Description copied from interface: MenuOptionsDefinition

setPaths - set generate ordered path options

Specified by:

setPaths in interface MenuOptionsDefinition

Parameters:

paths - paths options flag

isRegexp

public boolean isRegexp()

Description copied from interface: MenuOptionsDefinition

isRegexp - get regexp flag for interpreting options

Specified by:

isRegexp in interface MenuOptionsDefinition

Returns:

regexp flag

setRegexp

public void setRegexp(boolean regexp)

Description copied from interface: MenuOptionsDefinition

setRegexp - set regexp flag for interpreting options

Specified by:

setRegexp in interface MenuOptionsDefinition

Parameters:

regexp - regexp flag

getProfile

public java.lang.String getProfile()

Description copied from interface: MenuOptionsDefinition

getProfile - get profile locator used to filter options

Specified by:

getProfile in interface MenuOptionsDefinition

Returns:

profile locator name

setProfile

public void setProfile(java.lang.String locatorName)

Description copied from interface: MenuOptionsDefinition

setProfile - set profile locator used to filter options

Specified by:

setProfile in interface MenuOptionsDefinition

Parameters:

locatorName - profile locator name

getOrder

public java.lang.String getOrder()

Description copied from interface: MenuOptionsDefinition

getOrder - get comma separated regexp ordering patterns

Specified by:

getOrder in interface MenuOptionsDefinition

Returns:

ordering patterns list

setOrder

public void setOrder(java.lang.String order)

Description copied from interface: MenuOptionsDefinition

setOrder - set comma separated regexp ordering patterns

Specified by:

setOrder in interface MenuOptionsDefinition

Parameters:

order - ordering patterns list

getSkin

public java.lang.String getSkin()

Description copied from interface: MenuOptionsDefinition

getSkin - get skin name for options

Specified by:

getSkin in interface MenuOptionsDefinition

Returns:

skin name

setSkin

public void setSkin(java.lang.String name)

Description copied from interface: MenuOptionsDefinition

setSkin - set skin name for options

Specified by:

setSkin in interface MenuOptionsDefinition

Parameters:

name - skin name