Interface IContentAssistSubjectControl

    • Method Detail

      • getControl

        Control getControl()
        Returns the control of this content assist subject control.
        Returns:
        the control of this content assist subject control
      • getCaretOffset

        int getCaretOffset()
        Returns the caret position relative to the start of the text in widget coordinates.
        Returns:
        the caret position relative to the start of the text in widget coordinates
        Throws:
        SWTException - in these cases:
      • getLocationAtOffset

        Point getLocationAtOffset​(int offset)
        Returns the x, y location of the upper left corner of the character bounding box at the specified offset in the text. The point is relative to the upper left corner of the widget client area.
        Parameters:
        offset - widget offset relative to the start of the content 0 <= offset >= getCharCount()
        Returns:
        x, y location of the upper left corner of the character bounding box at the specified offset in the text
        Throws:
        SWTException - in these cases:
        IllegalArgumentException - when the offset is outside the valid range
      • getLineDelimiter

        String getLineDelimiter()
        Returns the line delimiter used for entering new lines by key down or paste operation.
        Returns:
        line delimiter used for entering new lines by key down or paste operation
        Throws:
        SWTException - in these cases:
      • getWidgetSelectionRange

        Point getWidgetSelectionRange()
        Returns the selected range in the subject's widget.
        Returns:
        start and length of the selection, x is the offset of the
        Throws:
        SWTException - in these cases:
      • getSelectedRange

        Point getSelectedRange()
        Returns the selected range.
        Returns:
        start and length of the selection, x is the offset and y the length based on the subject's model (e.g. document)
      • setSelectedRange

        void setSelectedRange​(int offset,
                              int length)
        Sets the selected range. Offset and length based on the subject's model (e.g. document).
        Parameters:
        offset - the offset of the selection based on the subject's model e.g. document
        length - the length of the selection based on the subject's model e.g. document
      • revealRange

        void revealRange​(int offset,
                         int length)
        Reveals the given region. Offset and length based on the subject's model (e.g. document).
        Parameters:
        offset - the offset of the selection based on the subject's model e.g. document
        length - the length of the selection based on the subject's model e.g. document
      • getDocument

        IDocument getDocument()
        Returns this content assist subject control's document.
        Returns:
        the viewer's input document
      • appendVerifyKeyListener

        boolean appendVerifyKeyListener​(VerifyKeyListener verifyKeyListener)
        If supported, appends a verify key listener to the viewer's list of verify key listeners. If the listener is already registered with the viewer this call moves the listener to the end of the list.

        Note: This content assist subject control may not support appending a verify listener, in which case false will be returned. If this content assist subject control only supports addVerifyKeyListener then this method can be used but prependVerifyKeyListener must return false.

        Parameters:
        verifyKeyListener - the listener to be added
        Returns:
        true if the listener was added
      • prependVerifyKeyListener

        boolean prependVerifyKeyListener​(VerifyKeyListener verifyKeyListener)
        If supported, inserts the verify key listener at the beginning of this content assist subject's list of verify key listeners. If the listener is already registered with the viewer this call moves the listener to the beginning of the list.

        Note: This content assist subject control may not support prepending a verify listener, in which case false will be returned. However, appendVerifyKeyListener(VerifyKeyListener) might work.

        Parameters:
        verifyKeyListener - the listener to be inserted
        Returns:
        true if the listener was added
      • removeVerifyKeyListener

        void removeVerifyKeyListener​(VerifyKeyListener verifyKeyListener)
        Removes the verify key listener from this content assist subject control's list of verify key listeners. If the listener is not registered, this call has no effect.
        Parameters:
        verifyKeyListener - the listener to be removed
      • supportsVerifyKeyListener

        boolean supportsVerifyKeyListener()
        Tests whether a verify key listener can be added either using prependVerifyKeyListener or appendVerifyKeyListener(VerifyKeyListener).
        Returns:
        true if adding verify key listeners is supported
      • setEventConsumer

        void setEventConsumer​(IEventConsumer eventConsumer)
        If supported, registers an event consumer with this content assist subject.
        Parameters:
        eventConsumer - the content assist subject control's event consumer. null is a valid argument.
      • addSelectionListener

        boolean addSelectionListener​(SelectionListener selectionListener)
        If supported, adds a selection listener. A Selection event is sent by the widget when the selection has changed.

        Parameters:
        selectionListener - the listener
        Returns:
        true if adding a selection listener is supported
        Throws:
        IllegalArgumentException - if listener is null