Package org.fxmisc.richtext

Class StyledTextField<PS,S>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

org.fxmisc.richtext.GenericStyledArea<PS,java.lang.String,S>

org.fxmisc.richtext.StyledTextArea<PS,S>

org.fxmisc.richtext.StyledTextField<PS,S>

Type Parameters:

PS - type of paragraph style

S - type of style that can be applied to text.

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, Virtualized, ClipboardActions<PS,java.lang.String,S>, EditActions<PS,java.lang.String,S>, TwoDimensional, NavigationActions<PS,java.lang.String,S>, StyleActions<PS,S>, TextEditingArea<PS,java.lang.String,S>, UndoActions, ViewActions<PS,java.lang.String,S>

Direct Known Subclasses:

InlineCssTextField, StyleClassedTextField

public abstract class StyledTextField<PS,S>
extends StyledTextArea<PS,S>

A text field whose segment generic has been specified to be a String. How the text will be styled is not yet specified in this class, but use StyleClassedTextField for a style class approach to styling the text and InlineCssTextField for an inline css approach to styling the text.

Use CSS Style Class ".styled-text-field" for styling the control.

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment>	alignment	Specifies how the text should be aligned when there is empty space within the TextField.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<javafx.event.ActionEvent>>	onAction	The action handler associated with this text field, or null if no action handler is assigned.
javafx.beans.property.ObjectProperty<? super javafx.scene.text.Text>	promptText

Properties inherited from class org.fxmisc.richtext.GenericStyledArea

autoHeight, autoScrollOnDragDesired, beingUpdated, contextMenuObject, contextMenuXOffset, contextMenuYOffset, editable, estimatedScrollX, estimatedScrollY, length, mouseOverTextDelay, onInsideSelectionMousePressReleased, onNewSelectionDragFinished, onNewSelectionDrag, onOutsideSelectionMousePressed, onSelectionDrag, onSelectionDropped, paragraphGraphicFactory, placeholder, text, totalHeightEstimate, totalWidthEstimate, useInitialStyleForInsertion, wrapText

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Properties inherited from interface org.fxmisc.richtext.TextEditingArea

anchor, caretBounds, caretColumn, caretPosition, currentParagraph, selectedText, selectionBounds, selection, showCaret

Properties inherited from interface org.fxmisc.richtext.UndoActions

redoAvailable, undoAvailable

Nested Class Summary

Nested classes/interfaces inherited from interface org.fxmisc.richtext.NavigationActions

NavigationActions.SelectionPolicy

Nested classes/interfaces inherited from interface org.fxmisc.richtext.model.TwoDimensional

TwoDimensional.Bias, TwoDimensional.Position

Field Summary

Fields inherited from class org.fxmisc.richtext.GenericStyledArea

EMPTY_RANGE, foldCheck

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
StyledTextField(PS initialParagraphStyle, java.util.function.BiConsumer<javafx.scene.text.TextFlow,PS> applyParagraphStyle, S initialTextStyle, java.util.function.BiConsumer<? super TextExt,S> applyStyle, EditableStyledDocument<PS,java.lang.String,S> document)

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment>	alignmentProperty()	Specifies how the text should be aligned when there is empty space within the TextField.
protected abstract void	changeAlignment(javafx.scene.text.TextAlignment txtAlign)
protected void	configurePlaceholder(javafx.scene.Node placeholder)	Override this to customize the placeholder's layout.
javafx.scene.text.TextAlignment	getAlignment()	Gets the value of the property alignment.
static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getClassCssMetaData()
java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getCssMetaData()
javafx.event.EventHandler<javafx.event.ActionEvent>	getOnAction()	Gets the value of the property onAction.
javafx.scene.text.Text	getPromptText()	Gets the value of the property promptText.
boolean	isWrapText()	This always returns false for styled text fields.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<javafx.event.ActionEvent>>	onActionProperty()	The action handler associated with this text field, or null if no action handler is assigned.
javafx.beans.property.ObjectProperty<? super javafx.scene.text.Text>	promptTextProperty()
void	replaceText(int start, int end, java.lang.String text)	Replaces a range of characters with the given text.
void	setAlignment(javafx.scene.text.TextAlignment value)	Sets the value of the property alignment.
void	setOnAction(javafx.event.EventHandler<javafx.event.ActionEvent> value)	Sets the value of the property onAction.
void	setPlaceholder(javafx.scene.Node value, javafx.geometry.Pos where)	setPlaceholder is not supported by StyledTextField, use setPromptText instead
void	setPromptText(javafx.scene.text.Text value)	The prompt text to display or null if no prompt text is to be displayed.
void	setText(java.lang.String text)
void	setWrapText(boolean value)	Deprecated.

Methods inherited from class org.fxmisc.richtext.StyledTextArea

createStyledTextNode, createStyledTextNode

Methods inherited from class org.fxmisc.richtext.GenericStyledArea

addCaret, addSelection, allParToVisibleParIndex, autoHeightProperty, autoScrollOnDragDesiredProperty, beingUpdatedProperty, computePrefHeight, contextMenuObjectProperty, contextMenuXOffsetProperty, contextMenuYOffsetProperty, createMultiChange, createMultiChange, displaceCaret, dispose, editableProperty, estimatedScrollXProperty, estimatedScrollYProperty, fold, foldParagraphs, foldSelectedParagraphs, getAbsolutePosition, getApplyParagraphStyle, getCaretBoundsOnScreen, getCaretSelectionBind, getCharacterBoundsOnScreen, getContent, getContextMenu, getContextMenuXOffset, getContextMenuYOffset, getCurrentLineEndInParargraph, getCurrentLineStartInParargraph, getDocument, getInitialParagraphStyle, getInitialTextStyle, getLocale, getOnInsideSelectionMousePressReleased, getOnNewSelectionDragFinished, getOnOutsideSelectionMousePressed, getOnSelectionDropped, getParagraphBoundsOnScreen, getParagraphGraphic, getParagraphInsertionStyle, getParagraphLinesCount, getParagraphs, getParagraphSelection, getParagraphStyleForInsertionAt, getPlaceholder, getSegOps, getStyleAtPosition, getStyleAtPosition, getStyleCodecs, getStyleOfChar, getStyleOfChar, getStyleRangeAtPosition, getStyleRangeAtPosition, getStyleSpans, getStyleSpans, getStyleSpans, getText, getText, getText, getTextInsertionStyle, getTextStyleForInsertionAt, getUndoManager, getViewportHeight, getVisibleParagraphBoundsOnScreen, getVisibleParagraphs, handleInputMethodEvent, hit, isAutoHeight, isAutoScrollOnDragDesired, isContextMenuPresent, isEditable, isLineHighlighterOn, isPreserveStyle, layoutChildren, lengthProperty, lineEnd, lineIndex, lineStart, mouseOverTextDelayProperty, multiPlainChanges, multiRichChanges, nextLine, nextPage, offsetToPosition, onInsideSelectionMousePressReleasedProperty, onNewSelectionDragFinishedProperty, onNewSelectionDragProperty, onOutsideSelectionMousePressedProperty, onSelectionDragProperty, onSelectionDroppedProperty, paragraphGraphicFactoryProperty, placeholderProperty, plainTextChanges, position, prevLine, prevPage, recreateParagraphGraphic, removeCaret, removeSelection, replace, replace, requestFollowCaret, richChanges, scrollBy, scrollXBy, scrollXToPixel, scrollYBy, scrollYToPixel, setAutoHeight, setAutoScrollOnDragDesired, setContextMenu, setContextMenuXOffset, setContextMenuYOffset, setEditable, setLineHighlighterFill, setLineHighlighterOn, setLocale, setOnInsideSelectionMousePressReleased, setOnNewSelectionDragFinished, setOnOutsideSelectionMousePressed, setOnSelectionDropped, setParagraphInsertionStyle, setParagraphStyle, setPlaceholder, setStyle, setStyle, setStyle, setStyleCodecs, setStyleSpans, setStyleSpans, setTextInsertionStyle, setUndoManager, showParagraphAtBottom, showParagraphAtCenter, showParagraphAtTop, showParagraphInViewport, showParagraphRegion, subDocument, subDocument, textProperty, totalHeightEstimateProperty, totalWidthEstimateProperty, unfoldParagraphs, useInitialStyleForInsertionProperty, viewportDirtyEvents, visibleParToAllParIndex, wrapTextProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, 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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, 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, getViewOrder, hasProperties, hoverProperty, idProperty, 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, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fxmisc.richtext.ClipboardActions

copy, cut, paste

Methods inherited from interface org.fxmisc.richtext.EditActions

append, append, appendText, clear, deleteNextChar, deletePreviousChar, deleteText, deleteText, deleteText, insert, insert, insert, insertText, insertText, moveSelectedText, replace, replaceSelection, replaceSelection, replaceText

Methods inherited from interface org.fxmisc.richtext.NavigationActions

deselect, end, moveTo, moveTo, moveTo, moveTo, nextChar, paragraphEnd, paragraphStart, previousChar, selectAll, selectParagraph, selectWord, start, wordBreaksBackwards, wordBreaksForwards

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Methods inherited from interface org.fxmisc.richtext.StyleActions

clearParagraphStyle, clearStyle, clearStyle, clearStyle, getStyleSpans, getStyleSpans, getUseInitialStyleForInsertion, setUseInitialStyleForInsertion

Methods inherited from interface org.fxmisc.richtext.TextEditingArea

anchorProperty, caretBoundsProperty, caretColumnProperty, caretPositionProperty, currentParagraphProperty, getAnchor, getCaretBounds, getCaretColumn, getCaretPosition, getCurrentParagraph, getLength, getParagraph, getParagraphLength, getParagraphSelection, getSelectedText, getSelection, getSelectionBounds, getShowCaret, getText, getText, isBeingUpdated, replace, replace, replace, replace, replaceText, replaceText, selectedTextProperty, selectionBoundsProperty, selectionProperty, selectRange, selectRange, setShowCaret, showCaretProperty, subDocument, subDocument

Methods inherited from interface org.fxmisc.richtext.UndoActions

isRedoAvailable, isUndoAvailable, redo, redoAvailableProperty, undo, undoAvailableProperty

Methods inherited from interface org.fxmisc.richtext.ViewActions

firstVisibleParToAllParIndex, getMouseOverTextDelay, getOnNewSelectionDrag, getOnSelectionDrag, getParagraphGraphicFactory, hideContextMenu, lastVisibleParToAllParIndex, selectLine, setMouseOverTextDelay, setOnNewSelectionDrag, setOnSelectionDrag, setParagraphGraphicFactory

Methods inherited from interface org.fxmisc.flowless.Virtualized

getEstimatedScrollX, getEstimatedScrollY, getTotalHeightEstimate, getTotalWidthEstimate, scrollBy, scrollToPixel, scrollToPixel

Property Detail

alignment

public final javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment> alignmentProperty

Specifies how the text should be aligned when there is empty space within the TextField. To configure via CSS use -fx-alignment: and values from TextAlignment.

See Also:

getAlignment(), setAlignment(TextAlignment)

onAction

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<javafx.event.ActionEvent>> onActionProperty

The action handler associated with this text field, or null if no action handler is assigned. The action handler is normally called when the user types the ENTER key.

See Also:

getOnAction(), setOnAction(EventHandler)

promptText

public final javafx.beans.property.ObjectProperty<? super javafx.scene.text.Text> promptTextProperty

See Also:

getPromptText(), setPromptText(Text)

Constructor Detail

StyledTextField

public StyledTextField(PS initialParagraphStyle,
                       java.util.function.BiConsumer<javafx.scene.text.TextFlow,PS> applyParagraphStyle,
                       S initialTextStyle,
                       java.util.function.BiConsumer<? super TextExt,S> applyStyle,
                       EditableStyledDocument<PS,java.lang.String,S> document)

Method Detail

alignmentProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.text.TextAlignment> alignmentProperty()

Specifies how the text should be aligned when there is empty space within the TextField. To configure via CSS use -fx-alignment: and values from TextAlignment.

See Also:

getAlignment(), setAlignment(TextAlignment)

getAlignment

public final javafx.scene.text.TextAlignment getAlignment()

Gets the value of the property alignment.

Property description:

Specifies how the text should be aligned when there is empty space within the TextField. To configure via CSS use -fx-alignment: and values from TextAlignment.

setAlignment

public final void setAlignment(javafx.scene.text.TextAlignment value)

Sets the value of the property alignment.

Property description:

Specifies how the text should be aligned when there is empty space within the TextField. To configure via CSS use -fx-alignment: and values from TextAlignment.

changeAlignment

protected abstract void changeAlignment(javafx.scene.text.TextAlignment txtAlign)

onActionProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<javafx.event.ActionEvent>> onActionProperty()

The action handler associated with this text field, or null if no action handler is assigned. The action handler is normally called when the user types the ENTER key.

See Also:

getOnAction(), setOnAction(EventHandler)

getOnAction

public final javafx.event.EventHandler<javafx.event.ActionEvent> getOnAction()

Gets the value of the property onAction.

Property description:

The action handler associated with this text field, or null if no action handler is assigned. The action handler is normally called when the user types the ENTER key.

setOnAction

public final void setOnAction(javafx.event.EventHandler<javafx.event.ActionEvent> value)

Sets the value of the property onAction.

Property description:

The action handler associated with this text field, or null if no action handler is assigned. The action handler is normally called when the user types the ENTER key.

setPromptText

public final void setPromptText(javafx.scene.text.Text value)

The prompt text to display or null if no prompt text is to be displayed.

The Text will be aligned according to the text fields alignment setting and have a default text fill of GRAY unless you have changed it by any means, e.g. with CSS "-fx-prompt-text-fill"

promptTextProperty

public final javafx.beans.property.ObjectProperty<? super javafx.scene.text.Text> promptTextProperty()

See Also:

getPromptText(), setPromptText(Text)

getPromptText

public final javafx.scene.text.Text getPromptText()

Gets the value of the property promptText.

Property description:

setPlaceholder

public void setPlaceholder(javafx.scene.Node value,
                           javafx.geometry.Pos where)

setPlaceholder is not supported by StyledTextField, use setPromptText instead

Overrides:

setPlaceholder in class GenericStyledArea<PS,java.lang.String,S>

configurePlaceholder

protected void configurePlaceholder(javafx.scene.Node placeholder)

Description copied from class: GenericStyledArea

Override this to customize the placeholder's layout.
The default position is centered over the area.

Overrides:

configurePlaceholder in class GenericStyledArea<PS,java.lang.String,S>

replaceText

public void replaceText(int start,
                        int end,
                        java.lang.String text)

Description copied from interface: TextEditingArea

Replaces a range of characters with the given text. It must hold 0 <= start <= end <= getLength().

Specified by:

replaceText in interface TextEditingArea<PS,java.lang.String,S>

Overrides:

replaceText in class GenericStyledArea<PS,java.lang.String,S>

Parameters:

start - Start index of the range to replace, inclusive.

end - End index of the range to replace, exclusive.

text - The text to put in place of the deleted range. It must not be null.

setText

public void setText(java.lang.String text)

setWrapText

@Deprecated
public void setWrapText(boolean value)

Deprecated.

This is a no op for text fields and therefore marked as deprecated.

Specified by:

setWrapText in interface ViewActions<PS,java.lang.String,S>

Overrides:

setWrapText in class GenericStyledArea<PS,java.lang.String,S>

isWrapText

public boolean isWrapText()

This always returns false for styled text fields.

Specified by:

isWrapText in interface ViewActions<PS,java.lang.String,S>

Overrides:

isWrapText in class GenericStyledArea<PS,java.lang.String,S>

getCssMetaData

public java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getCssMetaData()

Specified by:

getCssMetaData in interface javafx.css.Styleable

Overrides:

getCssMetaData in class GenericStyledArea<PS,java.lang.String,S>

getClassCssMetaData

public static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getClassCssMetaData()