FormConfigElement (Alfresco Web Framework Commons)

java.lang.Object
- org.springframework.extensions.config.element.ConfigElementAdapter
- - org.alfresco.web.config.forms.FormConfigElement

All Implemented Interfaces:

java.io.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.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DEFAULT_SET_ID

static java.lang.String FORM_NAME_ID
- Fields inherited from class org.springframework.extensions.config.element.ConfigElementAdapter
  attributes, children, name, value

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_SET_ID`
`static java.lang.String`	`FORM_NAME_ID`

Constructor Summary

Constructors
Constructor and Description

FormConfigElement()

FormConfigElement(java.lang.String name)

Constructors
Constructor and Description
`FormConfigElement()`
`FormConfigElement(java.lang.String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`org.springframework.extensions.config.ConfigElement`	`combine(org.springframework.extensions.config.ConfigElement otherConfigElement)`
`java.util.List`	`getChildren()`
`java.lang.String`	`getCreateTemplate()`
`java.lang.String`	`getEditTemplate()`
`java.util.Map`	`getFields()` This method returns a Map of field names mentioned in the forms config, with any associated config data as the associated value.
`java.lang.String[]`	`getForcedFields()`
`java.util.List`	`getForcedFieldsAsList()` Returns the list of fields that have been forced to be visible
`java.lang.String`	`getFormTemplate(Mode m)`
`java.lang.String[]`	`getHiddenCreateFieldNames()`
`java.util.List`	`getHiddenCreateFieldNamesAsList()`
`java.lang.String[]`	`getHiddenEditFieldNames()`
`java.util.List`	`getHiddenEditFieldNamesAsList()`
`java.lang.String[]`	`getHiddenViewFieldNames()`
`java.util.List`	`getHiddenViewFieldNamesAsList()`
`java.lang.String`	`getId()`
`FormSet[]`	`getRootSets()`
`java.util.List`	`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.
`java.lang.String[]`	`getSetIDs()`
`java.util.List`	`getSetIDsAsList()`
`java.util.Map`	`getSets()`
`java.lang.String`	`getSubmissionURL()`
`java.lang.String`	`getViewTemplate()`
`java.lang.String[]`	`getVisibleCreateFieldNames()`
`java.util.List`	`getVisibleCreateFieldNamesAsList()`
`java.lang.String[]`	`getVisibleCreateFieldNamesForSet(java.lang.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.
`java.util.List`	`getVisibleCreateFieldNamesForSetAsList(java.lang.String setId)`
`java.lang.String[]`	`getVisibleEditFieldNames()`
`java.util.List`	`getVisibleEditFieldNamesAsList()`
`java.lang.String[]`	`getVisibleEditFieldNamesForSet(java.lang.String setId)`
`java.util.List`	`getVisibleEditFieldNamesForSetAsList(java.lang.String setId)`
`java.lang.String[]`	`getVisibleViewFieldNames()`
`java.util.List`	`getVisibleViewFieldNamesAsList()`
`java.lang.String[]`	`getVisibleViewFieldNamesForSet(java.lang.String setId)`
`java.util.List`	`getVisibleViewFieldNamesForSetAsList(java.lang.String setId)`
`boolean`	`isFieldForced(java.lang.String fieldId)` Determines whether the given fieldId has been configured as 'force'd
`boolean`	`isFieldHidden(java.lang.String fieldId, Mode m)` This method checks whether the specified field is specifically hidden in the specified mode.
`boolean`	`isFieldHiddenInMode(java.lang.String fieldId, java.lang.String modeString)` This method checks whether the specified field is specifically hidden in the specified mode.
`boolean`	`isFieldVisible(java.lang.String fieldId, Mode m)` This method checks whether the specified field is visible in the specified mode.
`boolean`	`isFieldVisibleInMode(java.lang.String fieldId, java.lang.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 java.lang.String FORM_NAME_ID
```
    See Also:
    Constant Field Values
  - DEFAULT_SET_ID
```
public static final java.lang.String DEFAULT_SET_ID
```
    See Also:
    Constant Field Values
- Constructor Detail
  - FormConfigElement
```
public FormConfigElement()
```
  - FormConfigElement
```
public FormConfigElement(java.lang.String name)
```
- 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 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 java.lang.String getId()
```
  - getSubmissionURL
```
public java.lang.String getSubmissionURL()
```
  - getSets
```
public java.util.Map getSets()
```
  - getSetIDs
```
public java.lang.String[] getSetIDs()
```
  - getSetIDsAsList
```
public java.util.List getSetIDsAsList()
```
  - getRootSets
```
public FormSet[] getRootSets()
```
  - getRootSetsAsList
```
public java.util.List 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:
    FormConfigElement.DEFAULT_SET_ID
  - getFields
```
public java.util.Map 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 java.lang.String[] getHiddenCreateFieldNames()
```
  - getHiddenEditFieldNames
```
public java.lang.String[] getHiddenEditFieldNames()
```
  - getHiddenViewFieldNames
```
public java.lang.String[] getHiddenViewFieldNames()
```
  - getVisibleCreateFieldNames
```
public java.lang.String[] getVisibleCreateFieldNames()
```
  - getVisibleEditFieldNames
```
public java.lang.String[] getVisibleEditFieldNames()
```
  - getVisibleViewFieldNames
```
public java.lang.String[] getVisibleViewFieldNames()
```
  - getHiddenCreateFieldNamesAsList
```
public java.util.List getHiddenCreateFieldNamesAsList()
```
    See Also:
    FieldVisibilityManager.getFieldNamesHiddenInMode(Mode)
  - getHiddenEditFieldNamesAsList
```
public java.util.List getHiddenEditFieldNamesAsList()
```
    See Also:
    FieldVisibilityManager.getFieldNamesHiddenInMode(Mode)
  - getHiddenViewFieldNamesAsList
```
public java.util.List getHiddenViewFieldNamesAsList()
```
    See Also:
    FieldVisibilityManager.getFieldNamesHiddenInMode(Mode)
  - getVisibleCreateFieldNamesAsList
```
public java.util.List getVisibleCreateFieldNamesAsList()
```
    See Also:
    FieldVisibilityManager.getFieldNamesVisibleInMode(Mode)
  - getVisibleEditFieldNamesAsList
```
public java.util.List getVisibleEditFieldNamesAsList()
```
    See Also:
    FieldVisibilityManager.getFieldNamesVisibleInMode(Mode)
  - getVisibleViewFieldNamesAsList
```
public java.util.List getVisibleViewFieldNamesAsList()
```
    See Also:
    FieldVisibilityManager.getFieldNamesVisibleInMode(Mode)
  - getVisibleCreateFieldNamesForSetAsList
```
public java.util.List getVisibleCreateFieldNamesForSetAsList(java.lang.String setId)
```
  - getVisibleCreateFieldNamesForSet
```
public java.lang.String[] getVisibleCreateFieldNamesForSet(java.lang.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 java.util.List getVisibleEditFieldNamesForSetAsList(java.lang.String setId)
```
  - getVisibleEditFieldNamesForSet
```
public java.lang.String[] getVisibleEditFieldNamesForSet(java.lang.String setId)
```
  - getVisibleViewFieldNamesForSetAsList
```
public java.util.List getVisibleViewFieldNamesForSetAsList(java.lang.String setId)
```
  - getVisibleViewFieldNamesForSet
```
public java.lang.String[] getVisibleViewFieldNamesForSet(java.lang.String setId)
```
  - getCreateTemplate
```
public java.lang.String getCreateTemplate()
```
  - getEditTemplate
```
public java.lang.String getEditTemplate()
```
  - getViewTemplate
```
public java.lang.String getViewTemplate()
```
  - getFormTemplate
```
public java.lang.String getFormTemplate(Mode m)
```
    Parameters:
    m -
    
    Returns:
    null if there is no template available for the specified mode.
  - isFieldVisible
```
public boolean isFieldVisible(java.lang.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(java.lang.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(java.lang.String fieldId,
                           java.lang.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:
    FormConfigElement.isFieldVisible(String, Mode)
  - isFieldHiddenInMode
```
public boolean isFieldHiddenInMode(java.lang.String fieldId,
                          java.lang.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(java.lang.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 java.lang.String[] getForcedFields()
```
  - getForcedFieldsAsList
```
public java.util.List getForcedFieldsAsList()
```
    Returns the list of fields that have been forced to be visible
    
    Returns:
    List of field ids

Class FormConfigElement

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

FORM_NAME_ID

DEFAULT_SET_ID

Constructor Detail

FormConfigElement

FormConfigElement

Method Detail

getChildren

combine

getId

getSubmissionURL

getSets

getSetIDs

getSetIDsAsList

getRootSets

getRootSetsAsList

getFields

getHiddenCreateFieldNames

getHiddenEditFieldNames

getHiddenViewFieldNames

getVisibleCreateFieldNames

getVisibleEditFieldNames

getVisibleViewFieldNames

getHiddenCreateFieldNamesAsList

getHiddenEditFieldNamesAsList

getHiddenViewFieldNamesAsList

getVisibleCreateFieldNamesAsList

getVisibleEditFieldNamesAsList

getVisibleViewFieldNamesAsList

getVisibleCreateFieldNamesForSetAsList

getVisibleCreateFieldNamesForSet

getVisibleEditFieldNamesForSetAsList

getVisibleEditFieldNamesForSet

getVisibleViewFieldNamesForSetAsList

getVisibleViewFieldNamesForSet

getCreateTemplate

getEditTemplate

getViewTemplate

getFormTemplate

isFieldVisible

isFieldHidden

isFieldVisibleInMode

isFieldHiddenInMode

isFieldForced

getForcedFields

getForcedFieldsAsList