org.alfresco.web.config
Class SidebarConfigElement

java.lang.Object
  extended by org.springframework.extensions.config.element.ConfigElementAdapter
      extended by org.alfresco.web.config.SidebarConfigElement
All Implemented Interfaces:
java.io.Serializable, org.springframework.extensions.config.ConfigElement

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

Custom config element that represents the config data for the sidebar

See Also:
Serialized Form

Nested Class Summary
static class SidebarConfigElement.SidebarPluginConfig
          Inner class representing the configuration of a sidebar plugin
 
Field Summary
static java.lang.String CONFIG_ELEMENT_ID
           
 
Fields inherited from class org.springframework.extensions.config.element.ConfigElementAdapter
attributes, children, name, value
 
Constructor Summary
SidebarConfigElement()
          Default constructor
SidebarConfigElement(java.lang.String name)
          Constructor
 
Method Summary
 org.springframework.extensions.config.ConfigElement combine(org.springframework.extensions.config.ConfigElement configElement)
           
 java.util.List getChildren()
           
 java.lang.String getDefaultPlugin()
           
 SidebarConfigElement.SidebarPluginConfig getPlugin(java.lang.String id)
          Returns the named plugin
 java.util.Map getPlugins()
           
 void setDefaultPlugin(java.lang.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 java.lang.String CONFIG_ELEMENT_ID
See Also:
Constant Field Values
Constructor Detail

SidebarConfigElement

public SidebarConfigElement()
Default constructor


SidebarConfigElement

public SidebarConfigElement(java.lang.String name)
Constructor

Parameters:
name - Name of the element this config element represents
Method Detail

getChildren

public java.util.List getChildren()
Specified by:
getChildren in interface org.springframework.extensions.config.ConfigElement
Overrides:
getChildren in class org.springframework.extensions.config.element.ConfigElementAdapter
See Also:
org.alfresco.config.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:
org.alfresco.config.ConfigElement#combine(org.alfresco.config.ConfigElement)

getPlugin

public SidebarConfigElement.SidebarPluginConfig getPlugin(java.lang.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 java.util.Map getPlugins()
Returns:
Returns a map of the plugins. A linked hash map is used internally to preserve ordering.

getDefaultPlugin

public java.lang.String getDefaultPlugin()
Returns:
The id of the default plugin, null if there isn't a default defined

setDefaultPlugin

public void setDefaultPlugin(java.lang.String defaultPlugin)
Sets the plugin to use as the default

Parameters:
defaultPlugin - Id of the default plugin


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.