org.dominokit.domino.ui.utils

Class DominoUIConfig

java.lang.Object

org.dominokit.domino.ui.utils.DominoUIConfig

Direct Known Subclasses:

DominoFields

public class DominoUIConfig
extends Object

This class provides global configuration for form fields

These configurations should be set before creating the form fields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DominoUIConfig.DropdownPositionProvider<T> A provider for creating DropDownPosition
static interface	DominoUIConfig.GlobalValidationHandler A global validation handler that will be called when a form field gets validated
static interface	DominoUIConfig.NumberParsers
static interface	DominoUIConfig.RequiredIndicatorRenderer An interface for rendering the required indicator on fields
static interface	DominoUIConfig.TreeCollapseSupplier A provider for creating CollapseStrategy for TreeItem(s)

Field Summary

Fields

Modifier and Type	Field and Description
static DominoUIConfig	INSTANCE The DominoFields single INSTANCE for global access.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DominoUIConfig()

Method Summary

Modifier and Type	Method and Description
Optional<Boolean>	getCondensed()
Supplier<CollapseStrategy>	getDefaultAccordionCollapseStrategySupplier()
Supplier<CollapseStrategy>	getDefaultCardCollapseStrategySupplier()
Supplier<CollapseStrategy>	getDefaultCollapseStrategySupplier()
FieldStyle	getDefaultFieldsStyle()
String	getDefaultRequiredMessage()
DominoUIConfig.DropdownPositionProvider<AbstractSelect<?,?,?>>	getDefaultSelectPopupPosition()
DominoUIConfig.DropdownPositionProvider<AbstractSuggestBox<?,?>>	getDefaultSuggestPopupPosition()
DominoUIConfig.TreeCollapseSupplier	getDefaultTreeCollapseStrategySupplier()
Optional<Boolean>	getFixErrorsPosition()
Optional<Boolean>	getFloatLabels()
DominoUIConfig.GlobalValidationHandler	getGlobalValidationHandler()
DominoUIConfig.NumberParsers	getNumberParsers()
Supplier<elemental2.dom.Node>	getRequiredIndicator()
DominoUIConfig.RequiredIndicatorRenderer	getRequiredIndicatorRenderer()
boolean	isFocusNextFieldOnEnter()
DominoUIConfig	setCondensed(boolean condensed)
DominoUIConfig	setDefaultAccordionCollapseStrategySupplier(Supplier<CollapseStrategy> defaultAccordionCollapseStrategySupplier)
DominoUIConfig	setDefaultCardCollapseStrategySupplier(Supplier<CollapseStrategy> defaultCardCollapseStrategySupplier)
DominoUIConfig	setDefaultCollapseStrategySupplier(Supplier<CollapseStrategy> defaultCollapseStrategySupplier)
DominoUIConfig	setDefaultFieldsStyle(FieldStyle fieldsStyle) Globally change the form fields style
DominoUIConfig	setDefaultRequiredMessage(String defaultRequiredMessage)
DominoUIConfig	setDefaultSelectPopupPosition(DominoUIConfig.DropdownPositionProvider<AbstractSelect<?,?,?>> defaultSelectPopupPosition) Sets the default dropdown position for select
DominoUIConfig	setDefaultSuggestPopupPosition(DominoUIConfig.DropdownPositionProvider<AbstractSuggestBox<?,?>> defaultSuggestPopupPosition) Sets the default dropdown position for suggest box
DominoUIConfig	setDefaultTreeCollapseStrategySupplier(DominoUIConfig.TreeCollapseSupplier defaultTreeCollapseStrategySupplier)
DominoUIConfig	setFixErrorsPosition(boolean fixErrorsPosition)
DominoUIConfig	setFloatLabels(boolean floatLabels)
DominoUIConfig	setFocusNextFieldOnEnter(boolean focusNextFieldOnEnter)
DominoUIConfig	setGlobalValidationHandler(DominoUIConfig.GlobalValidationHandler globalValidationHandler)
DominoUIConfig	setNumberParsers(DominoUIConfig.NumberParsers numberParsers)
DominoUIConfig	setRequiredIndicator(Supplier<elemental2.dom.Node> requiredIndicator) Sets the Supplier for the Node that should be used as a required indicator
DominoUIConfig	setRequiredIndicatorRenderer(DominoUIConfig.RequiredIndicatorRenderer requiredIndicatorRenderer)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final DominoUIConfig INSTANCE

The DominoFields single INSTANCE for global access.

Constructor Detail

DominoUIConfig

protected DominoUIConfig()

Method Detail

setDefaultFieldsStyle

public DominoUIConfig setDefaultFieldsStyle(FieldStyle fieldsStyle)

Globally change the form fields style

Parameters:

fieldsStyle - FieldStyle

getDefaultFieldsStyle

public FieldStyle getDefaultFieldsStyle()

Returns:

Default FieldStyle

getFixErrorsPosition

public Optional<Boolean> getFixErrorsPosition()

Returns:

Optional representing if the errors position should be fixed

setFixErrorsPosition

public DominoUIConfig setFixErrorsPosition(boolean fixErrorsPosition)

Parameters:

fixErrorsPosition - true to fix errors position

Returns:

same instance

getFloatLabels

public Optional<Boolean> getFloatLabels()

Returns:

Optional representing if the labels should be floated

setFloatLabels

public DominoUIConfig setFloatLabels(boolean floatLabels)

Parameters:

floatLabels - true to float labels

Returns:

same instance

getCondensed

public Optional<Boolean> getCondensed()

Returns:

Optional representing if the spaces should be reduced to reduce element height

setCondensed

public DominoUIConfig setCondensed(boolean condensed)

Parameters:

condensed - true to reduce spaces

Returns:

same instance

getRequiredIndicator

public Supplier<elemental2.dom.Node> getRequiredIndicator()

Returns:

a supplier of Node, this should return a new Node instance everytime it is call and that will be used as a required field indicator the default will supply a text node of *

setRequiredIndicator

public DominoUIConfig setRequiredIndicator(Supplier<elemental2.dom.Node> requiredIndicator)

Sets the Supplier for the Node that should be used as a required indicator

Parameters:

requiredIndicator - Node Supplier

getRequiredIndicatorRenderer

public DominoUIConfig.RequiredIndicatorRenderer getRequiredIndicatorRenderer()

Returns:

the DominoUIConfig.RequiredIndicatorRenderer

getDefaultRequiredMessage

public String getDefaultRequiredMessage()

Returns:

the default required message

setDefaultRequiredMessage

public DominoUIConfig setDefaultRequiredMessage(String defaultRequiredMessage)

Parameters:

defaultRequiredMessage - the default required message

Returns:

same instance

setRequiredIndicatorRenderer

public DominoUIConfig setRequiredIndicatorRenderer(DominoUIConfig.RequiredIndicatorRenderer requiredIndicatorRenderer)

Parameters:

requiredIndicatorRenderer - A DominoUIConfig.RequiredIndicatorRenderer

Returns:

same instance

getGlobalValidationHandler

public DominoUIConfig.GlobalValidationHandler getGlobalValidationHandler()

Returns:

the DominoUIConfig.GlobalValidationHandler

setGlobalValidationHandler

public DominoUIConfig setGlobalValidationHandler(DominoUIConfig.GlobalValidationHandler globalValidationHandler)

Parameters:

globalValidationHandler - A DominoUIConfig.GlobalValidationHandler

Returns:

same instance

getDefaultSelectPopupPosition

public DominoUIConfig.DropdownPositionProvider<AbstractSelect<?,?,?>> getDefaultSelectPopupPosition()

Returns:

the default DominoUIConfig.DropdownPositionProvider for AbstractSelect

setDefaultSelectPopupPosition

public DominoUIConfig setDefaultSelectPopupPosition(DominoUIConfig.DropdownPositionProvider<AbstractSelect<?,?,?>> defaultSelectPopupPosition)

Sets the default dropdown position for select

Parameters:

defaultSelectPopupPosition - the DominoUIConfig.DropdownPositionProvider

Returns:

same instance

getDefaultSuggestPopupPosition

public DominoUIConfig.DropdownPositionProvider<AbstractSuggestBox<?,?>> getDefaultSuggestPopupPosition()

Returns:

the default DominoUIConfig.DropdownPositionProvider for AbstractSuggestBox

setDefaultSuggestPopupPosition

public DominoUIConfig setDefaultSuggestPopupPosition(DominoUIConfig.DropdownPositionProvider<AbstractSuggestBox<?,?>> defaultSuggestPopupPosition)

Sets the default dropdown position for suggest box

Parameters:

defaultSuggestPopupPosition - the DominoUIConfig.DropdownPositionProvider

Returns:

same instance

getDefaultCollapseStrategySupplier

public Supplier<CollapseStrategy> getDefaultCollapseStrategySupplier()

setDefaultCollapseStrategySupplier

public DominoUIConfig setDefaultCollapseStrategySupplier(Supplier<CollapseStrategy> defaultCollapseStrategySupplier)

getDefaultCardCollapseStrategySupplier

public Supplier<CollapseStrategy> getDefaultCardCollapseStrategySupplier()

setDefaultCardCollapseStrategySupplier

public DominoUIConfig setDefaultCardCollapseStrategySupplier(Supplier<CollapseStrategy> defaultCardCollapseStrategySupplier)

getDefaultTreeCollapseStrategySupplier

public DominoUIConfig.TreeCollapseSupplier getDefaultTreeCollapseStrategySupplier()

setDefaultTreeCollapseStrategySupplier

public DominoUIConfig setDefaultTreeCollapseStrategySupplier(DominoUIConfig.TreeCollapseSupplier defaultTreeCollapseStrategySupplier)

getDefaultAccordionCollapseStrategySupplier

public Supplier<CollapseStrategy> getDefaultAccordionCollapseStrategySupplier()

setDefaultAccordionCollapseStrategySupplier

public DominoUIConfig setDefaultAccordionCollapseStrategySupplier(Supplier<CollapseStrategy> defaultAccordionCollapseStrategySupplier)

getNumberParsers

public DominoUIConfig.NumberParsers getNumberParsers()

setNumberParsers

public DominoUIConfig setNumberParsers(DominoUIConfig.NumberParsers numberParsers)

isFocusNextFieldOnEnter

public boolean isFocusNextFieldOnEnter()

Returns:

true if press enter key will move the focus to the next input field if exists

setFocusNextFieldOnEnter

public DominoUIConfig setFocusNextFieldOnEnter(boolean focusNextFieldOnEnter)

Parameters:

focusNextFieldOnEnter - boolean, true to enable moving the focus to next field on enter key press, false to disable it.

Returns:

same DominoUIConfig instance