Package org.exbin.bined.capability

Interface CaretCapable

  • @ParametersAreNonnullByDefault
public interface CaretCapable
    Support for caret / cursor capability.

    • Method Detail

      • getCaretPosition

        @Nonnull
CodeAreaCaretPosition getCaretPosition()
        Returns current caret position.
        Returns:
        caret position

      • getActiveSection

        @Nonnull
CodeAreaSection getActiveSection()
        Returns currently active caret section.
        Returns:
        code area section

      • getDataPosition

        long getDataPosition()
        Returns current caret data position.
        Returns:
        data position

      • getCodeOffset

        int getCodeOffset()
        Returns current caret code offset.
        Returns:
        code offset

      • setCaretPosition

        void setCaretPosition​(CodeAreaCaretPosition caretPosition)
        Sets current caret position to given position.
        Parameters:
        caretPosition - caret position

      • setCaretPosition

        void setCaretPosition​(long dataPosition)
        Sets current caret position to given data position.
        Parameters:
        dataPosition - data position

      • setCaretPosition

        void setCaretPosition​(long dataPosition,
                      int codeOffset)
        Sets current caret position to given data position and offset.
        Parameters:
        dataPosition - data position
        codeOffset - code offset

      • getCaret

        @Nonnull
CodeAreaCaret getCaret()
        Returns handler for caret.
        Returns:
        caret handler

      • mousePositionToClosestCaretPosition

        @Nonnull
CodeAreaCaretPosition mousePositionToClosestCaretPosition​(int positionX,
                                                          int positionY,
                                                          CaretOverlapMode overflowMode)
        Computes closest caret position for given relative component position.
        Parameters:
        positionX - x-coordinate
        positionY - y-coordinate
        overflowMode - overflow mode
        Returns:
        mouse position

      • isShowMirrorCursor

        boolean isShowMirrorCursor()
        Returns if cursor should be visible in other sections.
        Returns:
        true if cursor should be mirrored

      • setShowMirrorCursor

        void setShowMirrorCursor​(boolean showMirrorCursor)
        Sets if cursor should be visible in other sections.
        Parameters:
        showMirrorCursor - true if cursor should be mirrored

      • getMouseCursorShape

        int getMouseCursorShape​(int positionX,
                        int positionY)
        Returns cursor shape type for given position.
        Parameters:
        positionX - x-coordinate
        positionY - y-coordinate
        Returns:
        cursor type from java.awt.Cursor

      • addCaretMovedListener

        void addCaretMovedListener​(CaretMovedListener caretMovedListener)
        Adds caret movement listener.
        Parameters:
        caretMovedListener - listener

      • removeCaretMovedListener

        void removeCaretMovedListener​(CaretMovedListener caretMovedListener)
        Removes caret movement listener.
        Parameters:
        caretMovedListener - listener