Module io.github.mmm.ui.fx.core
Class FxValuedComposite<W extends javafx.scene.layout.Pane,C extends UiWidget,V>
- java.lang.Object
-
- io.github.mmm.ui.api.widget.AbstractUiWidget
-
- io.github.mmm.ui.spi.widget.AbstractUiNativeWidget
-
- io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper<W>
-
- io.github.mmm.ui.fx.widget.FxWidget<W>
-
- io.github.mmm.ui.fx.widget.FxWidgetStyleable<W>
-
- io.github.mmm.ui.fx.widget.FxWidgetNode<W>
-
- io.github.mmm.ui.fx.widget.composite.FxComposite<W,C>
-
- io.github.mmm.ui.fx.widget.composite.FxRemovableComposite<W,C>
-
- io.github.mmm.ui.fx.widget.composite.FxMutableComposite<W,C>
-
- io.github.mmm.ui.fx.widget.composite.FxMutableCompositePane<W,C>
-
- io.github.mmm.ui.fx.widget.composite.FxFailureComposite<W,C>
-
- io.github.mmm.ui.fx.widget.composite.FxValuedComposite<W,C,V>
-
- Type Parameters:
W
- type ofJavaFx widget
.V
- type of thevalue
.C
- type of thechild widgets
.
- All Implemented Interfaces:
EventSource<UiEvent,UiEventListener>
,AttributeReadEnabled
,AttributeReadId
,AttributeReadValid
,AttributeReadValue<V>
,AttributeReadVisible
,AttributeWriteEnabled
,AttributeWriteId
,AttributeWriteReadOnly
,AttributeWriteTooltip
,AttributeWriteValidationFailure
,AttributeWriteValue<V>
,AttributeWriteValueForUser<V>
,AttributeWriteVisible
,UiComposite<C>
,UiFailureComposite<C>
,UiMutableComposite<C>
,UiRemovableComposite<C>
,UiValuedComposite<C,V>
,UiNativeWidget
,UiWidget
,UiBindableWidget<V>
,UiValidatableWidget<V>
,UiValuedWidget<V>
,UiNativeWidgetWrapper<W>
- Direct Known Subclasses:
FxFormGroup
,FxFormGroup
,FxFormPanel
,FxFormPanel
public abstract class FxValuedComposite<W extends javafx.scene.layout.Pane,C extends UiWidget,V> extends FxFailureComposite<W,C> implements UiValuedComposite<C,V>
Implementation ofUiValuedComposite
for JavaFx.- Since:
- 1.0.0
-
-
Field Summary
-
Fields inherited from class io.github.mmm.ui.fx.widget.composite.FxComposite
children
-
Fields inherited from class io.github.mmm.ui.fx.widget.FxWidget
CLASS_INVALID, CLASS_READ_ONLY, widget
-
Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
STYLE_INVALID
-
Fields inherited from interface io.github.mmm.ui.api.widget.value.UiValidatableWidget
STYLE_MANDATORY
-
-
Constructor Summary
Constructors Constructor Description FxValuedComposite(W widget)
The constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description V
getOriginalValue()
Validator<? super V>
getValidator()
V
getValueOrThrow()
void
initBinding(UiValueBinding<V> newBinding)
Initializes the value binding.void
setOriginalValue(V originalValue)
void
setValidator(Validator<? super V> validator)
void
setValue(V value, boolean forUser)
-
Methods inherited from class io.github.mmm.ui.fx.widget.composite.FxFailureComposite
doSetValidationFailure
-
Methods inherited from class io.github.mmm.ui.fx.widget.composite.FxMutableCompositePane
addChildWidget, removeChildWidget
-
Methods inherited from class io.github.mmm.ui.fx.widget.composite.FxMutableComposite
addChild
-
Methods inherited from class io.github.mmm.ui.fx.widget.composite.FxRemovableComposite
removeChild
-
Methods inherited from class io.github.mmm.ui.fx.widget.composite.FxComposite
getChild, getChildCount, getChildIndex
-
Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetNode
getTopWidget, setEnabledNative, setIdNative, setReadOnlyNative, setTooltipNative, setVisibleNative
-
Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetStyleable
createStyles
-
Methods inherited from class io.github.mmm.ui.fx.widget.FxWidget
getTopNode, getWidget, onAction, onClose, onFocusChange, onFocusChanged, onValueChange, onValueChanged, setTooltip, setWidget
-
Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper
createDefaultStyles, getId, getStyles, getTooltip, onStylesChanged, setId, setTooltip
-
Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidget
addListener, dispose, doDispose, doGetEnabledState, doGetVisibleState, doSetEnabledState, doSetEnabledState, doSetVisibleState, doSetVisibleState, ensureHandlers, fireEvent, getEventAdapter, getParent, getProgrammaticEventType, getReadOnlyFixed, getValidationFailure, hasListeners, isDisposed, isEnabled, isInitiallyVisible, isReadOnly, isValid, isVisible, isVisibleWithoutRoot, registerHandlers, removeListener, requireNotDisposed, setEnabled, setParent, setProgrammaticEventType, setReadOnly, setReadOnlyFixed, setValidationFailure, setVisible, unwrap, validateDown
-
Methods inherited from class io.github.mmm.ui.api.widget.AbstractUiWidget
isEmpty, setParent, unwrap
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId
getId
-
Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId
setId
-
Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip
getTooltip, setTooltip
-
Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
getValidationFailure, setValidationFailure, setValidationFailure
-
Methods inherited from interface io.github.mmm.event.EventSource
addListener, addListener, addWeakListener, removeListener
-
Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiComposite
getChild, getChild, getChildCount, getChildIndex, getDescendant, getModificationTimestamp, getPropagation, isModified, setFocused
-
Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiFailureComposite
isValid
-
Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiMutableComposite
addChild, addChild
-
Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiRemovableComposite
removeChild, removeChild
-
Methods inherited from interface io.github.mmm.ui.api.widget.value.UiValidatableWidget
getValue, setValue, setValueForUser
-
Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiValuedComposite
isValid, reset
-
Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget
cast, dispose, getParent, getReadOnlyFixed, getStyles, isDisposed, isEnabled, isEnabled, isFocused, isReadOnly, isVisible, isVisible, setEnabled, setEnabled, setReadOnly, setReadOnlyFixed, setVisible, setVisible, validate, validate, validate, validateDown, validateUp
-
-
-
-
Constructor Detail
-
FxValuedComposite
public FxValuedComposite(W widget)
The constructor.- Parameters:
widget
- theJavaFx widget
.
-
-
Method Detail
-
initBinding
public void initBinding(UiValueBinding<V> newBinding)
Description copied from interface:UiBindableWidget
Initializes the value binding.- Specified by:
initBinding
in interfaceUiBindableWidget<W extends javafx.scene.layout.Pane>
- Parameters:
newBinding
- theUiValueBinding
defining how to read and write the value.
-
getOriginalValue
public V getOriginalValue()
- Specified by:
getOriginalValue
in interfaceUiValidatableWidget<W extends javafx.scene.layout.Pane>
- Returns:
- the original value since it was last set via
UiValidatableWidget.setOriginalValue(Object)
or most probably indirectly viaUiValidatableWidget.setValue(Object)
. If this widget ismodified
,UiValidatableWidget.getValue()
will return the current value as entered by the end-user while this method will still return the original value.
ATTENTION: The original value shall never be modified to avoid undesired side effects. Various features such asUiValidatableWidget.reset()
rely on this fact. - See Also:
UiValidatableWidget.reset()
-
setOriginalValue
public void setOriginalValue(V originalValue)
- Specified by:
setOriginalValue
in interfaceUiValidatableWidget<W extends javafx.scene.layout.Pane>
- Parameters:
originalValue
- the new value ofUiValidatableWidget.getOriginalValue()
.
-
getValidator
public Validator<? super V> getValidator()
- Specified by:
getValidator
in interfaceUiValidatableWidget<W extends javafx.scene.layout.Pane>
- Returns:
- the
Validator
to validate thevalue
of this input.
-
setValidator
public void setValidator(Validator<? super V> validator)
- Specified by:
setValidator
in interfaceUiValidatableWidget<W extends javafx.scene.layout.Pane>
- Parameters:
validator
- the newvalidator
. To add multiple validators, simply useComposedValidator
orValidator.append(Validator...)
.
-
getValueOrThrow
public V getValueOrThrow()
- Specified by:
getValueOrThrow
in interfaceUiValidatableWidget<W extends javafx.scene.layout.Pane>
- Returns:
- the current
value
.
-
setValue
public void setValue(V value, boolean forUser)
- Specified by:
setValue
in interfaceAttributeWriteValueForUser<W extends javafx.scene.layout.Pane>
- Specified by:
setValue
in interfaceUiValidatableWidget<W extends javafx.scene.layout.Pane>
- Parameters:
value
- the newvalue
.forUser
- -true
forUiValidatableWidget.setValueForUser(Object)
andfalse
forUiValidatableWidget.setValue(Object)
.
-
-