org.jboss.hal.ballroom.form

Class AbstractForm<T>

java.lang.Object

org.jboss.gwt.elemento.core.LazyElement

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

All Implemented Interfaces:

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

public abstract class AbstractForm<T>
extends org.jboss.gwt.elemento.core.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

Field Summary

Fields

Modifier and Type	Field and Description
protected Form.CancelCallback<T>	cancelCallback
protected FormLinks<T>	formLinks
protected Form.PrepareRemove<T>	prepareRemove
protected Form.PrepareReset<T>	prepareReset
protected Form.SaveCallback<T>	saveCallback

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addFormItem(FormItem formItem, FormItem... formItems)
void	addFormValidation(FormValidation<T> formValidation) Makes it possible to validate the form as a whole or to check fields which depend on other fields.
protected void	addHelp(String label, com.google.gwt.safehtml.shared.SafeHtml description)
void	attach()
void	cancel() Executes the Operation#CANCEL operation and calls the registered cancel callback (if any).
void	clear() Removes the model reference, executes the Operation#CLEAR operation and calls DataMapping.clearFormItems(Form).
protected elemental2.dom.HTMLElement	createElement()
void	detach()
void	edit(T model) Executes the Operation#EDIT operation and calls DataMapping.newModel(Object, Form) if the model is transitive otherwise DataMapping.populateFormItems(Object, Form).
protected void	flip(Form.State state)
Iterable<FormItem>	getBoundFormItems()
protected Map<String,Object>	getChangedValues()
<I> FormItem<I>	getFormItem(String name)
Iterable<FormItem>	getFormItems()
String	getId()
T	getModel()
StateMachine	getStateMachine()
protected void	markAsUnbound(String name)
protected void	prepare(Form.State state)
protected void	prepareEditState() Gives subclasses a way to prepare the edit state.
protected void	prepareEmptyState() Gives subclasses a way to prepare the empty state.
protected void	prepareViewState() Gives subclasses a way to prepare the view state.
void	remove() Removes the model reference and executes the Operation#REMOVE operation.
void	reset() Executes the Operation#RESET operation.
boolean	save() Upon successful validation, executes the Operation#SAVE operation, calls DataMapping.persistModel(Object, Form) and finally calls the registered save callback (if any).
protected void	separateOptionalFields(boolean separateOptionalFields)
void	setCancelCallback(Form.CancelCallback<T> cancelCallback)
void	setPrepareRemove(Form.PrepareRemove<T> removeCallback)
void	setPrepareReset(Form.PrepareReset<T> prepareReset)
void	setSaveCallback(Form.SaveCallback<T> saveCallback)
protected boolean	validate()
void	view(T model) Executes the Operation#VIEW operation and calls DataMapping.populateFormItems(Object, Form) if the form is not undefined.

Methods inherited from class org.jboss.gwt.elemento.core.LazyElement

asElement, initialized

Methods inherited from class java.lang.Object

clone, equals, finalize, 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.gwt.elemento.core.IsElement

asElement

Field Detail

formLinks

protected FormLinks<T> formLinks

saveCallback

protected Form.SaveCallback<T> saveCallback

cancelCallback

protected Form.CancelCallback<T> cancelCallback

prepareReset

protected Form.PrepareReset<T> prepareReset

prepareRemove

protected Form.PrepareRemove<T> prepareRemove

Constructor Detail

AbstractForm

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

Method Detail

addFormItem

protected void addFormItem(FormItem formItem,
                           FormItem... formItems)

separateOptionalFields

protected void separateOptionalFields(boolean separateOptionalFields)

markAsUnbound

protected void markAsUnbound(String name)

addHelp

protected void addHelp(String label,
                       com.google.gwt.safehtml.shared.SafeHtml description)

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>

createElement

protected elemental2.dom.HTMLElement createElement()

Specified by:

createElement in class org.jboss.gwt.elemento.core.LazyElement

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 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 Operation#CLEAR operation and calls DataMapping.clearFormItems(Form).

Specified by:

clear in interface Form<T>

edit

public final void edit(T model)

Executes the 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 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>

getChangedValues

protected Map<String,Object> getChangedValues()

cancel

public final void cancel()

Executes the 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 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 Operation#REMOVE operation.

Specified by:

remove in interface Form<T>

prepare

protected void prepare(Form.State state)

prepareEmptyState

protected void prepareEmptyState()

Gives subclasses a way to prepare the empty state. Called after the state has changed, but before the UI flips to the new state.

prepareViewState

protected void prepareViewState()

Gives subclasses a way to prepare the view state. Called after the state has changed, but before the UI flips to the new state.

prepareEditState

protected void prepareEditState()

Gives subclasses a way to prepare the edit state. Called after the state has changed, but before the UI flips to the new state.

flip

protected void flip(Form.State state)

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.

validate

protected boolean validate()