com.liferay.dynamic.data.mapping.model

Class DDMFormField

java.lang.Object

com.liferay.dynamic.data.mapping.model.DDMFormField

All Implemented Interfaces:

java.io.Serializable

public class DDMFormField
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Property Summary

Type	Property and Description
boolean	isVisual Gets the value of the property visualProperty.

Constructor Summary

Constructors

Constructor and Description
DDMFormField()
DDMFormField(DDMFormField ddmFormField)
DDMFormField(java.lang.String name, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
void	addDDMFormFieldRule(DDMFormFieldRule ddmFormFieldRule) Deprecated. As of Judson (7.1.x), with no direct replacement
void	addNestedDDMFormField(DDMFormField nestedDDMFormField)
boolean	equals(java.lang.Object object)
java.lang.String	getDataSourceType()
java.lang.String	getDataType()
DDMForm	getDDMForm()
DDMFormFieldOptions	getDDMFormFieldOptions()
DDMFormFieldValidation	getDDMFormFieldValidation()
DDMFormLayout	getDDMFormLayout()
java.lang.String	getFieldNamespace()
java.lang.String	getFieldReference()
java.lang.String	getIndexType()
LocalizedValue	getLabel()
java.lang.String	getName()
java.util.List<DDMFormField>	getNestedDDMFormFields()
java.util.Map<java.lang.String,DDMFormField>	getNestedDDMFormFieldsMap()
java.util.Map<java.lang.String,DDMFormField>	getNestedDDMFormFieldsReferencesMap()
java.util.Map<java.lang.String,DDMFormField>	getNontransientNestedDDMFormFieldsMap()
java.util.Map<java.lang.String,DDMFormField>	getNontransientNestedDDMFormFieldsReferencesMap()
LocalizedValue	getPredefinedValue()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(java.lang.String name)
LocalizedValue	getRequiredErrorMessage()
LocalizedValue	getStyle()
LocalizedValue	getTip()
java.lang.String	getType()
java.lang.String	getVisibilityExpression()
int	hashCode()
boolean	hasProperty(java.lang.String propertyKey)
boolean	isLocalizable()
boolean	isMultiple()
boolean	isReadOnly()
boolean	isRepeatable()
boolean	isRequired()
boolean	isShowLabel()
boolean	isTransient() This method returns true if the DDMFormField is not supposed to hold value/data, i.e.
boolean	isVisualProperty() Gets the value of the property visualProperty.
void	removeProperty(java.lang.String propertyKey)
void	setDataType(java.lang.String dataType)
void	setDDMForm(DDMForm ddmForm)
void	setDDMFormFieldOptions(DDMFormFieldOptions ddmFormFieldOptions)
void	setDDMFormFieldValidation(DDMFormFieldValidation ddmFormFieldValidation)
void	setDDMFormLayout(DDMFormLayout ddmFormLayout)
void	setFieldNamespace(java.lang.String fieldNamespace)
void	setFieldReference(java.lang.String fieldReference)
void	setIndexType(java.lang.String indexType)
void	setLabel(LocalizedValue label)
void	setLocalizable(boolean localizable)
void	setMultiple(boolean multiple)
void	setName(java.lang.String name)
void	setNestedDDMFormFields(java.util.List<DDMFormField> nestedDDMFormFields)
void	setPredefinedValue(LocalizedValue predefinedValue)
void	setProperty(java.lang.String name, java.lang.Object value)
void	setReadOnly(boolean readOnly)
void	setRepeatable(boolean repeatable)
void	setRequired(boolean required)
void	setRequiredErrorMessage(LocalizedValue requiredErrorMessage)
void	setShowLabel(boolean showLabel)
void	setStyle(LocalizedValue style)
void	setTip(LocalizedValue tip)
void	setType(java.lang.String type)
void	setVisibilityExpression(java.lang.String visibilityExpression)
void	setVisualProperty(boolean visualProperty)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Property Detail

isVisual

public boolean isVisualProperty

Gets the value of the property visualProperty.

Constructor Detail

DDMFormField

public DDMFormField()

DDMFormField

public DDMFormField(DDMFormField ddmFormField)

DDMFormField

public DDMFormField(java.lang.String name,
                    java.lang.String type)

Method Detail

addDDMFormFieldRule

@Deprecated
public void addDDMFormFieldRule(DDMFormFieldRule ddmFormFieldRule)

Deprecated. As of Judson (7.1.x), with no direct replacement

addNestedDDMFormField

public void addNestedDDMFormField(DDMFormField nestedDDMFormField)

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

getDataSourceType

public java.lang.String getDataSourceType()

getDataType

public java.lang.String getDataType()

getDDMForm

public DDMForm getDDMForm()

getDDMFormFieldOptions

public DDMFormFieldOptions getDDMFormFieldOptions()

getDDMFormFieldValidation

public DDMFormFieldValidation getDDMFormFieldValidation()

getDDMFormLayout

public DDMFormLayout getDDMFormLayout()

getFieldNamespace

public java.lang.String getFieldNamespace()

getFieldReference

public java.lang.String getFieldReference()

getIndexType

public java.lang.String getIndexType()

getLabel

public LocalizedValue getLabel()

getName

public java.lang.String getName()

getNestedDDMFormFields

public java.util.List<DDMFormField> getNestedDDMFormFields()

getNestedDDMFormFieldsMap

public java.util.Map<java.lang.String,DDMFormField> getNestedDDMFormFieldsMap()

getNestedDDMFormFieldsReferencesMap

public java.util.Map<java.lang.String,DDMFormField> getNestedDDMFormFieldsReferencesMap()

getNontransientNestedDDMFormFieldsMap

public java.util.Map<java.lang.String,DDMFormField> getNontransientNestedDDMFormFieldsMap()

getNontransientNestedDDMFormFieldsReferencesMap

public java.util.Map<java.lang.String,DDMFormField> getNontransientNestedDDMFormFieldsReferencesMap()

getPredefinedValue

public LocalizedValue getPredefinedValue()

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

getProperty

public java.lang.Object getProperty(java.lang.String name)

getRequiredErrorMessage

public LocalizedValue getRequiredErrorMessage()

getStyle

public LocalizedValue getStyle()

getTip

public LocalizedValue getTip()

getType

public java.lang.String getType()

getVisibilityExpression

public java.lang.String getVisibilityExpression()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasProperty

public boolean hasProperty(java.lang.String propertyKey)

isLocalizable

public boolean isLocalizable()

isMultiple

public boolean isMultiple()

isReadOnly

public boolean isReadOnly()

isRepeatable

public boolean isRepeatable()

isRequired

public boolean isRequired()

isShowLabel

public boolean isShowLabel()

isTransient

public boolean isTransient()

This method returns true if the DDMFormField is not supposed to hold value/data, i.e. its "dataType" property is blank or null. Transient fields can be considered structural fields like Liferay's native separator or fieldset fields.

Returns:

boolean

isVisualProperty

public boolean isVisualProperty()

Gets the value of the property visualProperty.

removeProperty

public void removeProperty(java.lang.String propertyKey)

setDataType

public void setDataType(java.lang.String dataType)

setDDMForm

public void setDDMForm(DDMForm ddmForm)

setDDMFormFieldOptions

public void setDDMFormFieldOptions(DDMFormFieldOptions ddmFormFieldOptions)

setDDMFormFieldValidation

public void setDDMFormFieldValidation(DDMFormFieldValidation ddmFormFieldValidation)

setDDMFormLayout

public void setDDMFormLayout(DDMFormLayout ddmFormLayout)

setFieldNamespace

public void setFieldNamespace(java.lang.String fieldNamespace)

setFieldReference

public void setFieldReference(java.lang.String fieldReference)

setIndexType

public void setIndexType(java.lang.String indexType)

setLabel

public void setLabel(LocalizedValue label)

setLocalizable

public void setLocalizable(boolean localizable)

setMultiple

public void setMultiple(boolean multiple)

setName

public void setName(java.lang.String name)

setNestedDDMFormFields

public void setNestedDDMFormFields(java.util.List<DDMFormField> nestedDDMFormFields)

setPredefinedValue

public void setPredefinedValue(LocalizedValue predefinedValue)

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

setReadOnly

public void setReadOnly(boolean readOnly)

setRepeatable

public void setRepeatable(boolean repeatable)

setRequired

public void setRequired(boolean required)

setRequiredErrorMessage

public void setRequiredErrorMessage(LocalizedValue requiredErrorMessage)

setShowLabel

public void setShowLabel(boolean showLabel)

setStyle

public void setStyle(LocalizedValue style)

setTip

public void setTip(LocalizedValue tip)

setType

public void setType(java.lang.String type)

setVisibilityExpression

public void setVisibilityExpression(java.lang.String visibilityExpression)

setVisualProperty

public void setVisualProperty(boolean visualProperty)