org.alfresco.repo.forms

Class Form

java.lang.Object

org.alfresco.repo.forms.Form

public class Form
extends Object

Data representation of a form to be displayed in the UI.

Author:

Gavin Cornwell

Field Summary

Fields

Modifier and Type	Field and Description
protected FormData	data
protected List<FieldDefinition>	fieldDefinitions
protected Collection<FieldGroup>	fieldGroups
protected Item	item
protected String	submissionUrl

Constructor Summary

Constructors

Constructor and Description
Form(Item item) Constructs a Form

Method Summary

Modifier and Type	Method and Description
void	addData(String fieldName, Object fieldData) Adds some data to be displayed by the form
void	addField(Field field) Adds a Field to the form by adding the FieldDefinition and the value if any.
void	addFieldDefinition(FieldDefinition definition) Adds the given FieldDefinition to the form.
void	addFields(Collection<Field> fields) Adds a Collection of Fields to the form by adding the FieldDefinitions and the values if any.
boolean	dataExists(String dataKey) Returns true if the Form contains FormData.FieldData for the specified dataKey.
List<String>	getFieldDefinitionNames()
List<FieldDefinition>	getFieldDefinitions() Returns the list of field definitions for the form
Collection<FieldGroup>	getFieldGroups() Returns the collection of field groups for the form
FormData	getFormData() Returns the data to display in the form
Item	getItem() Returns the item the form is for
String	getSubmissionUrl() Returns the submission URL to use for the form
void	setFieldDefinitions(List<FieldDefinition> fieldDefinitions) Sets the list of FieldDefinition objects representing the fields the form is able to display
void	setFieldGroups(Collection<FieldGroup> fieldGroups) Sets the collection of FieldGroup objects representing the groups of fields the form should display and maintain
void	setFormData(FormData data) Sets the data this form should display.
void	setSubmissionUrl(String url) Sets the submission URL the form should use
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

item

protected Item item

submissionUrl

protected String submissionUrl

fieldDefinitions

protected List<FieldDefinition> fieldDefinitions

fieldGroups

protected Collection<FieldGroup> fieldGroups

data

protected FormData data

Constructor Detail

Form

public Form(Item item)

Constructs a Form

Parameters:

item - The item the form is for

Method Detail

getItem

public Item getItem()

Returns the item the form is for

Returns:

The item

getSubmissionUrl

public String getSubmissionUrl()

Returns the submission URL to use for the form

Returns:

URL to submit to

setSubmissionUrl

public void setSubmissionUrl(String url)

Sets the submission URL the form should use

Parameters:

url - URL to submit to

getFieldDefinitions

public List<FieldDefinition> getFieldDefinitions()

Returns the list of field definitions for the form

Returns:

List of FieldDefinition objects or null if there are no fields

getFieldDefinitionNames

public List<String> getFieldDefinitionNames()

setFieldDefinitions

public void setFieldDefinitions(List<FieldDefinition> fieldDefinitions)

Sets the list of FieldDefinition objects representing the fields the form is able to display

Parameters:

fieldDefinitions - List of FieldDefinition objects

addFieldDefinition

public void addFieldDefinition(FieldDefinition definition)

Adds the given FieldDefinition to the form.

NOTE: Multiple fields with the same name can be added to the list, it is therefore the form processor and the client of the FormService responsibility to differentiate the fields in some way i.e. by type, property vs. association.

Parameters:

definition - The FieldDefinition to add

getFieldGroups

public Collection<FieldGroup> getFieldGroups()

Returns the collection of field groups for the form

Returns:

Collection of FieldGroup objects or null if there are no groups

setFieldGroups

public void setFieldGroups(Collection<FieldGroup> fieldGroups)

Sets the collection of FieldGroup objects representing the groups of fields the form should display and maintain

Parameters:

fieldGroups - Collection of FieldGroup objects

getFormData

public FormData getFormData()

Returns the data to display in the form

Returns:

FormData object holding the data of the form or null if there is no data i.e. for a create form

setFormData

public void setFormData(FormData data)

Sets the data this form should display. This will overwrite any existing form data being held

Parameters:

data - FormData instance containing the data

dataExists

public boolean dataExists(String dataKey)

Returns true if the Form contains FormData.FieldData for the specified dataKey.

Parameters:

dataKey - The dataKey for the field.

Returns:

boolean

addData

public void addData(String fieldName,
                    Object fieldData)

Adds some data to be displayed by the form

Parameters:

fieldName - Name of the field the data is for

fieldData - The value

addField

public void addField(Field field)

Adds a Field to the form by adding the FieldDefinition and the value if any.

Parameters:

field - Field

addFields

public void addFields(Collection<Field> fields)

Adds a Collection of Fields to the form by adding the FieldDefinitions and the values if any.

toString

public String toString()

Overrides:

toString in class Object