org.alfresco.web.config.header
Class HeaderItemsConfigElement

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

public class HeaderItemsConfigElement
extends org.springframework.extensions.config.element.ConfigElementAdapter

Custom config element that represents <items> values for the client.

See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_ELEMENT_ID
           
 
Fields inherited from class org.springframework.extensions.config.element.ConfigElementAdapter
attributes, children, name, value
 
Constructor Summary
HeaderItemsConfigElement()
          This constructor creates an instance with the default name.
HeaderItemsConfigElement(java.lang.String name)
          This constructor creates an instance with the specified name.
 
Method Summary
 org.springframework.extensions.config.ConfigElement combine(org.springframework.extensions.config.ConfigElement configElement)
           
 java.util.List getChildren()
           
 java.lang.String getCondition()
           
 java.lang.String getId()
           
 HeaderItem getItem(java.lang.String id)
          This method returns the item having the specified id string from within a <header> tag.
 HeaderItem[] getItems()
           
 java.util.List getItemsAsList()
          This method returns an unmodifiable List of HeaderItem objects that are associated with this container.
 java.lang.String getLabel()
           
 java.lang.String getPermission()
           
 void setCondition(java.lang.String condition)
           
 void setId(java.lang.String id)
           
 void setLabel(java.lang.String label)
           
 void setPermission(java.lang.String permission)
           
 
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

DEFAULT_ELEMENT_ID

public static final java.lang.String DEFAULT_ELEMENT_ID
See Also:
Constant Field Values
Constructor Detail

HeaderItemsConfigElement

public HeaderItemsConfigElement()
This constructor creates an instance with the default name.


HeaderItemsConfigElement

public HeaderItemsConfigElement(java.lang.String name)
This constructor creates an instance with the specified name.

Parameters:
name - the name for the ConfigElement.
Method Detail

getItems

public HeaderItem[] getItems()

getItemsAsList

public java.util.List getItemsAsList()
This method returns an unmodifiable List of HeaderItem objects that are associated with this container.

Returns:
an unmodifiable List of HeaderItem references.

getItem

public HeaderItem getItem(java.lang.String id)
This method returns the item having the specified id string from within a <header> tag. Items within containers and container-groups are prefixed with each parent's id to create a unique id for that item.

Returns:
the ItemConfigElement instance having the correct id, if one exists, else null.

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)

setId

public void setId(java.lang.String id)

setLabel

public void setLabel(java.lang.String label)

setPermission

public void setPermission(java.lang.String permission)

setCondition

public void setCondition(java.lang.String condition)

getId

public java.lang.String getId()

getLabel

public java.lang.String getLabel()

getPermission

public java.lang.String getPermission()

getCondition

public java.lang.String getCondition()


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