Module io.github.mmm.ui.fx.core
Package io.github.mmm.ui.fx.widget.input
Class FxAbstractChoice<W extends javafx.scene.control.Control,O,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.FxActiveWidget<W>
-
- io.github.mmm.ui.fx.widget.FxActiveValidatableWidget<W,V>
-
- io.github.mmm.ui.fx.widget.input.FxInput<W,V>
-
- io.github.mmm.ui.fx.widget.input.FxAbstractChoice<W,O,V>
-
- Type Parameters:
W
- type ofJavaFx widget
.O
- type of theoption
.V
- type of thevalue
.
- All Implemented Interfaces:
EventSource<UiEvent,UiEventListener>
,AttributeReadEnabled
,AttributeReadId
,AttributeReadValid
,AttributeReadValue<V>
,AttributeReadVisible
,AttributeWriteEnabled
,AttributeWriteId
,AttributeWritePrefix
,AttributeWriteReadOnly
,AttributeWriteSuffix
,AttributeWriteTooltip
,AttributeWriteValidationFailure
,AttributeWriteValue<V>
,AttributeWriteValueForUser<V>
,AttributeWriteVisible
,UiAbstractChoice<O,V>
,UiAbstractInput<V>
,UiInput<V>
,UiActiveWidget
,UiNativeWidget
,UiRegularWidget
,UiWidget
,UiValidatableWidget<V>
,UiValuedWidget<V>
,UiNativeWidgetWrapper<W>
- Direct Known Subclasses:
FxComboBox
,FxRadioChoice
public abstract class FxAbstractChoice<W extends javafx.scene.control.Control,O,V> extends FxInput<W,V> implements UiAbstractChoice<O,V>
Implementation ofUiRadioChoice
for JavaFx.- Since:
- 1.0.0
-
-
Field Summary
Fields Modifier and Type Field Description protected List<O>
options
-
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.AttributeWritePrefix
STYLE_PREFIX, STYLE_WITH_PREFIX
-
Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteSuffix
STYLE_SUFFIX, STYLE_WITH_SUFFIX
-
Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
STYLE_INVALID
-
Fields inherited from interface io.github.mmm.ui.api.widget.UiActiveWidget
ACCESS_KEY_NONE
-
Fields inherited from interface io.github.mmm.ui.api.widget.input.UiInput
STYLE_INPUT
-
Fields inherited from interface io.github.mmm.ui.api.widget.value.UiValidatableWidget
STYLE_MANDATORY
-
-
Constructor Summary
Constructors Constructor Description FxAbstractChoice(W widget)
The constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Function<O,String>
getFormatter()
List<O>
getOptions()
This method gets the options of this object.void
setFormatter(Function<O,String> formatter)
void
setOptions(List<O> options)
This method sets theoptions
of this object.-
Methods inherited from class io.github.mmm.ui.fx.widget.input.FxInput
getContainerWidget, getHBox, getName, getNameWidget, getPrefix, getPrefixLabel, getSuffix, getSuffixLabel, getTopWidget, hasContainerWidget, hasNameWidget, initHBox, setMandatory, setName, setPrefix, setReadOnlyNative, setSuffix, setValueNative, setVisible
-
Methods inherited from class io.github.mmm.ui.fx.widget.FxActiveValidatableWidget
doSetValidationFailure, getModificationTimestamp, getOriginalValue, getValidator, onFocusChanged, onValueChanged, setOriginalValue, setValidator, setValue
-
Methods inherited from class io.github.mmm.ui.fx.widget.FxActiveWidget
getAccessKey, isFocused, registerFocusChangeHandler, registerHandlers, setAccessKey, setFocused, setParent
-
Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetNode
setEnabledNative, setIdNative, 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, onValueChange, 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, removeListener, requireNotDisposed, setEnabled, setProgrammaticEventType, setReadOnly, setReadOnlyFixed, setValidationFailure, 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.AttributeWritePrefix
getPrefix, setPrefix
-
Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteSuffix
getSuffix, setSuffix
-
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.input.UiAbstractChoice
format, setOptions
-
Methods inherited from interface io.github.mmm.ui.api.widget.input.UiAbstractInput
getName, setName
-
Methods inherited from interface io.github.mmm.ui.api.widget.input.UiInput
getContainerWidget, getNameWidget, hasContainerWidget, hasNameWidget
-
Methods inherited from interface io.github.mmm.ui.api.widget.value.UiValidatableWidget
getOriginalValue, getValidator, getValue, getValueOrThrow, isValid, reset, setOriginalValue, setValidator, setValue, setValue, setValueForUser
-
Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget
cast, dispose, getModificationTimestamp, getParent, getReadOnlyFixed, getStyles, isDisposed, isEnabled, isEnabled, isFocused, isModified, isReadOnly, isVisible, isVisible, setEnabled, setEnabled, setFocused, setReadOnly, setReadOnlyFixed, setVisible, setVisible, validate, validate, validate, validateDown, validateUp
-
-
-
-
Field Detail
-
options
protected List<O> options
- See Also:
getOptions()
-
-
Constructor Detail
-
FxAbstractChoice
public FxAbstractChoice(W widget)
The constructor.- Parameters:
widget
- theJavaFx widget
.
-
-
Method Detail
-
getOptions
public List<O> getOptions()
Description copied from interface:UiAbstractChoice
This method gets the options of this object. The options are the available values to choose a selection from. TheList
shall not contain duplicate entries. It may contain the valuenull
. In such caseset a custom formatter
that provides a reasonable display value for thenull
option.
ATTENTION: Do not update theList
of options from outside. SeeUiAbstractChoice.setOptions(List)
for details.- Specified by:
getOptions
in interfaceUiAbstractChoice<W extends javafx.scene.control.Control,O>
- Returns:
- the
List
with all available options.
-
setOptions
public void setOptions(List<O> options)
Description copied from interface:UiAbstractChoice
This method sets theoptions
of this object. The options will be presented in their order specified by the givenList
.
ATTENTION: The options are updated during this method. Changing theList
instance after calling this method will not reflect the changes unless this method is called again.- Specified by:
setOptions
in interfaceUiAbstractChoice<W extends javafx.scene.control.Control,O>
- Parameters:
options
- the newList
of availableoptions
.
-
getFormatter
public Function<O,String> getFormatter()
- Specified by:
getFormatter
in interfaceUiAbstractChoice<W extends javafx.scene.control.Control,O>
- Returns:
- the formatter to
format
anoption
toString
in order to display it in the UI. By default it will simply useToStringFormatter
. UseUiAbstractChoice.setFormatter(Function)
to change default.
-
setFormatter
public void setFormatter(Function<O,String> formatter)
- Specified by:
setFormatter
in interfaceUiAbstractChoice<W extends javafx.scene.control.Control,O>
- Parameters:
formatter
- the new value ofUiAbstractChoice.getFormatter()
.
-
-