org.alfresco.web.config

Class SidebarConfigElement

java.lang.Object

org.springframework.extensions.config.element.ConfigElementAdapter

org.alfresco.web.config.SidebarConfigElement

All Implemented Interfaces:

Serializable, org.springframework.extensions.config.ConfigElement

public class SidebarConfigElement
extends org.springframework.extensions.config.element.ConfigElementAdapter
implements Serializable

Custom config element that represents the config data for the sidebar

Author:

gavinc

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SidebarConfigElement.SidebarPluginConfig Inner class representing the configuration of a sidebar plugin

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_ELEMENT_ID

Fields inherited from class org.springframework.extensions.config.element.ConfigElementAdapter

attributes, children, name, value

Constructor Summary

Constructors

Constructor and Description
SidebarConfigElement() Default constructor
SidebarConfigElement(String name) Constructor

Method Summary

Modifier and Type	Method and Description
org.springframework.extensions.config.ConfigElement	combine(org.springframework.extensions.config.ConfigElement configElement)
List<org.springframework.extensions.config.ConfigElement>	getChildren()
String	getDefaultPlugin()
SidebarConfigElement.SidebarPluginConfig	getPlugin(String id) Returns the named plugin
Map<String,SidebarConfigElement.SidebarPluginConfig>	getPlugins()
void	setDefaultPlugin(String defaultPlugin) Sets the plugin to use as the default

Methods inherited from class org.springframework.extensions.config.element.ConfigElementAdapter

getAttribute, getAttributeCount, getAttributes, getChild, getChildCount, getChildren, getChildrenMap, getChildValue, getName, getValue, hasAttribute, hasChildren, setValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_ELEMENT_ID

public static final String CONFIG_ELEMENT_ID

See Also:

Constant Field Values

Constructor Detail

SidebarConfigElement

public SidebarConfigElement()

Default constructor

SidebarConfigElement

public SidebarConfigElement(String name)

Constructor

Parameters:

name - Name of the element this config element represents

Method Detail

getChildren

public List<org.springframework.extensions.config.ConfigElement> getChildren()

Specified by:

getChildren in interface org.springframework.extensions.config.ConfigElement

Overrides:

getChildren in class org.springframework.extensions.config.element.ConfigElementAdapter

See Also:

ConfigElement.getChildren()

combine

public org.springframework.extensions.config.ConfigElement combine(org.springframework.extensions.config.ConfigElement configElement)

Specified by:

combine in interface org.springframework.extensions.config.ConfigElement

Specified by:

combine in class org.springframework.extensions.config.element.ConfigElementAdapter

See Also:

ConfigElement.combine(org.springframework.extensions.config.ConfigElement)

getPlugin

public SidebarConfigElement.SidebarPluginConfig getPlugin(String id)

Returns the named plugin

Parameters:

id - The id of the plugin to retrieve

Returns:

The SidebarPluginConfig object for the requested plugin or null if it doesn't exist

getPlugins

public Map<String,SidebarConfigElement.SidebarPluginConfig> getPlugins()

Returns:

Returns a map of the plugins. A linked hash map is used internally to preserve ordering.

getDefaultPlugin

public String getDefaultPlugin()

Returns:

The id of the default plugin, null if there isn't a default defined

setDefaultPlugin

public void setDefaultPlugin(String defaultPlugin)

Sets the plugin to use as the default

Parameters:

defaultPlugin - Id of the default plugin