Module io.github.mmm.ui.fx.core
Package io.github.mmm.ui.fx.widget.input
Class FxTextualInput<W extends javafx.scene.control.TextInputControl,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.FxTextualInput<W,V>
-
- Type Parameters:
W
- type ofJavaFx widget
.V
- type ofvalue
.
- All Implemented Interfaces:
EventSource<UiEvent,UiEventListener>
,AttributeReadEnabled
,AttributeReadId
,AttributeReadValid
,AttributeReadValue<V>
,AttributeReadVisible
,AttributeWriteAutocomplete
,AttributeWriteEnabled
,AttributeWriteId
,AttributeWritePlaceholder
,AttributeWritePrefix
,AttributeWriteReadOnly
,AttributeWriteSuffix
,AttributeWriteText
,AttributeWriteTooltip
,AttributeWriteValidationFailure
,AttributeWriteValue<V>
,AttributeWriteValueForUser<V>
,AttributeWriteVisible
,UiAbstractInput<V>
,UiInput<V>
,UiTextualInput<V>
,UiActiveWidget
,UiNativeWidget
,UiRegularWidget
,UiWidget
,UiValidatableWidget<V>
,UiValuedWidget<V>
,UiNativeWidgetWrapper<W>
- Direct Known Subclasses:
FxStringInput
public abstract class FxTextualInput<W extends javafx.scene.control.TextInputControl,V> extends FxInput<W,V> implements UiTextualInput<V>
Implementation ofUiTextualInput
for JavaFx.- Since:
- 1.0.0
-
-
Field Summary
-
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.AttributeWriteAutocomplete
AUTOCOMPLETE_BIRTHDAY, AUTOCOMPLETE_CC_CSC, AUTOCOMPLETE_CC_EXPIRY, AUTOCOMPLETE_CC_NUMBER, AUTOCOMPLETE_CC_TYPE, AUTOCOMPLETE_COUNTRY_CODE, AUTOCOMPLETE_COUNTRY_NAME, AUTOCOMPLETE_CURRENT_PASSWORD, AUTOCOMPLETE_EMAIL, AUTOCOMPLETE_FAMILY_NAME, AUTOCOMPLETE_GIVEN_NAME, AUTOCOMPLETE_HONORIFIC_PREFIX, AUTOCOMPLETE_IMPP, AUTOCOMPLETE_JOB_TITLE, AUTOCOMPLETE_LANGUAGE_CODE, AUTOCOMPLETE_NEW_PASSWORD, AUTOCOMPLETE_NICKNAME, AUTOCOMPLETE_OFF, AUTOCOMPLETE_ORGANIZATION, AUTOCOMPLETE_POSTAL_CODE, AUTOCOMPLETE_SEX, AUTOCOMPLETE_STREET, AUTOCOMPLETE_TELEPHONE, AUTOCOMPLETE_TX_AMOUNT, AUTOCOMPLETE_TX_CURRENCY, AUTOCOMPLETE_URL, AUTOCOMPLETE_USERNAME
-
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 FxTextualInput(W nativeWidget)
The constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAutocomplete()
String
getPlaceholder()
String
getText()
protected void
registerHandlers()
Registers the according handlers to the underlying native widget.void
setAutocomplete(String autocomplete)
void
setPlaceholder(String placeholder)
protected void
setReadOnlyNative(boolean readOnly)
void
setText(String text)
-
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, 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, 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.AttributeWriteAutocomplete
setAutocompleteOff
-
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.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
-
-
-
-
Constructor Detail
-
FxTextualInput
public FxTextualInput(W nativeWidget)
The constructor.- Parameters:
nativeWidget
- theJavaFx widget
.
-
-
Method Detail
-
registerHandlers
protected void registerHandlers()
Description copied from class:AbstractUiNativeWidget
Registers the according handlers to the underlying native widget. Never call manually, only viaAbstractUiNativeWidget.ensureHandlers()
.- Overrides:
registerHandlers
in classFxActiveWidget<W extends javafx.scene.control.TextInputControl>
-
setReadOnlyNative
protected void setReadOnlyNative(boolean readOnly)
- Overrides:
setReadOnlyNative
in classFxInput<W extends javafx.scene.control.TextInputControl,V>
- Parameters:
readOnly
- the new value ofAbstractUiNativeWidget.isReadOnly()
.
-
getPlaceholder
public String getPlaceholder()
- Specified by:
getPlaceholder
in interfaceAttributeWritePlaceholder
- Returns:
- the placeholder text that is displayed if the input text field is blank. Will be the empty string if not set.
-
setPlaceholder
public void setPlaceholder(String placeholder)
- Specified by:
setPlaceholder
in interfaceAttributeWritePlaceholder
- Parameters:
placeholder
- the new value ofAttributeWritePlaceholder.getPlaceholder()
.
-
getText
public String getText()
- Specified by:
getText
in interfaceAttributeWriteText
- Returns:
- the label or text of this widget. Will be the empty string if no text has been set. If used as label the
text is permanently displayed as information for the user to describe its meaning (lettering for button or
label). Otherwise for textual inputs the text is the plain
value
as text entered by the end-user. If thevalue
type is notString
(e.g. forUiComboBox
) this gives direct access to the plain text entered by the end-user (even in case it is not a valid option). This can be useful in a combo-box in casevalue
is undefined to accept the text as a new option (e.g. for a tag).
-
setText
public void setText(String text)
- Specified by:
setText
in interfaceAttributeWriteText
- Parameters:
text
- is the newtext
to set.
-
getAutocomplete
public String getAutocomplete()
- Specified by:
getAutocomplete
in interfaceAttributeWriteAutocomplete
- Returns:
- the autocompletion configuration of this object (e.g.
UiTextualInput
).
-
setAutocomplete
public void setAutocomplete(String autocomplete)
- Specified by:
setAutocomplete
in interfaceAttributeWriteAutocomplete
- Parameters:
autocomplete
- is the new value ofAttributeWriteAutocomplete.getAutocomplete()
.
-
-