Package ch.tocco.nice2.model.form.impl.form2.builder

Class FormBuilderImpl

java.lang.Object

ch.tocco.nice2.model.form.impl.form2.builder.AbstractLayoutContainerBuilder<FormImpl>

ch.tocco.nice2.model.form.impl.form2.builder.FormBuilderImpl

All Implemented Interfaces:

FormBuilder, LayoutContainerBuilder

public class FormBuilderImpl
extends AbstractLayoutContainerBuilder<FormImpl>
implements FormBuilder

Field Summary

Fields inherited from class ch.tocco.nice2.model.form.impl.form2.builder.AbstractLayoutContainerBuilder

component

Constructor Summary

Constructors

Constructor	Description
FormBuilderImpl(FormImpl form)

Method Summary

Modifier and Type	Method	Description
ActionBuilder	addAction(String id, @Nullable String position)
ActionGroupBuilder	addActionGroup(String id, String label, @Nullable String position)	add a action group
ReportBuilder	addReport(String id, @Nullable String position)
Optional<Component>	findById(String componentId)	looks for a child with the given id in the form (recursively).
Form	get()	returns the form component.
@Nullable ActionGroupBuilder	getActionGroupBuilder(ActionGroup actionGroup)	get a builder for a given ActionGroup
List<Component>	getChildren()
EntityModel	getEntityModel()
String	getFormId()
@Nullable LayoutBuilder	getLayoutBuilder(Layout layout)
ActionBar	getOrCreateMainActionBar()	get or create the main action bar at the top of the form that contains the major action groups and actions.
Form	getWithoutProcessing()	returns the form component as opposed to FormBuilder.get(), this does not validate or process the contents of the form do not use the result of this method as a final form, but only as a carrier for form data
boolean	hasCopyAction()
boolean	hasExportAction()
boolean	hasGenericActions()
boolean	hasGenericLabelAction()
boolean	hasImportAction()
boolean	hasMergeAction()
boolean	hasOutputJobAction()
boolean	isAppendDefaultActions()
boolean	isAppendMassMutationActions()
boolean	isMarkable()
boolean	isReadOnly()
boolean	isReplaced()
FormBuilder	markable(boolean markable)
FormBuilder	readOnly(boolean readOnly)
void	removeComponent(Component component)
void	removeComponents(Predicate<Component> componentPredicate)	remove all components (recursively) which returns the given predicate `true` for.
void	sort()	sort the component represented by this builder

Methods inherited from class ch.tocco.nice2.model.form.impl.form2.builder.AbstractLayoutContainerBuilder

addLayout, addTable

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.builder.FormBuilder

addAction, addActionGroup, addReport

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.builder.LayoutContainerBuilder

addLayout, addLayout, addTable, addTable

Constructor Details

FormBuilderImpl

public FormBuilderImpl(FormImpl form)

Method Details

getFormId

public String getFormId()

Specified by:

getFormId in interface FormBuilder

getEntityModel

public EntityModel getEntityModel()

Specified by:

getEntityModel in interface FormBuilder

isReplaced

public boolean isReplaced()

Specified by:

isReplaced in interface FormBuilder

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface FormBuilder

isAppendDefaultActions

public boolean isAppendDefaultActions()

Specified by:

isAppendDefaultActions in interface FormBuilder

isAppendMassMutationActions

public boolean isAppendMassMutationActions()

Specified by:

isAppendMassMutationActions in interface FormBuilder

hasOutputJobAction

public boolean hasOutputJobAction()

Specified by:

hasOutputJobAction in interface FormBuilder

hasMergeAction

public boolean hasMergeAction()

Specified by:

hasMergeAction in interface FormBuilder

hasGenericLabelAction

public boolean hasGenericLabelAction()

Specified by:

hasGenericLabelAction in interface FormBuilder

hasCopyAction

public boolean hasCopyAction()

Specified by:

hasCopyAction in interface FormBuilder

hasImportAction

public boolean hasImportAction()

Specified by:

hasImportAction in interface FormBuilder

hasExportAction

public boolean hasExportAction()

Specified by:

hasExportAction in interface FormBuilder

hasGenericActions

public boolean hasGenericActions()

Specified by:

hasGenericActions in interface FormBuilder

isMarkable

public boolean isMarkable()

Specified by:

isMarkable in interface FormBuilder

markable

public FormBuilder markable(boolean markable)

Specified by:

markable in interface FormBuilder

readOnly

public FormBuilder readOnly(boolean readOnly)

Specified by:

readOnly in interface FormBuilder

getChildren

public List<Component> getChildren()

Specified by:

getChildren in interface FormBuilder

getLayoutBuilder

@Nullable
public @Nullable LayoutBuilder getLayoutBuilder(Layout layout)

Specified by:

getLayoutBuilder in interface FormBuilder

addAction

public ActionBuilder addAction(String id,
 @Nullable
 @Nullable String position)

Specified by:

addAction in interface FormBuilder

removeComponent

public void removeComponent(Component component)

Specified by:

removeComponent in interface FormBuilder

addReport

public ReportBuilder addReport(String id,
 @Nullable
 @Nullable String position)

Specified by:

addReport in interface FormBuilder

addActionGroup

public ActionGroupBuilder addActionGroup(String id,
 String label,
 @Nullable
 @Nullable String position)

Description copied from interface: FormBuilder

add a action group

Specified by:

addActionGroup in interface FormBuilder

Parameters:

id - id of the action group

label - label of the action group

position - relative position of the action group

Returns:

the builder of the newly created action group

getActionGroupBuilder

@Nullable
public @Nullable ActionGroupBuilder getActionGroupBuilder(ActionGroup actionGroup)

Description copied from interface: FormBuilder

get a builder for a given ActionGroup

Specified by:

getActionGroupBuilder in interface FormBuilder

Parameters:

actionGroup - the action group to use

Returns:

the builder

getOrCreateMainActionBar

public ActionBar getOrCreateMainActionBar()

Description copied from interface: FormBuilder

get or create the main action bar at the top of the form that contains the major action groups and actions.

Specified by:

getOrCreateMainActionBar in interface FormBuilder

Returns:

the existing main action bar or the newly created one.

sort

public void sort()
          throws ModelBuildException

Description copied from interface: FormBuilder

sort the component represented by this builder

Specified by:

sort in interface FormBuilder

Throws:

ModelBuildException

get

public Form get()
         throws ModelBuildException

Description copied from interface: FormBuilder

returns the form component. note: for performance reasons this method should be called only once at the end when the form is built completely, because it also validates all components and does some other final modifications.

Specified by:

get in interface FormBuilder

Returns:

the form component

Throws:

ModelBuildException

getWithoutProcessing

public Form getWithoutProcessing()

Description copied from interface: FormBuilder

returns the form component as opposed to FormBuilder.get(), this does not validate or process the contents of the form do not use the result of this method as a final form, but only as a carrier for form data

Specified by:

getWithoutProcessing in interface FormBuilder

Returns:

the form component

findById

public Optional<Component> findById(String componentId)

Description copied from interface: FormBuilder

looks for a child with the given id in the form (recursively).

Specified by:

findById in interface FormBuilder

removeComponents

public void removeComponents(Predicate<Component> componentPredicate)

Description copied from interface: FormBuilder

remove all components (recursively) which returns the given predicate `true` for.

Specified by:

removeComponents in interface FormBuilder