Interface WSTextBasedEditorPage

    • Method Detail

      • getSelectionStart

        int getSelectionStart()
        Get selection start offset. It is inclusive.
        The selection start offset, 0 based.
      • getSelectionEnd

        int getSelectionEnd()
        Get selection end offset. It is exclusive.
        The selection end offset, 0 based.
      • getSelectedText

        java.lang.String getSelectedText()
        Get the selected text. The text does not contain XML tags for the Author page.
        The selected text or an empty string if no selection is present.
      • getCaretOffset

        int getCaretOffset()
        The current caret offset.
        The caret offset, 0 based.
      • deleteSelection

        void deleteSelection()
        Delete the selected text, if any.
      • hasSelection

        boolean hasSelection()
        Check if the editor page has a selection
        true if there is a selection, false otherwise.
      • selectWord

        void selectWord()
        Select the word at caret, if any.
      • setCaretPosition

        void setCaretPosition​(int offset)
        Move the caret to the specified offset.
        offset - The offset where the caret should be positioned, 0 based.
      • select

        void select​(int startOffset,
                    int endOffset)
        Select the interval between start and end offset.
        startOffset - Inclusive start offset
        endOffset - Exclusive end offset
      • getWordAtCaret

        int[] getWordAtCaret()
        Compute the offsets of the word that contains the caret position.
        An array with the start and end offsets of the word at caret or null if the values couldn't be obtained. The start offset is inclusive and greater or equal than 1. The end offset is also inclusive and less or equal than the content length.
      • getLocationOnScreenAsPoint

        Point getLocationOnScreenAsPoint​(int x,
                                         int y)
        Take relative mouse coordinates and translate then to absolute on-screen coordinates.
        x - The "x" coordinate relative to the viewport origin.
        y - The "y" coordinate relative to the viewport origin.
        A point with the "x" and "y" coordinates relative to the screen. It does not return a null Point.
      • getLocationRelativeToEditorFromScreen

        Point getLocationRelativeToEditorFromScreen​(int x,
                                                    int y)
        Take mouse coordinates relative to the main application frame/display and translate then to coordinates relative to the editing area.
        x - The "x" coordinate which is relative to the main application frame/display.
        y - The "y" coordinate which is relative to the main application frame/display.
        A point with the "x" and "y" coordinates relative to the editing component area. It does not return a null Point. For example an Eclipse org.eclipse.swt.dnd.DropTargetEvent has the x and y coordinates relative to the Display. In order to use API like viewToModelOffset(), the coordinates need to be translated relative to the editing area.
      • modelToViewRectangle

        Rectangle modelToViewRectangle​(int offset)
        Returns a representation of the caret shape for the specified document offset.
        offset - The document offset to get the corresponding caret shape for.
        The caret rectangle shape. It does not return a null Rectangle.
      • viewToModelOffset

        int viewToModelOffset​(int x,
                              int y)
        Get the position in the document corresponding to the point in the editing component.
        x - The "x" coordinate relative to the editing component origin.
        y - The "y" coordinate relative to the editing component origin.
        The offset corresponding to the given point. The method does not return null, instead an undefined view to model info object is returned if a valid one could not be determined.
      • getStartEndOffsets

        int[] getStartEndOffsets​(DocumentPositionedInfo dpInfo)
                          throws javax.swing.text.BadLocationException
        Find the start and end offsets that correspond to a document position information DocumentPositionedInfo.
        dpInfo - The document position information.
        an array of length two containing the start offset at index 0 and the end offset at index 1.
        javax.swing.text.BadLocationException - If the document position info does not correspond to a valid position in document.
      • createAnchor

        Anchor createAnchor​(int offset)
                     throws javax.swing.text.BadLocationException
        Create an anchor at a certain offset in the content of this Text or Author editing mode. The anchor can later be used in the current or in another editing mode to identify an offset particular to it. For example you can create an anchor in the Author editing mode based on an Author-specific offset and then use it in the Text editing mode to identify a specific offset in the Text editing page. A previous created anchor will not be updated dynamically when changes are made in the document so using it later on will not guarantee that it will point exactly at the offset for which it was originally computed.
        offset - The offset in the edited content.
        An implementation independent anchor which indicates to this offset. The anchor is not automatically updated when the content in the document changes.
        javax.swing.text.BadLocationException - When the offset is not valid.
      • getOffsetForAnchor

        int getOffsetForAnchor​(Anchor anchor)
                        throws javax.swing.text.BadLocationException
        Get the offset corresponding to an Anchor which was created either in this editing mode or in another editing mode/page.
        anchor - The anchor.
        The offset in this page's contents corresponding to the Anchor object.
        javax.swing.text.BadLocationException - When there are problems identifying the offset.
      • scrollCaretToVisible

        void scrollCaretToVisible()
        Smart scroll so that the current caret position and some content around it becomes visible.