org.alfresco.web.config.forms

Class FormConfigElement

java.lang.Object

org.springframework.extensions.config.element.ConfigElementAdapter

org.alfresco.web.config.forms.FormConfigElement

All Implemented Interfaces:

Serializable, org.springframework.extensions.config.ConfigElement

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

This config element represents form values for the client. Note the distinction between 'form' and 'forms' elements in the config xml. Form elements are contained by forms elements.

Author:

Neil McErlean.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SET_ID
static String	FORM_NAME_ID

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

attributes, children, name, value

Constructor Summary

Constructors

Constructor and Description
FormConfigElement()
FormConfigElement(String name)

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.extensions.config.ConfigElement	combine(org.springframework.extensions.config.ConfigElement otherConfigElement)
List<org.springframework.extensions.config.ConfigElement>	getChildren()
String	getCreateTemplate()
String	getEditTemplate()
Map<String,FormField>	getFields() This method returns a Map of field names mentioned in the forms config, with any associated config data as the associated value.
String[]	getForcedFields()
List<String>	getForcedFieldsAsList() Returns the list of fields that have been forced to be visible
String	getFormTemplate(Mode m)
String[]	getHiddenCreateFieldNames()
List<String>	getHiddenCreateFieldNamesAsList()
String[]	getHiddenEditFieldNames()
List<String>	getHiddenEditFieldNamesAsList()
String[]	getHiddenViewFieldNames()
List<String>	getHiddenViewFieldNamesAsList()
String	getId()
FormSet[]	getRootSets()
List<FormSet>	getRootSetsAsList() This method returns a Map of those <set>s which have no declared parentID i.e. those that are 'roots' in the tree of sets.
String[]	getSetIDs()
List<String>	getSetIDsAsList()
Map<String,FormSet>	getSets()
String	getSubmissionURL()
String	getViewTemplate()
String[]	getVisibleCreateFieldNames()
List<String>	getVisibleCreateFieldNamesAsList()
String[]	getVisibleCreateFieldNamesForSet(String setId) This method returns an array of fieldNames for those fields which are visible in Create mode and which are also members of the specified set.
List<String>	getVisibleCreateFieldNamesForSetAsList(String setId)
String[]	getVisibleEditFieldNames()
List<String>	getVisibleEditFieldNamesAsList()
String[]	getVisibleEditFieldNamesForSet(String setId)
List<String>	getVisibleEditFieldNamesForSetAsList(String setId)
String[]	getVisibleViewFieldNames()
List<String>	getVisibleViewFieldNamesAsList()
String[]	getVisibleViewFieldNamesForSet(String setId)
List<String>	getVisibleViewFieldNamesForSetAsList(String setId)
boolean	isFieldForced(String fieldId) Determines whether the given fieldId has been configured as 'force'd
boolean	isFieldHidden(String fieldId, Mode m) This method checks whether the specified field is specifically hidden in the specified mode.
boolean	isFieldHiddenInMode(String fieldId, String modeString) This method checks whether the specified field is specifically hidden in the specified mode.
boolean	isFieldVisible(String fieldId, Mode m) This method checks whether the specified field is visible in the specified mode.
boolean	isFieldVisibleInMode(String fieldId, String modeString) This method checks whether the specified field is visible in the specified mode.

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

FORM_NAME_ID

public static final String FORM_NAME_ID

See Also:

Constant Field Values

DEFAULT_SET_ID

public static final String DEFAULT_SET_ID

See Also:

Constant Field Values

Constructor Detail

FormConfigElement

public FormConfigElement()

FormConfigElement

public FormConfigElement(String name)

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 otherConfigElement)

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)

getId

public String getId()

getSubmissionURL

public String getSubmissionURL()

getSets

public Map<String,FormSet> getSets()

getSetIDs

public String[] getSetIDs()

getSetIDsAsList

public List<String> getSetIDsAsList()

getRootSets

public FormSet[] getRootSets()

getRootSetsAsList

public List<FormSet> getRootSetsAsList()

This method returns a Map of those <set>s which have no declared parentID i.e. those that are 'roots' in the tree of sets. Note that this map will always have at least one member; the default set.

Returns:

See Also:

DEFAULT_SET_ID

getFields

public Map<String,FormField> getFields()

This method returns a Map of field names mentioned in the forms config, with any associated config data as the associated value. This will include any fields specified under the <appearance> tag in the config as well as those mentioned under <field-visibility>. The former will have associated config data whilst the latter will not.

Returns:

a mapping of field names to their associated FormField data objects.

getHiddenCreateFieldNames

public String[] getHiddenCreateFieldNames()

getHiddenEditFieldNames

public String[] getHiddenEditFieldNames()

getHiddenViewFieldNames

public String[] getHiddenViewFieldNames()

getVisibleCreateFieldNames

public String[] getVisibleCreateFieldNames()

getVisibleEditFieldNames

public String[] getVisibleEditFieldNames()

getVisibleViewFieldNames

public String[] getVisibleViewFieldNames()

getHiddenCreateFieldNamesAsList

public List<String> getHiddenCreateFieldNamesAsList()

See Also:

FieldVisibilityManager.getFieldNamesHiddenInMode(Mode)

getHiddenEditFieldNamesAsList

public List<String> getHiddenEditFieldNamesAsList()

See Also:

FieldVisibilityManager.getFieldNamesHiddenInMode(Mode)

getHiddenViewFieldNamesAsList

public List<String> getHiddenViewFieldNamesAsList()

See Also:

FieldVisibilityManager.getFieldNamesHiddenInMode(Mode)

getVisibleCreateFieldNamesAsList

public List<String> getVisibleCreateFieldNamesAsList()

See Also:

FieldVisibilityManager.getFieldNamesVisibleInMode(Mode)

getVisibleEditFieldNamesAsList

public List<String> getVisibleEditFieldNamesAsList()

See Also:

FieldVisibilityManager.getFieldNamesVisibleInMode(Mode)

getVisibleViewFieldNamesAsList

public List<String> getVisibleViewFieldNamesAsList()

See Also:

FieldVisibilityManager.getFieldNamesVisibleInMode(Mode)

getVisibleCreateFieldNamesForSetAsList

public List<String> getVisibleCreateFieldNamesForSetAsList(String setId)

getVisibleCreateFieldNamesForSet

public String[] getVisibleCreateFieldNamesForSet(String setId)

This method returns an array of fieldNames for those fields which are visible in Create mode and which are also members of the specified set.

Parameters:

setId -

Returns:

the array of fieldNames (if there are any). null will be returned if the specified setId is not recognised or if the visible fields are not known.

getVisibleEditFieldNamesForSetAsList

public List<String> getVisibleEditFieldNamesForSetAsList(String setId)

getVisibleEditFieldNamesForSet

public String[] getVisibleEditFieldNamesForSet(String setId)

getVisibleViewFieldNamesForSetAsList

public List<String> getVisibleViewFieldNamesForSetAsList(String setId)

getVisibleViewFieldNamesForSet

public String[] getVisibleViewFieldNamesForSet(String setId)

getCreateTemplate

public String getCreateTemplate()

getEditTemplate

public String getEditTemplate()

getViewTemplate

public String getViewTemplate()

getFormTemplate

public String getFormTemplate(Mode m)

Parameters:

m -

Returns:

null if there is no template available for the specified mode.

isFieldVisible

public boolean isFieldVisible(String fieldId,
                     Mode m)

This method checks whether the specified field is visible in the specified mode.

Parameters:

fieldId - the id of the field

m - a mode.

Returns:

true if the field is configured to be visible

isFieldHidden

public boolean isFieldHidden(String fieldId,
                    Mode m)

This method checks whether the specified field is specifically hidden in the specified mode.

Parameters:

fieldId - the id of the field

m - a mode.

Returns:

true if the field is configured to be hidden

isFieldVisibleInMode

public boolean isFieldVisibleInMode(String fieldId,
                           String modeString)

This method checks whether the specified field is visible in the specified mode. This is added as a convenience for JavaScript clients.

Parameters:

fieldId -

modeString -

Returns:

See Also:

isFieldVisible(String, Mode)

isFieldHiddenInMode

public boolean isFieldHiddenInMode(String fieldId,
                          String modeString)

This method checks whether the specified field is specifically hidden in the specified mode. This is added as a convenience for JavaScript clients.

Parameters:

fieldId -

modeString -

Returns:

#isFieldHidden(String, Mode)

isFieldForced

public boolean isFieldForced(String fieldId)

Determines whether the given fieldId has been configured as 'force'd

Parameters:

fieldId - The field id to check

Returns:

true if the field is being forced to be visible

getForcedFields

public String[] getForcedFields()

getForcedFieldsAsList

public List<String> getForcedFieldsAsList()

Returns the list of fields that have been forced to be visible

Returns:

List of field ids