org.alfresco.web.config.forms

Class DefaultControlsConfigElement

java.lang.Object

org.springframework.extensions.config.element.ConfigElementAdapter

org.alfresco.web.config.forms.DefaultControlsConfigElement

All Implemented Interfaces:

Serializable, org.springframework.extensions.config.ConfigElement

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

Custom config element that represents <default-controls> values for the client.

Author:

Neil McErlean.

See Also:

Serialized Form

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
DefaultControlsConfigElement() This constructor creates an instance with the default name.
DefaultControlsConfigElement(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()
List<ControlParam>	getControlParamsAsListFor(String dataType) This method returns an unmodifiable List of ControlParam objects associated with the specified dataType.
ControlParam[]	getControlParamsFor(String dataType)
String[]	getItemNames()
List<String>	getItemNamesAsList()
Map<String,Control>	getItems()
String	getTemplateFor(String dataType) This method returns a String representing the path of the template associated with the given dataType.

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

DefaultControlsConfigElement

public DefaultControlsConfigElement()

This constructor creates an instance with the default name.

DefaultControlsConfigElement

public DefaultControlsConfigElement(String name)

This constructor creates an instance with the specified name.

Parameters:

name - the name for the ConfigElement.

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:

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)

getItemNames

public String[] getItemNames()

getItemNamesAsList

public List<String> getItemNamesAsList()

getItems

public Map<String,Control> getItems()

getTemplateFor

public String getTemplateFor(String dataType)

This method returns a String representing the path of the template associated with the given dataType.

Parameters:

dataType - the dataType for which a template is required.

Returns:

the path of the associated template. null if the specified dataType is null or if there is no registered template.

getControlParamsFor

public ControlParam[] getControlParamsFor(String dataType)

getControlParamsAsListFor

public List<ControlParam> getControlParamsAsListFor(String dataType)

This method returns an unmodifiable List of ControlParam objects associated with the specified dataType.

Parameters:

dataType - the dataType for which control-params are required.

Returns:

an unmodifiable List of the associated ControlParam objects.

See Also:

org.alfresco.web.config.ControlParam