Package org.jboss.hal.ballroom.form

Class AbstractForm<T>

java.lang.Object

org.jboss.elemento.LazyElement

org.jboss.hal.ballroom.form.AbstractForm<T>

All Implemented Interfaces:

org.jboss.elemento.IsElement, Attachable, Form<T>

public abstract class AbstractForm<T>
extends org.jboss.elemento.LazyElement
implements Form<T>

A generic form with some reasonable UI defaults. Please note that all form items and help texts must be setup before this form is added as an element to the DOM.

The form consists of links and three sections:

• empty
• read-only
• editing

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.hal.ballroom.form.Form

Form.CancelCallback<T>, Form.FinishRemove<T>, Form.FinishReset<T>, Form.Operation, Form.PrepareRemove<T>, Form.PrepareReset<T>, Form.SaveCallback<T>, Form.State

Constructor Summary

Constructors

Constructor	Description
AbstractForm(String id, StateMachine stateMachine, DataMapping<T> dataMapping, EmptyState emptyState)

Method Summary

Modifier and Type	Method	Description
void	addFormValidation(FormValidation<T> formValidation)	Makes it possible to validate the form as a whole or to check fields which depend on other fields.
void	attach()
void	cancel()	Executes the Form.Operation.CANCEL operation and calls the registered cancel callback (if any).
void	clear()	Removes the model reference, executes the Form.Operation.CLEAR operation and calls DataMapping.clearFormItems(Form).
void	detach()
void	edit(T model)	Executes the Form.Operation.EDIT operation and calls DataMapping.newModel(Object, Form) if the model is transitive otherwise DataMapping.populateFormItems(Object, Form).
Iterable<FormItem>	getBoundFormItems()
<I> FormItem<I>	getFormItem(String name)
Iterable<FormItem>	getFormItems()
String	getId()
T	getModel()
StateMachine	getStateMachine()
void	remove()	Removes the model reference and executes the Form.Operation.REMOVE operation.
void	reset()	Executes the Form.Operation.RESET operation.
boolean	save()	Upon successful validation, executes the Form.Operation.SAVE operation, calls DataMapping.persistModel(Object, Form) and finally calls the registered save callback (if any).
void	setCancelCallback(Form.CancelCallback<T> cancelCallback)
void	setPrepareRemove(Form.PrepareRemove<T> removeCallback)
void	setPrepareReset(Form.PrepareReset<T> prepareReset)
void	setSaveCallback(Form.SaveCallback<T> saveCallback)
void	view(T model)	Executes the Form.Operation.VIEW operation and calls DataMapping.populateFormItems(Object, Form) if the form is not undefined.

Methods inherited from class org.jboss.elemento.LazyElement

element

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.hal.ballroom.form.Form

isTransient, isUndefined

Methods inherited from interface org.jboss.elemento.IsElement

element

Constructor Detail

AbstractForm

public AbstractForm(String id,
                    StateMachine stateMachine,
                    DataMapping<T> dataMapping,
                    EmptyState emptyState)

Method Detail

addFormValidation

public void addFormValidation(FormValidation<T> formValidation)

Description copied from interface: Form

Makes it possible to validate the form as a whole or to check fields which depend on other fields.

Specified by:

addFormValidation in interface Form<T>

attach

public void attach()

Specified by:

attach in interface Attachable

detach

public void detach()

Specified by:

detach in interface Attachable

view

public final void view(T model)

Executes the Form.Operation.VIEW operation and calls DataMapping.populateFormItems(Object, Form) if the form is not undefined.

Specified by:

view in interface Form<T>

Parameters:

model - the model to view.

clear

public void clear()

Removes the model reference, executes the Form.Operation.CLEAR operation and calls DataMapping.clearFormItems(Form).

Specified by:

clear in interface Form<T>

edit

public final void edit(T model)

Executes the Form.Operation.EDIT operation and calls DataMapping.newModel(Object, Form) if the model is transitive otherwise DataMapping.populateFormItems(Object, Form).

Specified by:

edit in interface Form<T>

Parameters:

model - the model to edit.

save

public final boolean save()

Upon successful validation, executes the Form.Operation.SAVE operation, calls DataMapping.persistModel(Object, Form) and finally calls the registered save callback (if any).

Specified by:

save in interface Form<T>

setSaveCallback

public void setSaveCallback(Form.SaveCallback<T> saveCallback)

Specified by:

setSaveCallback in interface Form<T>

cancel

public final void cancel()

Executes the Form.Operation.CANCEL operation and calls the registered cancel callback (if any).

Specified by:

cancel in interface Form<T>

setCancelCallback

public void setCancelCallback(Form.CancelCallback<T> cancelCallback)

Specified by:

setCancelCallback in interface Form<T>

setPrepareReset

public void setPrepareReset(Form.PrepareReset<T> prepareReset)

Specified by:

setPrepareReset in interface Form<T>

reset

public final void reset()

Executes the Form.Operation.RESET operation.

Specified by:

reset in interface Form<T>

setPrepareRemove

public void setPrepareRemove(Form.PrepareRemove<T> removeCallback)

Specified by:

setPrepareRemove in interface Form<T>

remove

public void remove()

Removes the model reference and executes the Form.Operation.REMOVE operation.

Specified by:

remove in interface Form<T>

getId

public String getId()

Specified by:

getId in interface Form<T>

Returns:

an unique identifier for this form.

getModel

public T getModel()

Specified by:

getModel in interface Form<T>

Returns:

the current model.

getStateMachine

public StateMachine getStateMachine()

Specified by:

getStateMachine in interface Form<T>

Returns:

the state machine which access to the current state.

getFormItem

public <I> FormItem<I> getFormItem(String name)

Specified by:

getFormItem in interface Form<T>

getBoundFormItems

public Iterable<FormItem> getBoundFormItems()

Specified by:

getBoundFormItems in interface Form<T>

Returns:

only those form items which are bound to the model.

getFormItems

public Iterable<FormItem> getFormItems()

Specified by:

getFormItems in interface Form<T>

Returns:

return all form items.