org.eclipse.fx.ui.controls.styledtext

Class StyledTextNode

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

org.eclipse.fx.ui.controls.styledtext.StyledTextNode

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class StyledTextNode
extends javafx.scene.layout.Region

A node who allows to decorate the text

Since:

2.0

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<StyledTextNode.DecorationStrategy>	decorationStrategy The current strategy used for decoration
javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint>	fill The paint used to fill the text
javafx.beans.property.IntegerProperty	tabCharAdvance Number of chars to use for tab advance (default is 4)

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

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StyledTextNode.DecorationStrategy A strategy to decorate the text

Field Summary

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 and Description
StyledTextNode(java.lang.String text) Create a new styled text node

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ObjectProperty<StyledTextNode.DecorationStrategy>	decorationStrategyProperty() The current strategy used for decoration
javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint>	fillProperty() The paint used to fill the text
int	getCaretIndexAtPoint(javafx.geometry.Point2D point) Get the caret index at the given point
double	getCharLocation(int index) Find the x coordinate where we the character for the given index starts
javafx.collections.ObservableList<javafx.scene.Node>	getChildren()
static java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getClassCssMetaData()
java.util.List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getCssMetaData()
StyledTextNode.DecorationStrategy	getDecorationStrategy()
javafx.scene.paint.Paint	getFill()
int	getTabCharAdvance()
java.lang.String	getText()
boolean	intersectOffset(int start, int end) Check if the text node intersects with the start and end locations
protected void	layoutChildren()
void	setDecorationStrategy(StyledTextNode.DecorationStrategy strategy) Set a new strategy used for decoration
void	setFill(javafx.scene.paint.Paint color) Set a new paint
void	setTabCharAdvance(int tabCharAdvance) Set a new number for chars to advance for a tab
javafx.beans.property.IntegerProperty	tabCharAdvanceProperty() Number of chars to use for tab advance (default is 4)
java.lang.String	toString()

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, 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, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, 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, containsBounds, 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, 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_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, 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_syncPeer, 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, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

fill

public final javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint> fillProperty

The paint used to fill the text

See Also:

getFill(), setFill(Paint)

decorationStrategy

public final javafx.beans.property.ObjectProperty<StyledTextNode.DecorationStrategy> decorationStrategyProperty

The current strategy used for decoration

See Also:

getDecorationStrategy(), setDecorationStrategy(DecorationStrategy)

tabCharAdvance

public final javafx.beans.property.IntegerProperty tabCharAdvanceProperty

Number of chars to use for tab advance (default is 4)

See Also:

getTabCharAdvance(), setTabCharAdvance(int)

Constructor Detail

StyledTextNode

public StyledTextNode(java.lang.String text)

Create a new styled text node

Parameters:

text - the text

Method Detail

fillProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint> fillProperty()

The paint used to fill the text

See Also:

getFill(), setFill(Paint)

getFill

public final javafx.scene.paint.Paint getFill()

Returns:

the paint used to fill the text

setFill

public final void setFill(javafx.scene.paint.Paint color)

Set a new paint

Parameters:

color - the paint used to fill the text

getClassCssMetaData

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

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 javafx.scene.layout.Region

decorationStrategyProperty

public final javafx.beans.property.ObjectProperty<StyledTextNode.DecorationStrategy> decorationStrategyProperty()

The current strategy used for decoration

See Also:

getDecorationStrategy(), setDecorationStrategy(DecorationStrategy)

getDecorationStrategy

public final StyledTextNode.DecorationStrategy getDecorationStrategy()

Returns:

strategy used for decoration

setDecorationStrategy

public final void setDecorationStrategy(StyledTextNode.DecorationStrategy strategy)

Set a new strategy used for decoration

Parameters:

strategy - the strategy

tabCharAdvanceProperty

public final javafx.beans.property.IntegerProperty tabCharAdvanceProperty()

Number of chars to use for tab advance (default is 4)

See Also:

getTabCharAdvance(), setTabCharAdvance(int)

getTabCharAdvance

public final int getTabCharAdvance()

Returns:

the number of chars to use for tab advance (default is 4)

setTabCharAdvance

public final void setTabCharAdvance(int tabCharAdvance)

Set a new number for chars to advance for a tab

Parameters:

tabCharAdvance - the number of chars to use for tab advance (default is 4)

intersectOffset

public boolean intersectOffset(int start,
                               int end)

Check if the text node intersects with the start and end locations

Parameters:

start - the start

end - the end

Returns:

true if intersects

toString

public java.lang.String toString()

Overrides:

toString in class javafx.scene.Node

getChildren

public javafx.collections.ObservableList<javafx.scene.Node> getChildren()

Overrides:

getChildren in class javafx.scene.Parent

getText

public java.lang.String getText()

Returns:

the text

layoutChildren

protected void layoutChildren()

Overrides:

layoutChildren in class javafx.scene.Parent

getCaretIndexAtPoint

public int getCaretIndexAtPoint(javafx.geometry.Point2D point)

Get the caret index at the given point

Parameters:

point - the point relative to this node

Returns:

the index or -1

getCharLocation

public double getCharLocation(int index)

Find the x coordinate where we the character for the given index starts

Parameters:

index - the index

Returns:

the location or 0 if not found