com.qcadoo.view.api.components

Interface FormComponent

All Superinterfaces:

ComponentMessagesHolder, ComponentState

public interface FormComponent
extends ComponentState

Represents form component

Since:

0.4.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.qcadoo.view.api.ComponentState

ComponentState.MessageType

Method Summary

Modifier and Type	Method and Description
FieldComponent	findFieldComponentByName(String name) Returns child field component with specified name (first occurence) or null if no such component found
Entity	getEntity() Returns entity filled with this forms values
Long	getEntityId() Gets id of this form entity
Entity	getPersistedEntityWithIncludedFormValues() Returns entity from database updated with this form values.
boolean	isValid() Checks if all fields of this form and entity itself are valid
void	setEntity(Entity entity) Set Entity which be used to fill this form
void	setFormEnabled(boolean enabled) Enables or disables this form and all its inner components

Methods inherited from interface com.qcadoo.view.api.ComponentState

getFieldValue, getLocale, getName, getUuid, isEnabled, isHasError, isVisible, performEvent, setEnabled, setFieldValue, setVisible

Methods inherited from interface com.qcadoo.view.api.ComponentMessagesHolder

addMessage, addMessage, addMessage, addMessage, addMessage, addTranslatedMessage, addTranslatedMessage, addTranslatedMessage

Method Detail

findFieldComponentByName

FieldComponent findFieldComponentByName(String name)

Returns child field component with specified name (first occurence) or null if no such component found

Parameters:

name - name of component

Returns:

field component with specified name

getEntity

Entity getEntity()

Returns entity filled with this forms values

Returns:

entity filled with this forms values

getEntityId

Long getEntityId()

Gets id of this form entity

Returns:

id of entity

getPersistedEntityWithIncludedFormValues

Entity getPersistedEntityWithIncludedFormValues()

Returns entity from database updated with this form values. If persisted entity doesn't exist (for example during creation) then this method will behave exactly like FormComponent#getEntity. Otherwise persisted entity will be fetched and updated with this form children components values.

Returns:

persisted entity with this forms values included

Since:

1.2.1

isValid

boolean isValid()

Checks if all fields of this form and entity itself are valid

Returns:

false when at least one field is not valid, true otherwise

setEntity

void setEntity(Entity entity)

Set Entity which be used to fill this form

Parameters:

entity - entity which be used to fill form

Since:

1.1.5

setFormEnabled

void setFormEnabled(boolean enabled)

Enables or disables this form and all its inner components

Parameters:

enabled - true if this form and all its inner components should be enabled, false if disabled