org.apache.jetspeed.om.folder.psml
Class MenuOptionsDefinitionImpl

java.lang.Object
  extended by org.apache.jetspeed.om.folder.psml.MenuOptionsDefinitionImpl
All Implemented Interfaces:
org.apache.jetspeed.om.folder.MenuOptionsDefinition

public class MenuOptionsDefinitionImpl
extends Object
implements org.apache.jetspeed.om.folder.MenuOptionsDefinition

This class implements the MenuOptionsDefinition interface in a persistent object form for use by the page manager component.

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

Field Summary
private  int depth
          depth - depth of inclusion for folder options
private  String options
          options - comma separated option paths specification for menu
private  String order
          order - comma separated list of ordering patterns for options
private  boolean paths
          paths - generate ordered path options for options
private  String profile
          profile - profile locator name filter for options
private  boolean regexp
          regexp - interpret specified optionsas regexp
private  String skin
          skin - skin name for menu
 
Fields inherited from interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
ANY_PROFILE_LOCATOR
 
Constructor Summary
MenuOptionsDefinitionImpl()
          MenuOptionsDefinitionImpl - constructor
 
Method Summary
 int getDepth()
          getDepth - get depth of inclusion for folder options
 String getOptions()
          getOptions - get comma separated menu options
 String getOrder()
          getOrder - get comma separated regexp ordering patterns
 String getProfile()
          getProfile - get profile locator used to filter options
 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(String options)
          setOptions - set comma separated menu options
 void setOrder(String order)
          setOrder - set comma separated regexp ordering patterns
 void setPaths(boolean paths)
          setPaths - set generate ordered path options
 void setProfile(String locatorName)
          setProfile - set profile locator used to filter options
 void setRegexp(boolean regexp)
          setRegexp - set regexp flag for interpreting options
 void setSkin(String name)
          setSkin - set skin name for options
 
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 - comma separated option paths specification for menu


depth

private int depth
depth - depth of inclusion for folder options


paths

private boolean paths
paths - generate ordered path options for options


regexp

private boolean regexp
regexp - interpret specified optionsas regexp


profile

private String profile
profile - profile locator name filter for options


order

private String order
order - comma separated list of ordering patterns for options


skin

private String skin
skin - skin name for menu

Constructor Detail

MenuOptionsDefinitionImpl

public MenuOptionsDefinitionImpl()
MenuOptionsDefinitionImpl - constructor

Method Detail

getOptions

public String getOptions()
getOptions - get comma separated menu options

Specified by:
getOptions in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Returns:
option paths specification

setOptions

public void setOptions(String options)
setOptions - set comma separated menu options

Specified by:
setOptions in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Parameters:
options - option paths specification

getDepth

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

Specified by:
getDepth in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Returns:
inclusion depth

setDepth

public void setDepth(int depth)
setDepth - set depth of inclusion for folder options

Specified by:
setDepth in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Parameters:
depth - inclusion depth

isPaths

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

Specified by:
isPaths in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Returns:
paths options flag

setPaths

public void setPaths(boolean paths)
setPaths - set generate ordered path options

Specified by:
setPaths in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Parameters:
paths - 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
Returns:
regexp flag

setRegexp

public void setRegexp(boolean regexp)
setRegexp - set regexp flag for interpreting options

Specified by:
setRegexp in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Parameters:
regexp - regexp flag

getProfile

public String getProfile()
getProfile - get profile locator used to filter options

Specified by:
getProfile in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Returns:
profile locator name

setProfile

public void setProfile(String locatorName)
setProfile - set profile locator used to filter options

Specified by:
setProfile in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Parameters:
locatorName - 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
Returns:
ordering patterns list

setOrder

public void setOrder(String order)
setOrder - set comma separated regexp ordering patterns

Specified by:
setOrder in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Parameters:
order - ordering patterns list

getSkin

public String getSkin()
getSkin - get skin name for options

Specified by:
getSkin in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Returns:
skin name

setSkin

public void setSkin(String name)
setSkin - set skin name for options

Specified by:
setSkin in interface org.apache.jetspeed.om.folder.MenuOptionsDefinition
Parameters:
name - skin name


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