net.datenwerke.gxtdto.client.forms.simpleform

Class SimpleForm

java.lang.Object

ContentPanel

net.datenwerke.gxtdto.client.baseex.widget.DwContentPanel

net.datenwerke.gxtdto.client.forms.simpleform.SimpleForm

Direct Known Subclasses:

SimpleMultiForm

public class SimpleForm
extends DwContentPanel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SimpleForm.SField

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CSS_NAME

Fields inherited from class net.datenwerke.gxtdto.client.baseex.widget.DwContentPanel

CSS_BODY_NAME, CSS_CONTENT_NAME, CSS_HEADER_NAME, CSS_LIGHT_DARK, CSS_LIGHT_HEADER

Constructor Summary

Constructors

Constructor and Description
SimpleForm()

Method Summary

Modifier and Type	Method and Description
void	addButton(Widget widget)
void	addCondition(SimpleFormAction action, ComplexCondition... conditions) Adds a complex condition to the form.
void	addCondition(java.lang.String fieldKey, SimpleFormCondition condition, SimpleFormAction action) Adds a simple condition to the form.
void	addDependency(java.lang.String dependant, java.lang.String dependsOn) Triggers a reload whenever the selection of dependsOn changes.
java.lang.String	addField(java.lang.Class<?> type, SimpleFormFieldConfiguration... configs)
java.lang.String	addField(java.lang.Class<?> type, java.lang.String name, FormFieldLayoutConfiguration fieldLayoutConfig, java.lang.Object value, ValueProvider vp, SimpleFormFieldConfiguration... configs) Adds a new field to the form.
java.lang.String	addField(java.lang.Class<?> type, java.lang.String label, SimpleFormFieldConfiguration... configs)
java.lang.String	addField(java.lang.Class<?> type, ValueProvider vp, SimpleFormFieldConfiguration... configs)
java.lang.String	addField(java.lang.Class<?> type, ValueProvider vp, java.lang.String label, java.lang.Object value, SimpleFormFieldConfiguration... configs)
java.lang.String	addField(java.lang.Class<?> type, ValueProvider vp, java.lang.String label, SimpleFormFieldConfiguration... configs)
java.lang.String	addField(FormFieldProviderHook responsibleHook, java.lang.String name, FormFieldLayoutConfiguration fieldLayoutConfig, java.lang.Object value, ValueProvider vp)
void	addFieldDecorator(SimpleFormFieldDecorator fieldDecorator)
void	addFieldInfo(java.lang.String key, FieldInfoDecorator.DelayedInfoMessage data)
void	addFieldInfo(java.lang.String key, java.lang.String data)
void	addFieldMenu(java.lang.String key, Menu menu)
<D> void	addHidden(java.lang.String name, D value)
void	addSubmissionCallback(SimpleFormSubmissionCallback cb)
void	addSubmissionListener(SimpleFormSubmissionListener submissionListener)
DwTextButton	addSubmitButton()
DwTextButton	addSubmitButton(java.lang.String txt)
HandlerRegistration	addSubmitCompleteHandler(SubmitCompleteHandler handler)
HandlerRegistration	addValueChangeHandler(java.lang.String key, ValueChangeHandler handler)
void	beginColumn()
void	beginColumn(double width, double height)
void	beginColumn(double width, double height, MarginData marginData)
void	beginColumn(double width, MarginData marginData)
void	beginColumn(MarginData marginData)
void	beginFieldset(double width, double height, java.lang.String label, MarginData marginData)
void	beginFieldset(java.lang.String label) Starts a new field group
void	beginFloatRow()
void	beginFloatRow(double width, double height)
void	beginFloatRow(double width, double height, MarginData marginData)
void	beginFloatRow(MarginData marginData)
void	beginRow()
void	beginRow(double width, double height)
void	beginRow(double width, double height, MarginData marginData)
void	beginRow(MarginData marginData)
void	bind(java.lang.Object model) Allows to issue a form binding
void	clearButtonBar()
void	clearInvalid()
static Widget	createFormlessField(java.lang.Class<?> type, SimpleFormFieldConfiguration... configs)
void	endColumn()
void	endGroup() Ends the current group.
void	endRow()
static SimpleForm	fromJson(SimpleFormJsonConfig config)
static SimpleForm	fromJson(java.lang.String formConfig)
java.util.List<SimpleForm.SField>	getAllSFields()
java.lang.Object	getBoundModel()
ButtonBar	getButtonBar()
SimpleFormSubmissionCallback	getCompositeSubmissionCallback()
java.lang.String	getCssName()
Widget	getDisplayedField(java.lang.String fieldKey)
Widget	getField(java.lang.String fieldKey) Returns the field identified by fieldKey.
<T extends SimpleFormFieldDecorator> T	getFieldDecorator(java.lang.Class<? extends T> type, java.lang.String id)
SimpleFormFieldDecorator	getFieldDecorator(java.lang.String id)
java.util.List<SimpleFormFieldDecorator>	getFieldDecorators()
java.util.Collection<java.lang.String>	getFieldKeys()
FormFieldLayoutConfiguration	getFieldLayoutConfigFor(java.lang.String key)
java.lang.Class<?>	getFieldType(java.lang.String fieldKey)
Container	getFieldWrapper()
FormPanel	getFormPanel()
static SimpleForm	getInlineInstance()
static SimpleForm	getInlineLabelessInstance()
static SimpleForm	getNewInstance()
Widget	getOldWidget()
FormFieldProviderHook	getResponsibleHook(java.lang.String fieldKey)
static FormFieldProviderHook	getResponsibleHooker(java.lang.Class<?> type, SimpleFormFieldConfiguration... configs)
static FormFieldProviderHook	getResponsibleHooker(java.lang.String type, SimpleFormFieldJson config)
SimpleForm.SField	getSField(java.lang.String key)
java.lang.String	getStringValue(java.lang.String fieldKey)
java.util.Map<java.lang.String,java.lang.String>	getStringValueMap()
java.util.List<SimpleFormSubmissionCallback>	getSubmissionCallbacks()
DwTextButton	getSubmitButton()
java.lang.Object	getValue(java.lang.String fieldKey)
boolean	isBindingActive()
boolean	isField(java.lang.String key)
boolean	isFieldsLoaded()
boolean	isLoadFieldsOnBinding()
boolean	isValid()
boolean	isValidateOnSubmit()
void	loadFields() Load all fields.
void	reloadField(java.lang.String fieldKey) Reloads the field
void	setAction(java.lang.String action)
void	setAutoHeight()
void	setDiscardLabels(boolean b)
void	setEncoding(Encoding encoding)
void	setFieldDecorators(java.util.List<SimpleFormFieldDecorator> fieldDecorators)
void	setFieldHeight(double height)
void	setFieldMarginData(MarginData marginData)
void	setFieldWidth(double width) Sets the width of all form fields added after this method has been called.
void	setFocusOnShow(boolean focusOnShow)
void	setHeight(int height)
void	setLabelAlign(LabelAlign al)
void	setLabelPad(int pad)
void	setLabelWidth(int i)
void	setLoadFieldsOnBinding(boolean isLoadFieldsOnBinding)
void	setMethod(Method method)
void	setOldWidget(Widget container)
void	setSize(int width, int height)
void	setValidateOnSubmit(boolean validateOnSubmit)
void	setValue(java.lang.String key, java.lang.Object value)
void	submit()
void	updateFormLayout()

Methods inherited from class net.datenwerke.gxtdto.client.baseex.widget.DwContentPanel

add, add, add, addClassName, enableScrollContainer, getCssBodyName, getCssContentName, getCssHeaderName, newAccordeonInstance, newHeadlessInstance, newHeadlessInstance, newHeadlessInstance, newInlineInstance, newInlineInstance, newInlineInstance, newLightHeaderPanel, setHeaderIcon, setInfoText, setLightDarkStyle, setLightHeader, setScrollMode, setUrl, setUrl, setWidget

Methods inherited from class java.lang.Object

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

Field Detail

CSS_NAME

@CssClassConstant
public static final java.lang.String CSS_NAME

See Also:

Constant Field Values

Constructor Detail

SimpleForm

public SimpleForm()

Method Detail

setAutoHeight

public void setAutoHeight()

getCssName

public java.lang.String getCssName()

Overrides:

getCssName in class DwContentPanel

getNewInstance

public static SimpleForm getNewInstance()

getInlineInstance

public static SimpleForm getInlineInstance()

getInlineLabelessInstance

public static SimpleForm getInlineLabelessInstance()

clearButtonBar

public void clearButtonBar()

createFormlessField

public static Widget createFormlessField(java.lang.Class<?> type,
                                         SimpleFormFieldConfiguration... configs)

getFieldWrapper

public Container getFieldWrapper()

setDiscardLabels

public void setDiscardLabels(boolean b)

setFieldMarginData

public void setFieldMarginData(MarginData marginData)

setFieldWidth

public void setFieldWidth(double width)

Sets the width of all form fields added after this method has been called.

Parameters:

width - the width of all fields added after this method call

setFieldHeight

public void setFieldHeight(double height)

setLabelAlign

public void setLabelAlign(LabelAlign al)

addSubmissionCallback

public void addSubmissionCallback(SimpleFormSubmissionCallback cb)

getSubmissionCallbacks

public java.util.List<SimpleFormSubmissionCallback> getSubmissionCallbacks()

getCompositeSubmissionCallback

public SimpleFormSubmissionCallback getCompositeSubmissionCallback()

getFieldDecorator

public SimpleFormFieldDecorator getFieldDecorator(java.lang.String id)

getFieldDecorator

public <T extends SimpleFormFieldDecorator> T getFieldDecorator(java.lang.Class<? extends T> type,
                                                                java.lang.String id)

addFieldDecorator

public void addFieldDecorator(SimpleFormFieldDecorator fieldDecorator)

setFieldDecorators

public void setFieldDecorators(java.util.List<SimpleFormFieldDecorator> fieldDecorators)

getFieldDecorators

public java.util.List<SimpleFormFieldDecorator> getFieldDecorators()

setLabelPad

public void setLabelPad(int pad)

setLabelWidth

public void setLabelWidth(int i)

getFormPanel

public FormPanel getFormPanel()

setFocusOnShow

public void setFocusOnShow(boolean focusOnShow)

addButton

public void addButton(Widget widget)

getButtonBar

public ButtonBar getButtonBar()

addSubmitButton

public DwTextButton addSubmitButton()

addSubmitButton

public DwTextButton addSubmitButton(java.lang.String txt)

getSubmitButton

public DwTextButton getSubmitButton()

addDependency

public void addDependency(java.lang.String dependant,
                          java.lang.String dependsOn)

Triggers a reload whenever the selection of dependsOn changes.

Parameters:

dependant -

dependsOn -

reloadField

public void reloadField(java.lang.String fieldKey)

Reloads the field

addCondition

public void addCondition(java.lang.String fieldKey,
                         SimpleFormCondition condition,
                         SimpleFormAction action)

Adds a simple condition to the form.

Parameters:

fieldKey -

condition -

action -

addCondition

public void addCondition(SimpleFormAction action,
                         ComplexCondition... conditions)

Adds a complex condition to the form.

Parameters:

action -

conditions -

addHidden

public <D> void addHidden(java.lang.String name,
                          D value)

beginColumn

public void beginColumn()

beginColumn

public void beginColumn(double width,
                        double height)

beginColumn

public void beginColumn(double width,
                        MarginData marginData)

beginColumn

public void beginColumn(MarginData marginData)

beginColumn

public void beginColumn(double width,
                        double height,
                        MarginData marginData)

endColumn

public void endColumn()

beginRow

public void beginRow()

beginRow

public void beginRow(double width,
                     double height)

beginRow

public void beginRow(MarginData marginData)

beginRow

public void beginRow(double width,
                     double height,
                     MarginData marginData)

beginFloatRow

public void beginFloatRow()

beginFloatRow

public void beginFloatRow(double width,
                          double height)

beginFloatRow

public void beginFloatRow(MarginData marginData)

beginFloatRow

public void beginFloatRow(double width,
                          double height,
                          MarginData marginData)

endRow

public void endRow()

beginFieldset

public void beginFieldset(java.lang.String label)

Starts a new field group

beginFieldset

public void beginFieldset(double width,
                          double height,
                          java.lang.String label,
                          MarginData marginData)

endGroup

public void endGroup()

Ends the current group.

If no group was previously started. method does nothing

addField

public java.lang.String addField(java.lang.Class<?> type,
                                 SimpleFormFieldConfiguration... configs)

addField

public java.lang.String addField(java.lang.Class<?> type,
                                 java.lang.String label,
                                 SimpleFormFieldConfiguration... configs)

addField

public java.lang.String addField(java.lang.Class<?> type,
                                 ValueProvider vp,
                                 SimpleFormFieldConfiguration... configs)

addField

public java.lang.String addField(java.lang.Class<?> type,
                                 ValueProvider vp,
                                 java.lang.String label,
                                 SimpleFormFieldConfiguration... configs)

addField

public java.lang.String addField(java.lang.Class<?> type,
                                 ValueProvider vp,
                                 java.lang.String label,
                                 java.lang.Object value,
                                 SimpleFormFieldConfiguration... configs)

addField

public java.lang.String addField(java.lang.Class<?> type,
                                 java.lang.String name,
                                 FormFieldLayoutConfiguration fieldLayoutConfig,
                                 java.lang.Object value,
                                 ValueProvider vp,
                                 SimpleFormFieldConfiguration... configs)

Adds a new field to the form.

addField

public java.lang.String addField(FormFieldProviderHook responsibleHook,
                                 java.lang.String name,
                                 FormFieldLayoutConfiguration fieldLayoutConfig,
                                 java.lang.Object value,
                                 ValueProvider vp)

getResponsibleHooker

public static FormFieldProviderHook getResponsibleHooker(java.lang.Class<?> type,
                                                         SimpleFormFieldConfiguration... configs)

addFieldMenu

public void addFieldMenu(java.lang.String key,
                         Menu menu)

addFieldInfo

public void addFieldInfo(java.lang.String key,
                         java.lang.String data)

addFieldInfo

public void addFieldInfo(java.lang.String key,
                         FieldInfoDecorator.DelayedInfoMessage data)

getFieldLayoutConfigFor

public FormFieldLayoutConfiguration getFieldLayoutConfigFor(java.lang.String key)

loadFields

public void loadFields()

Load all fields.

getField

public Widget getField(java.lang.String fieldKey)

Returns the field identified by fieldKey.

Parameters:

fieldKey -

getDisplayedField

public Widget getDisplayedField(java.lang.String fieldKey)

getFieldKeys

public java.util.Collection<java.lang.String> getFieldKeys()

getFieldType

public java.lang.Class<?> getFieldType(java.lang.String fieldKey)

getResponsibleHook

public FormFieldProviderHook getResponsibleHook(java.lang.String fieldKey)

getValue

public java.lang.Object getValue(java.lang.String fieldKey)

setValue

public void setValue(java.lang.String key,
                     java.lang.Object value)

getAllSFields

public java.util.List<SimpleForm.SField> getAllSFields()

getSField

public SimpleForm.SField getSField(java.lang.String key)

isField

public boolean isField(java.lang.String key)

bind

public void bind(java.lang.Object model)

Allows to issue a form binding

Parameters:

model -

getBoundModel

public java.lang.Object getBoundModel()

isBindingActive

public boolean isBindingActive()

addSubmissionListener

public void addSubmissionListener(SimpleFormSubmissionListener submissionListener)

isLoadFieldsOnBinding

public boolean isLoadFieldsOnBinding()

setLoadFieldsOnBinding

public void setLoadFieldsOnBinding(boolean isLoadFieldsOnBinding)

isFieldsLoaded

public boolean isFieldsLoaded()

isValid

public boolean isValid()

clearInvalid

public void clearInvalid()

setMethod

public void setMethod(Method method)

setEncoding

public void setEncoding(Encoding encoding)

setAction

public void setAction(java.lang.String action)

submit

public void submit()

addSubmitCompleteHandler

public HandlerRegistration addSubmitCompleteHandler(SubmitCompleteHandler handler)

setSize

public void setSize(int width,
                    int height)

setHeight

public void setHeight(int height)

addValueChangeHandler

public HandlerRegistration addValueChangeHandler(java.lang.String key,
                                                 ValueChangeHandler handler)

isValidateOnSubmit

public boolean isValidateOnSubmit()

setValidateOnSubmit

public void setValidateOnSubmit(boolean validateOnSubmit)

updateFormLayout

public void updateFormLayout()

setOldWidget

public void setOldWidget(Widget container)

getOldWidget

public Widget getOldWidget()

fromJson

public static SimpleForm fromJson(java.lang.String formConfig)

fromJson

public static SimpleForm fromJson(SimpleFormJsonConfig config)

getResponsibleHooker

public static FormFieldProviderHook getResponsibleHooker(java.lang.String type,
                                                         SimpleFormFieldJson config)

getStringValue

public java.lang.String getStringValue(java.lang.String fieldKey)

getStringValueMap

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