org.eclipse.fx.text.ui

Class TextViewer

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.AnchorPane

org.eclipse.fx.text.ui.TextViewer

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, ITextViewer, ITextViewerExtension, ITextViewerExtension2, ITextViewerExtension4, ITextViewerExtension6, ITextViewerExtension7, ITextViewerExtension8

Direct Known Subclasses:

SourceViewer

public class TextViewer
extends javafx.scene.layout.AnchorPane
implements ITextViewer, ITextViewerExtension, ITextViewerExtension2, ITextViewerExtension4, ITextViewerExtension6, ITextViewerExtension7, ITextViewerExtension8

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextViewer.TextHoverKey Value object used as key in the text hover configuration table.
protected class	TextViewer.WidgetCommand Represents a replace command that brings the text viewer's text widget back in synchronization with text viewer's document after the document has been changed.

Field Summary

Fields

Modifier and Type	Field and Description
protected Position	fMarkPosition
protected java.util.Map<TextViewer.TextHoverKey,ITextHover>	fTextHovers
protected java.util.List	fTextListeners

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

Fields inherited from interface org.eclipse.fx.text.ui.ITextViewerExtension2

DEFAULT_HOVER_STATE_MASK

Constructor Summary

Constructors

Constructor and Description
TextViewer()

Method Summary

Modifier and Type	Method and Description
void	addTextInputListener(ITextInputListener listener)
void	addTextListener(ITextListener listener)
void	addTextPresentationListener(ITextPresentationListener listener) Adds the given text presentation listener to this text viewer.
void	changeTextPresentation(TextPresentation presentation, boolean controlRedraw)
protected void	createControl()
protected IDocumentAdapter	createDocumentAdapter()
protected IDocument	createSlaveDocument(IDocument document) Creates a slave document for the given document if there is a slave document manager associated with this viewer.
protected ISlaveDocumentManager	createSlaveDocumentManager()
protected TextViewerHoverManager	createTextHovermanager()
protected StyledTextArea	createTextWidget()
protected void	fireInputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput)
protected void	fireInputDocumentChanged(IDocument oldInput, IDocument newInput)
protected void	freeSlaveDocument(IDocument slave)
IDocument	getDocument()
protected java.lang.String	getDocumentPartitioning()
java.lang.Object	getInput()
IRewriteTarget	getRewriteTarget()
protected ISlaveDocumentManager	getSlaveDocumentManager()
ITextHover	getTextHover(int offset, int stateMask)
StyledTextArea	getTextWidget()
protected IDocument	getVisibleDocument()
IRegion	getVisibleRegion()
protected void	handleVisibleDocumentAboutToBeChanged(DocumentEvent event)
protected void	handleVisibleDocumentChanged(DocumentEvent event)
protected void	initializeDocumentInformationMapping(IDocument visibleDocument)
protected void	inputChanged(java.lang.Object newInput, java.lang.Object oldInput)
void	invalidateTextPresentation()
void	invalidateTextPresentation(int offset, int length) Invalidates the viewer's text presentation for the given range.
IRegion	modelRange2WidgetRange(IRegion modelRange)
protected StyleRange	modelStyleRange2WidgetStyleRange(StyleRange range)
boolean	overlapsWithVisibleRegion(int start, int length)
protected boolean	redraws()
void	removeTextHovers(java.lang.String contentType) Removes all text hovers for the given content type independent from their state mask.
void	removeTextInputListener(ITextInputListener listener)
void	removeTextListener(ITextListener listener)
void	removeTextPresentationListener(ITextPresentationListener listener) Removes the given text presentation listener from this text viewer.
void	resetVisibleRegion()
void	setDocument(IDocument document)
void	setDocument(IDocument document, int modelRangeOffset, int modelRangeLength)
void	setDocumentPartitioning(java.lang.String partitioning)
void	setInput(java.lang.Object input)
void	setRedraw(boolean redraw)
void	setTextHover(ITextHover textViewerHover, java.lang.String contentType, int stateMask) Sets this viewer's text hover for the given content type and the given state mask.
protected void	setVisibleDocument(IDocument document) Sets this viewer's visible document.
void	setVisibleRegion(int start, int length)
protected boolean	updateSlaveDocument(IDocument slaveDocument, int modelRangeOffset, int modelRangeLength) Updates the given slave document to show the specified range of its master document.
protected void	updateTextListeners(TextViewer.WidgetCommand cmd)
protected boolean	updateVisibleDocument(IDocument visibleDocument, int visibleRegionOffset, int visibleRegionLength) Deprecated. use updateSlaveDocument instead

Methods inherited from class javafx.scene.layout.AnchorPane

clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBottomAnchor, getLeftAnchor, getRightAnchor, getTopAnchor, layoutChildren, setBottomAnchor, setLeftAnchor, setRightAnchor, setTopAnchor

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, 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, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Field Detail

fTextListeners

protected java.util.List fTextListeners

fMarkPosition

protected Position fMarkPosition

fTextHovers

protected java.util.Map<TextViewer.TextHoverKey,ITextHover> fTextHovers

Constructor Detail

TextViewer

public TextViewer()

Method Detail

createControl

protected void createControl()

getTextWidget

public StyledTextArea getTextWidget()

Specified by:

getTextWidget in interface ITextViewer

createTextWidget

protected StyledTextArea createTextWidget()

setInput

public void setInput(java.lang.Object input)

getInput

public java.lang.Object getInput()

setDocumentPartitioning

public void setDocumentPartitioning(java.lang.String partitioning)

getDocumentPartitioning

protected java.lang.String getDocumentPartitioning()

setVisibleDocument

protected void setVisibleDocument(IDocument document)

Sets this viewer's visible document. The visible document represents the visible region of the viewer's input document.

Parameters:

document - the visible document

getDocument

public IDocument getDocument()

Specified by:

getDocument in interface ITextViewer

setDocument

public void setDocument(IDocument document)

Specified by:

setDocument in interface ITextViewer

setDocument

public void setDocument(IDocument document,
                        int modelRangeOffset,
                        int modelRangeLength)

Specified by:

setDocument in interface ITextViewer

createSlaveDocument

protected IDocument createSlaveDocument(IDocument document)

Creates a slave document for the given document if there is a slave document manager associated with this viewer.

Parameters:

document - the master document

Returns:

the newly created slave document

Since:

2.1

updateSlaveDocument

protected boolean updateSlaveDocument(IDocument slaveDocument,
                                      int modelRangeOffset,
                                      int modelRangeLength)
                               throws BadLocationException

Updates the given slave document to show the specified range of its master document.

Parameters:

slaveDocument - the slave document

modelRangeOffset - the offset of the master document range

modelRangeLength - the length of the master document range

Returns:

true if the slave has been adapted successfully

Throws:

BadLocationException - in case the specified range is not valid in the master document

Since:

3.0

updateVisibleDocument

protected boolean updateVisibleDocument(IDocument visibleDocument,
                                        int visibleRegionOffset,
                                        int visibleRegionLength)
                                 throws BadLocationException

Deprecated. use updateSlaveDocument instead

Sets the given slave document to the specified range of its master document.

Parameters:

visibleDocument - the slave document

visibleRegionOffset - the offset of the master document range

visibleRegionLength - the length of the master document range

Returns:

true if the slave has been adapted successfully

Throws:

BadLocationException - in case the specified range is not valid in the master document

Since:

2.1

getVisibleRegion

public IRegion getVisibleRegion()

Specified by:

getVisibleRegion in interface ITextViewer

fireInputDocumentAboutToBeChanged

protected void fireInputDocumentAboutToBeChanged(IDocument oldInput,
                                                 IDocument newInput)

fireInputDocumentChanged

protected void fireInputDocumentChanged(IDocument oldInput,
                                        IDocument newInput)

getVisibleDocument

protected IDocument getVisibleDocument()

freeSlaveDocument

protected void freeSlaveDocument(IDocument slave)

getSlaveDocumentManager

protected ISlaveDocumentManager getSlaveDocumentManager()

createSlaveDocumentManager

protected ISlaveDocumentManager createSlaveDocumentManager()

initializeDocumentInformationMapping

protected void initializeDocumentInformationMapping(IDocument visibleDocument)

inputChanged

protected void inputChanged(java.lang.Object newInput,
                            java.lang.Object oldInput)

createDocumentAdapter

protected IDocumentAdapter createDocumentAdapter()

invalidateTextPresentation

public final void invalidateTextPresentation()

Specified by:

invalidateTextPresentation in interface ITextViewer

updateTextListeners

protected void updateTextListeners(TextViewer.WidgetCommand cmd)

redraws

protected final boolean redraws()

handleVisibleDocumentAboutToBeChanged

protected void handleVisibleDocumentAboutToBeChanged(DocumentEvent event)

handleVisibleDocumentChanged

protected void handleVisibleDocumentChanged(DocumentEvent event)

addTextListener

public void addTextListener(ITextListener listener)

Specified by:

addTextListener in interface ITextViewer

removeTextListener

public void removeTextListener(ITextListener listener)

Specified by:

removeTextListener in interface ITextViewer

addTextInputListener

public void addTextInputListener(ITextInputListener listener)

Specified by:

addTextInputListener in interface ITextViewer

removeTextInputListener

public void removeTextInputListener(ITextInputListener listener)

Specified by:

removeTextInputListener in interface ITextViewer

changeTextPresentation

public void changeTextPresentation(TextPresentation presentation,
                                   boolean controlRedraw)

Specified by:

changeTextPresentation in interface ITextViewer

modelStyleRange2WidgetStyleRange

protected StyleRange modelStyleRange2WidgetStyleRange(StyleRange range)

modelRange2WidgetRange

public IRegion modelRange2WidgetRange(IRegion modelRange)

getRewriteTarget

public IRewriteTarget getRewriteTarget()

setRedraw

public final void setRedraw(boolean redraw)

setVisibleRegion

public void setVisibleRegion(int start,
                             int length)

Specified by:

setVisibleRegion in interface ITextViewer

resetVisibleRegion

public void resetVisibleRegion()

Specified by:

resetVisibleRegion in interface ITextViewer

overlapsWithVisibleRegion

public boolean overlapsWithVisibleRegion(int start,
                                         int length)

Specified by:

overlapsWithVisibleRegion in interface ITextViewer

invalidateTextPresentation

public final void invalidateTextPresentation(int offset,
                                             int length)

Description copied from interface: ITextViewerExtension2

Invalidates the viewer's text presentation for the given range.

Specified by:

invalidateTextPresentation in interface ITextViewerExtension2

Parameters:

offset - the offset of the first character to be redrawn

length - the length of the range to be redrawn

addTextPresentationListener

public void addTextPresentationListener(ITextPresentationListener listener)

Description copied from interface: ITextViewerExtension4

Adds the given text presentation listener to this text viewer. This call has no effect if the listener is already registered with this text viewer.

Specified by:

addTextPresentationListener in interface ITextViewerExtension4

Parameters:

listener - the text presentation listener

removeTextPresentationListener

public void removeTextPresentationListener(ITextPresentationListener listener)

Description copied from interface: ITextViewerExtension4

Removes the given text presentation listener from this text viewer. This call has no effect if the listener is not registered with this text viewer.

Specified by:

removeTextPresentationListener in interface ITextViewerExtension4

Parameters:

listener - the text presentation listener

setTextHover

public void setTextHover(ITextHover textViewerHover,
                         java.lang.String contentType,
                         int stateMask)

Description copied from interface: ITextViewerExtension2

Sets this viewer's text hover for the given content type and the given state mask. If the given text hover is null, any hover installed for the given content type and state mask is removed.

Specified by:

setTextHover in interface ITextViewerExtension2

Parameters:

textViewerHover - the new hover or null

contentType - the type for which the hover is to be registered or unregistered

stateMask - the SWT event state mask; DEFAULT_HOVER_STATE_MASK indicates that the hover is installed as the default hover.

removeTextHovers

public void removeTextHovers(java.lang.String contentType)

Description copied from interface: ITextViewerExtension2

Removes all text hovers for the given content type independent from their state mask.

Note: To remove a hover for a given content type and state mask use ITextViewerExtension2.setTextHover(ITextHover, String, int) with null as parameter for the text hover.

Specified by:

removeTextHovers in interface ITextViewerExtension2

Parameters:

contentType - the type for which all text hovers are to be unregistered

getTextHover

public ITextHover getTextHover(int offset,
                               int stateMask)

createTextHovermanager

protected TextViewerHoverManager createTextHovermanager()