com.ibm.ecm.configuration

Class MenuConfig

java.lang.Object
com.ibm.ecm.configuration.ConfigurationObject
com.ibm.ecm.configuration.MenuConfig

public class MenuConfig
extends ConfigurationObject

Field Summary

Fields inherited from class com.ibm.ecm.configuration.ConfigurationObject
`ARRAY_DELIMITER, cloned, KEY_DELIMITER, LIST_ESC_CHAR, LIST_ESCAPE, LIST_SEPARATOR, MODIFIER, properties`

Constructor Summary

Constructor and Description
`MenuConfig(org.apache.commons.configuration.Configuration configuration,java.lang.String idPrefix,java.lang.String id)`

Method Summary

Modifier and Type	Method and Description
java.lang.Object	`clone()`
boolean	`containsServer(java.lang.String serverId)`
void	`copy(javax.servlet.http.HttpServletRequest request,PluginAction pluginAction)`
java.lang.String	`getAction()`
java.lang.String	`getActionModelClass()`
java.lang.String	`getAdditionalConfiguration()`
static java.util.List<MenuConfig>	`getClonedMenu(javax.servlet.http.HttpServletRequest request,java.lang.String idPrefix,java.lang.String id)`
protected java.lang.Class	`getDataType(java.lang.String key)`
java.lang.String	`getDescription()`
java.lang.String	`getIcon()`
java.lang.String	`getIconClass()`
java.lang.String	`getId()`
java.lang.String[]	`getItems()`
JSONObject	`getJson()`
JSONObject	`getJson(JSONObject jsonAction)`
java.lang.String	`getLabel()`
java.lang.String	`getLabelId()`
java.lang.String	`getLabelText()`
java.lang.String[]	`getListTypes()` Deprecated. as of 2.0.2. Not used
static java.util.Collection<MenuConfig>	`getMenu(javax.servlet.http.HttpServletRequest request,java.lang.String idPrefix,java.lang.String id)`
java.lang.String[]	`getMenuTypes()`
java.lang.String	`getName()`
java.lang.String	`getObjectType()`
java.lang.String	`getPluginId()`
java.lang.String[]	`getPrivilegeNames()`
java.lang.String[]	`getServerTypes()`
java.util.List<MenuConfig>	`getSubMenus()`
java.lang.String	`getType()`
java.lang.String	`getTypeLabel()`
java.lang.String	`getWidgetFunction()`
java.lang.String	`getWidgetType()`
boolean	`isGlobal()`
boolean	`isMultiDoc()`
void	`loadPluginMenu(javax.servlet.http.HttpServletRequest request,PluginMenu pluginMenu)`
void	`loadSubMenus(javax.servlet.http.HttpServletRequest request,java.lang.String parentSubmenuId)`
void	`setAction(java.lang.String actionFunction)`
void	`setActionModelClass(java.lang.String actionModelClass)`
void	`setAdditionalConfiguration(java.lang.String additionalConfiguration)`
void	`setCloned(boolean cloned)`
void	`setDescription(java.lang.String description)`
void	`setGlobal(boolean global)`
void	`setIcon(java.lang.String icon)`
void	`setIconClass(java.lang.String iconClass)`
void	`setId(java.lang.String id)`
void	`setItems(java.lang.String[] menus)`
void	`setLabel(java.lang.String label)`
void	`setLabelId(java.lang.String labelId)`
void	`setLabelText(java.lang.String labelText)`
void	`setListTypes(java.lang.String[] listTypes)` Deprecated. as of 2.0.2. Not used
void	`setMenuId(java.lang.String menuId)`
void	`setMenuType(java.lang.String menuType)`
void	`setMenuTypes(java.lang.String[] menuTypes)`
void	`setMultiDoc(boolean multiDoc)`
void	`setName(java.lang.String name)`
void	`setPluginId(java.lang.String pluginId)`
void	`setPrivilegeNames(java.lang.String[] privilegeNames)`
void	`setServerTypes(java.lang.String[] serverTypes)`
void	`setSubmenuId(java.lang.String submenuId)`
void	`setSubMenus(java.util.List<MenuConfig> subMenus)`
void	`setType(java.lang.String type)`
void	`setTypeLabel(java.lang.String typeLabel)`
void	`setWidgetFunction(java.lang.String widgetFunction)`
void	`setWidgetType(java.lang.String widgetType)`
java.lang.String	`toString()`

Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject
`addValueToList, arrayToString, covertEmptyStringtoNull, delete, dump, getConfigurationObject, getDataTypeValue, getIdPrefix, getKey, getList, getMap, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, isEmpty, load, propertiesToString, removeValuesFromList, removeValuesFromList, save, setDefaultValue, setProperty, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, writeConfigurationToFile`

Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject

addValueToList, arrayToString, covertEmptyStringtoNull, delete, dump, getConfigurationObject, getDataTypeValue, getIdPrefix, getKey, getList, getMap, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, isEmpty, load, propertiesToString, removeValuesFromList, removeValuesFromList, save, setDefaultValue, setProperty, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, writeConfigurationToFile

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

MenuConfig

public MenuConfig(org.apache.commons.configuration.Configuration configuration,
java.lang.String idPrefix,
java.lang.String id)

Method Detail

getObjectType

public java.lang.String getObjectType( )

Description copied from class: ConfigurationObject

Abstract method to return object type.

Specified by:

getObjectType in class ConfigurationObject

Returns:

a string object type back, for example "desktop", "repository"...

getDataType

protected java.lang.Class getDataType( java.lang.String key)

Description copied from class: ConfigurationObject

Returns the datatype of a configuration property. This is implemented in subclasses and is used to properly serialize the properties. The default implementation returns null which indicates that compatible behavior should be used, which inspects the property value itself and guesses at the type of the property.

Overrides:

getDataType in class ConfigurationObject

Returns:

a Class instance describing the datatype of the property.

getMenu

public static java.util.Collection<MenuConfig> getMenu( javax.servlet.http.HttpServletRequest request,
java.lang.String idPrefix,
java.lang.String id)
throws org.apache.commons.configuration.ConfigurationException
MissingValueException

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getClonedMenu

public static java.util.List<MenuConfig> getClonedMenu( javax.servlet.http.HttpServletRequest request,
java.lang.String idPrefix,
java.lang.String id)
throws org.apache.commons.configuration.ConfigurationException
MissingValueException

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

loadSubMenus

public void loadSubMenus(javax.servlet.http.HttpServletRequest request,
java.lang.String parentSubmenuId)
throws org.apache.commons.configuration.ConfigurationException
MissingValueException

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

loadPluginMenu

public void loadPluginMenu(javax.servlet.http.HttpServletRequest request,
PluginMenu pluginMenu)
throws org.apache.commons.configuration.ConfigurationException
MissingValueException

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSubMenus

public java.util.List<MenuConfig> getSubMenus( )

setSubMenus

public void setSubMenus(java.util.List<MenuConfig> subMenus)

getItems

public java.lang.String[] getItems( )

setItems

public void setItems(java.lang.String[] menus)

getPluginId

public java.lang.String getPluginId( )

setPluginId

public void setPluginId(java.lang.String pluginId)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getIcon

public java.lang.String getIcon( )

setIcon

public void setIcon(java.lang.String icon)

getIconClass

public java.lang.String getIconClass( )

setIconClass

public void setIconClass(java.lang.String iconClass)

getWidgetFunction

public java.lang.String getWidgetFunction( )

setWidgetFunction

public void setWidgetFunction(java.lang.String widgetFunction)

getWidgetType

public java.lang.String getWidgetType( )

setWidgetType

public void setWidgetType(java.lang.String widgetType)

getName

public java.lang.String getName( )

Overrides:

getName in class ConfigurationObject

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription( )

setDescription

public void setDescription(java.lang.String description)

getType

public java.lang.String getType( )

setType

public void setType(java.lang.String type)

getTypeLabel

public java.lang.String getTypeLabel( )

setTypeLabel

public void setTypeLabel(java.lang.String typeLabel)

isMultiDoc

public boolean isMultiDoc()

setMultiDoc

public void setMultiDoc(boolean multiDoc)

isGlobal

public boolean isGlobal()

setGlobal

public void setGlobal(boolean global)

getAction

public java.lang.String getAction( )

setAction

public void setAction(java.lang.String actionFunction)

getLabel

public java.lang.String getLabel( )

setLabel

public void setLabel(java.lang.String label)

containsServer

public boolean containsServer(java.lang.String serverId)

getServerTypes

public java.lang.String[] getServerTypes( )

setServerTypes

public void setServerTypes(java.lang.String[] serverTypes)

getListTypes

public java.lang.String[] getListTypes( )

Deprecated. as of 2.0.2. Not used

setListTypes

public void setListTypes(java.lang.String[] listTypes)

Deprecated. as of 2.0.2. Not used

getPrivilegeNames

public java.lang.String[] getPrivilegeNames( )

setPrivilegeNames

public void setPrivilegeNames(java.lang.String[] privilegeNames)

getLabelText

public java.lang.String getLabelText( )

setLabelText

public void setLabelText(java.lang.String labelText)

getLabelId

public java.lang.String getLabelId( )

setLabelId

public void setLabelId(java.lang.String labelId)

getActionModelClass

public java.lang.String getActionModelClass( )

setActionModelClass

public void setActionModelClass( java.lang.String actionModelClass)

getMenuTypes

public java.lang.String[] getMenuTypes( )

setMenuTypes

public void setMenuTypes(java.lang.String[] menuTypes)

getAdditionalConfiguration

public java.lang.String getAdditionalConfiguration( )

setAdditionalConfiguration

public void setAdditionalConfiguration( java.lang.String additionalConfiguration)

clone

public java.lang.Object clone()
throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getJson

public JSONObject getJson()

getJson

public JSONObject getJson(JSONObject jsonAction)

copy

public void copy(javax.servlet.http.HttpServletRequest request,
PluginAction pluginAction)

toString

public java.lang.String toString( )

Description copied from class: ConfigurationObject

Override to return the object ID of this configuration back.

Overrides:

toString in class ConfigurationObject

setMenuType

public void setMenuType(java.lang.String menuType)

setMenuId

public void setMenuId(java.lang.String menuId)

setSubmenuId

public void setSubmenuId(java.lang.String submenuId)

setCloned

public void setCloned(boolean cloned)