de.esoco.process.ui

Class UiControl<T,C extends UiControl<T,C>>

java.lang.Object

org.obrel.core.RelatedObject

de.esoco.process.param.ParameterWrapper<T,C>

de.esoco.process.ui.UiComponent<T,C>

de.esoco.process.ui.UiControl<T,C>

All Implemented Interfaces:

UiHasFocusEvents<T,C>, org.obrel.core.Relatable

Direct Known Subclasses:

UiButtonControl, UiInputField, UiListControl, UiTableControl

public class UiControl<T,C extends UiControl<T,C>>
extends UiComponent<T,C>
implements UiHasFocusEvents<T,C>

The base class for components that allow interactive input.

Constructor Summary

Constructors

Constructor and Description
UiControl(UiContainer<?> rParent, java.lang.Class<? super T> rDatatype) Creates a new instance.
UiControl(UiContainer<?> rParent, org.obrel.core.RelationType<T> rParamType) Creates a new instance with an existing parameter type.

Method Summary

Modifier and Type	Method and Description
C	onFocusLost(java.util.function.Consumer<T> rEventHandler) Registers an event handler that will be invoked if a interactive component loses the input focus.
C	validateFinally(java.util.function.Function<? super T,de.esoco.lib.expression.function.Validation.ValidationResult> fValidation) Sets a final validation for the control's input value.
C	validateInteractive(java.util.function.Function<? super T,de.esoco.lib.expression.function.Validation.ValidationResult> fValidation) Sets an interactive validation for the control's input value.
void	validateNow(java.util.function.Function<? super T,de.esoco.lib.expression.function.Validation.ValidationResult> fValidation) Immediately validates whether the input value of this control fulfills a certain constraint.

Methods inherited from class de.esoco.process.ui.UiComponent

applyProperties, attachTo, cell, cell, getComponentStyleName, getImage, getParent, getRootView, getValueImpl, getView, height, icon, image, label, placeBefore, resid, setValueImpl, size, style, style, styleName, tooltip, toString, update, visibleOn, width

Methods inherited from class de.esoco.process.param.ParameterWrapper

clear, disable, enable, fragment, get, getParam, has, hide, id, initiateDownload, isEnabled, isVisible, remove, set, set, set, setEnabled, setFragment, setParam, setParameterEventHandler, setParameterType, setVisible, show, type

Methods inherited from class org.obrel.core.RelatedObject

deleteRelation, get, getRelation, getRelations, notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, set, transform, writeRelations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.obrel.core.Relatable

deleteRelation, deleteRelations, getAll, getOption, getRelationCount, getRelations, hasFlag, hasRelation, hasRelations, init, set, set, set, setOption, streamRelations

Constructor Detail

UiControl

public UiControl(UiContainer<?> rParent,
                 org.obrel.core.RelationType<T> rParamType)

Creates a new instance with an existing parameter type.

See Also:

UiComponent.UiComponent(UiContainer,de.esoco.process.step.InteractionFragment, RelationType)

UiControl

public UiControl(UiContainer<?> rParent,
                 java.lang.Class<? super T> rDatatype)

Creates a new instance.

See Also:

UiComponent.UiComponent(UiContainer, Class)

Method Detail

onFocusLost

public final C onFocusLost(java.util.function.Consumer<T> rEventHandler)

Registers an event handler that will be invoked if a interactive component loses the input focus.

Specified by:

onFocusLost in interface UiHasFocusEvents<T,C extends UiControl<T,C>>

Parameters:

rEventHandler - The event handler to be invoked

Returns:

The component the handler has been registered on

validateFinally

public C validateFinally(java.util.function.Function<? super T,de.esoco.lib.expression.function.Validation.ValidationResult> fValidation)

Sets a final validation for the control's input value. This validation will be executed when the interactive process step this control belongs to is finished. All registered validations will be executed together and any errors that are detected will be signaled to the user.

Parameters:

fValidation - The validation function

Returns:

This instance

See Also:

validateNow(Function), validateInteractive(Function)

validateInteractive

public C validateInteractive(java.util.function.Function<? super T,de.esoco.lib.expression.function.Validation.ValidationResult> fValidation)

Sets an interactive validation for the control's input value. This validation will be executed on each interaction (i.e. user input event) that occurs in the process step to which this control belongs. All registered validations will be executed together and any errors that are detected will be signaled to the user.

Because this validation type is executed on each interaction event it should be used cautiously and only if continuous validation is really needed. Otherwise a continuous signaling of errors can become annoying for the user.

Parameters:

fValidation - The validation function

Returns:

This instance

See Also:

validateNow(Function), validateFinally(Function)

validateNow

public void validateNow(java.util.function.Function<? super T,de.esoco.lib.expression.function.Validation.ValidationResult> fValidation)

Immediately validates whether the input value of this control fulfills a certain constraint. If not an exception will be thrown that will then be handled by the process framework. This will then only indicate this single error to the user. To validate multiple components together the methods validateInteractive(Function) and validateFinally(Function) should be used.

Parameters:

fValidation - The validation function for the control value

Throws:

InvalidParametersException - If the validation fails

See Also:

validateInteractive(Function), validateFinally(Function)