org.eclipse.fx.ui.controls.styledtext

Class StyledTextArea

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

org.eclipse.fx.ui.controls.styledtext.StyledTextArea

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class StyledTextArea
extends javafx.scene.control.Control

Control which allows to implemented a code-editor

Property Summary

Type	Property and Description
@NonNull javafx.beans.property.IntegerProperty	caretOffset The current caret offset
@NonNull javafx.beans.property.ObjectProperty<StyledTextContent>	content The content property
@NonNull javafx.beans.property.BooleanProperty	editable The editable property Default is true
@NonNull javafx.beans.property.BooleanProperty	lineRulerVisible Show a line ruler on the left Default is false
@NonNull javafx.beans.property.ObjectProperty<TextSelection>	selection

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

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 class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
StyledTextArea() Create a new control

Method Summary

Modifier and Type	Method and Description
@NonNull javafx.beans.property.IntegerProperty	caretOffsetProperty() The current caret offset
void	clearSelection() Clear the current selection
@NonNull javafx.beans.property.ObjectProperty<StyledTextContent>	contentProperty() The content property
void	copy() Copy the current selection into the clipboard
protected javafx.scene.control.Skin<?>	createDefaultSkin()
@NonNull javafx.beans.property.BooleanProperty	editableProperty() The editable property Default is true
int	getCaretOffset()
int	getCharCount()
@NonNull StyledTextContent	getContent() Access the content
boolean	getEditable() Check if editable Default is true
int	getLineAtOffset(int caretOffset) Get the line index for the caret
double	getLineHeight(int offset) Get the line height
@Nullable javafx.geometry.Point2D	getLocationAtOffset(int offset) Check the location at the given offset
int	getOffsetAtLine(int lineNumber) Get the initial offset of the line
@NonNull TextSelection	getSelection()
StyleRange	getStyleRangeAtOffset(int offset) The style range at the given offset
StyleRange[]	getStyleRanges(int start, int length, boolean includeRanges) Access style ranges in the specified segment
@NonNull java.lang.String	getText(int start, int end) Get the text for the given range
boolean	isLineRulerVisible() Is line ruler shown Default is false
@NonNull javafx.beans.property.BooleanProperty	lineRulerVisibleProperty() Show a line ruler on the left Default is false
void	paste() Paste the clipboard content
void	replaceStyleRanges(int start, int length, @Nullable StyleRange[] ranges) Replace style ranges
@NonNull javafx.beans.property.ObjectProperty<TextSelection>	selectionProperty()
void	setCaretOffset(int offset) Set the current caret offset
void	setCaretOffset(int offset, boolean selection) Setting the caret offset and updateing the selection if requested
void	setContent(@NonNull StyledTextContent content) Set the content
void	setEditable(boolean editable) Mark the editor editable Default is true
void	setLineRulerVisible(boolean lineRulerVisible) Show/hide the line ruler Default is false
void	setSelection(@NonNull TextSelection selection) Set the current selection
void	setSelectionRange(int offset, int length) Set the selection
void	setStyleRange(@Nullable StyleRange range) Set the style range
void	setStyleRanges(@Nullable int[] ranges, @Nullable StyleRange[] styles) Set the style ranges
void	setStyleRanges(int start, int length, @Nullable int[] ranges, @Nullable StyleRange[] styles) Set the style range
void	setStyleRanges(@Nullable StyleRange[] ranges) Set the style ranges

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, getUserAgentStylesheet, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

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_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, 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

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, applyCss, 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, 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_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, 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

Property Detail

lineRulerVisible

public @NonNull javafx.beans.property.BooleanProperty lineRulerVisibleProperty

Show a line ruler on the left

Default is false

See Also:

isLineRulerVisible(), setLineRulerVisible(boolean)

caretOffset

public @NonNull javafx.beans.property.IntegerProperty caretOffsetProperty

The current caret offset

See Also:

getCaretOffset(), setCaretOffset(int)

content

public @NonNull javafx.beans.property.ObjectProperty<StyledTextContent> contentProperty

The content property

See Also:

getContent(), setContent(StyledTextContent)

selection

public @NonNull javafx.beans.property.ObjectProperty<TextSelection> selectionProperty

See Also:

getSelection(), setSelection(TextSelection)

editable

public @NonNull javafx.beans.property.BooleanProperty editableProperty

The editable property

Default is true

See Also:

getEditable(), setEditable(boolean)

Constructor Detail

StyledTextArea

public StyledTextArea()

Create a new control

Method Detail

createDefaultSkin

protected javafx.scene.control.Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class javafx.scene.control.Control

lineRulerVisibleProperty

public @NonNull javafx.beans.property.BooleanProperty lineRulerVisibleProperty()

Show a line ruler on the left

Default is false

See Also:

isLineRulerVisible(), setLineRulerVisible(boolean)

setLineRulerVisible

public void setLineRulerVisible(boolean lineRulerVisible)

Show/hide the line ruler

Default is false

Parameters:

lineRulerVisible - the new state

isLineRulerVisible

public boolean isLineRulerVisible()

Is line ruler shown

Default is false

Returns:

the current state

caretOffsetProperty

public @NonNull javafx.beans.property.IntegerProperty caretOffsetProperty()

The current caret offset

See Also:

getCaretOffset(), setCaretOffset(int)

setCaretOffset

public void setCaretOffset(int offset)

Set the current caret offset

Parameters:

offset - the new offset

setCaretOffset

public void setCaretOffset(int offset,
                           boolean selection)

Setting the caret offset and updateing the selection if requested

Parameters:

offset - the offset

selection - true to update the current selection

getCaretOffset

public int getCaretOffset()

Returns:

the current caret offset

setContent

public void setContent(@NonNull StyledTextContent content)

Set the content

Parameters:

content - the content

getContent

public @NonNull StyledTextContent getContent()

Access the content

Returns:

the content

contentProperty

public @NonNull javafx.beans.property.ObjectProperty<StyledTextContent> contentProperty()

The content property

See Also:

getContent(), setContent(StyledTextContent)

setStyleRange

public void setStyleRange(@Nullable StyleRange range)

Set the style range

Parameters:

range - the range

setStyleRanges

public void setStyleRanges(int start,
                           int length,
                           @Nullable int[] ranges,
                           @Nullable StyleRange[] styles)

Set the style range

Parameters:

start - the start

length - the length

ranges - the ranges

styles - the style ranges

setStyleRanges

public void setStyleRanges(@Nullable int[] ranges,
                           @Nullable StyleRange[] styles)

Set the style ranges

Parameters:

ranges - the ranges

styles - the style ranges

setStyleRanges

public void setStyleRanges(@Nullable StyleRange[] ranges)

Set the style ranges

Parameters:

ranges - the ranges

replaceStyleRanges

public void replaceStyleRanges(int start,
                               int length,
                               @Nullable StyleRange[] ranges)

Replace style ranges

Parameters:

start - the start

length - the length

ranges - the new ranges

getStyleRanges

public StyleRange[] getStyleRanges(int start,
                                   int length,
                                   boolean includeRanges)

Access style ranges in the specified segment

Parameters:

start - the start

length - the length

includeRanges - include ranges

Returns:

the ranges

getStyleRangeAtOffset

public StyleRange getStyleRangeAtOffset(int offset)

The style range at the given offset

Parameters:

offset - the offset

Returns:

the style range

getCharCount

public int getCharCount()

Returns:

the current char count

getSelection

public @NonNull TextSelection getSelection()

Returns:

the current selection

selectionProperty

public @NonNull javafx.beans.property.ObjectProperty<TextSelection> selectionProperty()

See Also:

getSelection(), setSelection(TextSelection)

setSelection

public void setSelection(@NonNull TextSelection selection)

Set the current selection

Parameters:

selection - the selection

clearSelection

public void clearSelection()

Clear the current selection

setSelectionRange

public void setSelectionRange(int offset,
                              int length)

Set the selection

Parameters:

offset - the offset

length - the length

setEditable

public void setEditable(boolean editable)

Mark the editor editable

Default is true

Parameters:

editable - the new value

getEditable

public boolean getEditable()

Check if editable

Default is true

Returns:

the current value

editableProperty

public @NonNull javafx.beans.property.BooleanProperty editableProperty()

The editable property

Default is true

See Also:

getEditable(), setEditable(boolean)

getLocationAtOffset

public @Nullable javafx.geometry.Point2D getLocationAtOffset(int offset)

Check the location at the given offset

Parameters:

offset - the offset

Returns:

the point

getLineHeight

public double getLineHeight(int offset)

Get the line height

Parameters:

offset - the offset

Returns:

the height

getLineAtOffset

public int getLineAtOffset(int caretOffset)

Get the line index for the caret

Parameters:

caretOffset - the caret offset

Returns:

the line index

getOffsetAtLine

public int getOffsetAtLine(int lineNumber)

Get the initial offset of the line

Parameters:

lineNumber - the line number

Returns:

the offset

getText

public @NonNull java.lang.String getText(int start,
                                         int end)

Get the text for the given range

Parameters:

start - the start

end - the end

Returns:

the text

paste

public void paste()

Paste the clipboard content

copy

public void copy()

Copy the current selection into the clipboard