LabeledTextField (module-fields 0.9.1 API)

java.lang.Object
- javafx.scene.Node
- - javafx.scene.Parent
  - - javafx.scene.layout.Region
    - - javafx.scene.layout.Pane
      - javafx.scene.layout.StackPane
        
        jidefx.scene.control.decoration.DecorationPane
        
        jidefx.scene.control.field.LabeledTextField

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, jidefx.scene.control.decoration.DecorationSupport
```
public class LabeledTextField
extends jidefx.scene.control.decoration.DecorationPane
```
LabeledTextField includes a TextField and two Buttons. The first button is the label button which can be used as a place to click to show a context menu, or a hint to tell user what this TextField is for. The second button is a clear button. When there is text in the TextField, clicking this button clears the text.

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.BooleanProperty`	`editable`
`javafx.beans.property.ObjectProperty<javafx.scene.Node>`	`graphics`
`javafx.beans.property.StringProperty`	`label`
`javafx.beans.property.StringProperty`	`promptText`
`javafx.beans.property.StringProperty`	`text`

Properties inherited from class javafx.scene.layout.StackPane
alignmentProperty

Properties inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent
impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node
blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary
- Fields inherited from class javafx.scene.layout.Region
  USE_COMPUTED_SIZE, USE_PREF_SIZE
- Fields inherited from interface jidefx.scene.control.decoration.DecorationSupport
  STYLE_CLASS_DECORATION_SUPPORT

Constructor Summary

Constructors
Constructor and Description

LabeledTextField()

Constructors
Constructor and Description
`LabeledTextField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearMessage()`
`void`	`clearText()`
`protected double`	`computeMaxHeight(double width)`
`protected double`	`computeMinHeight(double width)`
`protected double`	`computePrefHeight(double width)`
`javafx.beans.property.BooleanProperty`	`editableProperty()`
`javafx.scene.control.Button`	`getClearButton()`
`javafx.scene.Node`	`getClearIcon()`
`javafx.scene.Node`	`getGraphics()` Gets the value of the property graphics.
`java.lang.String`	`getLabel()` Gets the value of the property label.
`javafx.scene.control.Button`	`getLabelButton()`
`javafx.scene.Node`	`getMagnifyIcon()`
`java.lang.String`	`getPromptText()` Gets the value of the property promptText.
`java.lang.String`	`getText()` Gets the value of the property text.
`javafx.scene.control.TextField`	`getTextField()`
`javafx.beans.property.ObjectProperty<javafx.scene.Node>`	`graphicsProperty()`
`protected void`	`initializeChildren()`
`protected void`	`initializeStyle()`
`boolean`	`isEditable()` Gets the value of the property editable.
`javafx.beans.property.StringProperty`	`labelProperty()`
`javafx.beans.property.StringProperty`	`promptTextProperty()`
`protected void`	`registerListeners()`
`void`	`setEditable(boolean editable)` Sets the value of the property editable.
`void`	`setGraphics(javafx.scene.Node graphics)` Sets the value of the property graphics.
`void`	`setLabel(java.lang.String text)` Sets the value of the property label.
`void`	`setPromptText(java.lang.String promptText)` Sets the value of the property promptText.
`void`	`setText(java.lang.String text)` Sets the value of the property text.
`protected void`	`showMessage(java.lang.String message)`
`javafx.beans.property.StringProperty`	`textProperty()`

Methods inherited from class jidefx.scene.control.decoration.DecorationPane
computeMaxWidth, computeMinWidth, computePrefWidth, getContent, layoutChildren, positionInArea

Methods inherited from class javafx.scene.layout.StackPane
alignmentProperty, clearConstraints, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, requestLayout, setAlignment, setAlignment, setMargin

Methods inherited from class javafx.scene.layout.Pane
getChildren

Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPGNode, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePG, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent
getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestParentLayout, setImpl_traversalEngine, setNeedsLayout

Methods inherited from class javafx.scene.Node
addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPGNode, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPGNode, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jidefx.scene.control.decoration.DecorationSupport
getChildren

- Property Detail
  - promptText
```
public javafx.beans.property.StringProperty promptTextProperty
```
    See Also:
    
    getPromptText(), setPromptText(String)
  - text
```
public javafx.beans.property.StringProperty textProperty
```
    See Also:
    
    getText(), setText(String)
  - label
```
public javafx.beans.property.StringProperty labelProperty
```
    See Also:
    
    getLabel(), setLabel(String)
  - graphics
```
public javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicsProperty
```
    See Also:
    
    getGraphics(), setGraphics(Node)
  - editable
```
public javafx.beans.property.BooleanProperty editableProperty
```
    See Also:
    
    isEditable(), setEditable(boolean)
- Constructor Detail
  - LabeledTextField
```
public LabeledTextField()
```
- Method Detail
  - initializeChildren
```
protected void initializeChildren()
```
    Overrides:
    
    initializeChildren in class jidefx.scene.control.decoration.DecorationPane
  - registerListeners
```
protected void registerListeners()
```
    Overrides:
    
    registerListeners in class jidefx.scene.control.decoration.DecorationPane
  - initializeStyle
```
protected void initializeStyle()
```
    Overrides:
    
    initializeStyle in class jidefx.scene.control.decoration.DecorationPane
  - getTextField
```
public javafx.scene.control.TextField getTextField()
```
  - getClearButton
```
public javafx.scene.control.Button getClearButton()
```
  - getLabelButton
```
public javafx.scene.control.Button getLabelButton()
```
  - promptTextProperty
```
public javafx.beans.property.StringProperty promptTextProperty()
```
    See Also:
    
    getPromptText(), setPromptText(String)
  - setPromptText
```
public void setPromptText(java.lang.String promptText)
```
    Sets the value of the property promptText.
  - getPromptText
```
public java.lang.String getPromptText()
```
    Gets the value of the property promptText.
  - textProperty
```
public javafx.beans.property.StringProperty textProperty()
```
    See Also:
    
    getText(), setText(String)
  - setText
```
public void setText(java.lang.String text)
```
    Sets the value of the property text.
  - clearText
```
public void clearText()
```
  - getText
```
public java.lang.String getText()
```
    Gets the value of the property text.
  - labelProperty
```
public javafx.beans.property.StringProperty labelProperty()
```
    See Also:
    
    getLabel(), setLabel(String)
  - setLabel
```
public void setLabel(java.lang.String text)
```
    Sets the value of the property label.
  - getLabel
```
public java.lang.String getLabel()
```
    Gets the value of the property label.
  - graphicsProperty
```
public javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicsProperty()
```
    See Also:
    
    getGraphics(), setGraphics(Node)
  - setGraphics
```
public void setGraphics(javafx.scene.Node graphics)
```
    Sets the value of the property graphics.
  - getGraphics
```
public javafx.scene.Node getGraphics()
```
    Gets the value of the property graphics.
  - editableProperty
```
public javafx.beans.property.BooleanProperty editableProperty()
```
    See Also:
    
    isEditable(), setEditable(boolean)
  - setEditable
```
public void setEditable(boolean editable)
```
    Sets the value of the property editable.
  - isEditable
```
public boolean isEditable()
```
    Gets the value of the property editable.
  - showMessage
```
protected void showMessage(java.lang.String message)
```
  - clearMessage
```
public void clearMessage()
```
  - computePrefHeight
```
protected double computePrefHeight(double width)
```
    Overrides:
    
    computePrefHeight in class jidefx.scene.control.decoration.DecorationPane
  - computeMinHeight
```
protected double computeMinHeight(double width)
```
    Overrides:
    
    computeMinHeight in class jidefx.scene.control.decoration.DecorationPane
  - computeMaxHeight
```
protected double computeMaxHeight(double width)
```
    Overrides:
    
    computeMaxHeight in class jidefx.scene.control.decoration.DecorationPane
  - getClearIcon
```
public javafx.scene.Node getClearIcon()
```
  - getMagnifyIcon
```
public javafx.scene.Node getMagnifyIcon()
```

Class LabeledTextField

Property Summary

Properties inherited from class javafx.scene.layout.StackPane

Properties inherited from class javafx.scene.layout.Region

Properties inherited from class javafx.scene.Parent

Properties inherited from class javafx.scene.Node

Field Summary

Fields inherited from class javafx.scene.layout.Region

Fields inherited from interface jidefx.scene.control.decoration.DecorationSupport

Constructor Summary

Method Summary

Methods inherited from class jidefx.scene.control.decoration.DecorationPane

Methods inherited from class javafx.scene.layout.StackPane

Methods inherited from class javafx.scene.layout.Pane

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class javafx.scene.Parent

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Methods inherited from interface jidefx.scene.control.decoration.DecorationSupport

Property Detail

promptText

text

label

graphics

editable

Constructor Detail

LabeledTextField

Method Detail

initializeChildren

registerListeners

initializeStyle

getTextField

getClearButton

getLabelButton

promptTextProperty

setPromptText

getPromptText

textProperty

setText

clearText

getText

labelProperty

setLabel

getLabel

graphicsProperty

setGraphics

getGraphics

editableProperty

setEditable

isEditable

showMessage

clearMessage

computePrefHeight

computeMinHeight

computeMaxHeight

getClearIcon

getMagnifyIcon