org.alfresco.web.config.header

Class HeaderItemsConfigElement

java.lang.Object

org.springframework.extensions.config.element.ConfigElementAdapter

org.alfresco.web.config.header.HeaderItemsConfigElement

All Implemented Interfaces:

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.

Author:

Mike Hatfield.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ELEMENT_ID

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

attributes, children, name, value

Constructor Summary

Constructors

Constructor and Description
HeaderItemsConfigElement() This constructor creates an instance with the default name.
HeaderItemsConfigElement(String name) This constructor creates an instance with the specified name.

Method Summary

Methods

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	getCondition()
String	getId()
HeaderItem	getItem(String id) This method returns the item having the specified id string from within a <header> tag.
HeaderItem[]	getItems()
List<HeaderItem>	getItemsAsList() This method returns an unmodifiable List of HeaderItem objects that are associated with this container.
String	getLabel()
String	getPermission()
void	setCondition(String condition)
void	setId(String id)
void	setLabel(String label)
void	setPermission(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 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(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 List<HeaderItem> 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(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 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:

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(String id)

setLabel

public void setLabel(String label)

setPermission

public void setPermission(String permission)

setCondition

public void setCondition(String condition)

getId

public String getId()

getLabel

public String getLabel()

getPermission

public String getPermission()

getCondition

public String getCondition()