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

Interface FormBuilder

All Superinterfaces:

LayoutContainerBuilder

All Known Implementing Classes:

FormBuilderImpl

public interface FormBuilder
extends LayoutContainerBuilder

A builder to dynamically create Form instances.

Method Summary

Modifier and Type	Method	Description
default ActionBuilder	addAction(String id)
ActionBuilder	addAction(String id, @Nullable String position)
default ActionGroupBuilder	addActionGroup(String id, String label)	add an action group with default position
ActionGroupBuilder	addActionGroup(String id, String label, @Nullable String position)	add a action group
default ReportBuilder	addReport(String id)
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 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 interface ch.tocco.nice2.model.form.api.form2.builder.LayoutContainerBuilder

addLayout, addLayout, addTable, addTable

Method Details

getFormId

String getFormId()

getEntityModel

EntityModel getEntityModel()

isReplaced

boolean isReplaced()

isReadOnly

boolean isReadOnly()

isAppendDefaultActions

boolean isAppendDefaultActions()

isAppendMassMutationActions

boolean isAppendMassMutationActions()

hasOutputJobAction

boolean hasOutputJobAction()

hasMergeAction

boolean hasMergeAction()

hasGenericLabelAction

boolean hasGenericLabelAction()

hasCopyAction

boolean hasCopyAction()

hasImportAction

boolean hasImportAction()

hasExportAction

boolean hasExportAction()

hasGenericActions

boolean hasGenericActions()

isMarkable

boolean isMarkable()

markable

FormBuilder markable(boolean markable)

readOnly

FormBuilder readOnly(boolean readOnly)

getChildren

List<Component> getChildren()

getLayoutBuilder

@Nullable
@Nullable LayoutBuilder getLayoutBuilder(Layout layout)

removeComponent

void removeComponent(Component component)

addAction

default ActionBuilder addAction(String id)

addAction

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

addReport

default ReportBuilder addReport(String id)

addReport

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

addActionGroup

default ActionGroupBuilder addActionGroup(String id,
 String label)

add an action group with default position

Parameters:

id - id of the action group

label - label of the action group

Returns:

the builder of the newly created action group

addActionGroup

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

add a action group

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
@Nullable ActionGroupBuilder getActionGroupBuilder(ActionGroup actionGroup)

get a builder for a given ActionGroup

Parameters:

actionGroup - the action group to use

Returns:

the builder

getOrCreateMainActionBar

ActionBar getOrCreateMainActionBar()

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

Returns:

the existing main action bar or the newly created one.

sort

void sort()
   throws ModelBuildException

sort the component represented by this builder

Throws:

ModelBuildException

get

Form get()
  throws ModelBuildException

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.

Returns:

the form component

Throws:

ModelBuildException

getWithoutProcessing

Form getWithoutProcessing()

returns the form component as opposed to 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

Returns:

the form component

removeComponents

void removeComponents(Predicate<Component> componentPredicate)

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

findById

Optional<Component> findById(String componentId)

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