Package org.eclipse.jdt.ui.text.java

Class ContentAssistInvocationContext

  • Direct Known Subclasses:
    JavaContentAssistInvocationContext
    public class ContentAssistInvocationContext
extends Object
    Describes the context of an invocation of content assist in a text viewer. The context knows the document, the invocation offset and can lazily compute the identifier prefix preceding the invocation offset. It may know the viewer.

    Subclasses may add information to their environment. For example, source code editors may provide specific context information such as an AST.

    Clients may instantiate and subclass.

    Since:
    3.2

    • Constructor Detail

      • ContentAssistInvocationContext

        public ContentAssistInvocationContext​(ITextViewer viewer,
                                      int offset)
        Creates a new context for the given viewer and offset.
        Parameters:
        viewer - the text viewer that content assist is invoked in
        offset - the offset into the viewer's document where content assist is invoked at

      • ContentAssistInvocationContext

        protected ContentAssistInvocationContext()
        Creates a new context with no viewer or invocation offset set.

      • ContentAssistInvocationContext

        public ContentAssistInvocationContext​(IDocument document,
                                      int offset)
        Creates a new context for the given document and offset.
        Parameters:
        document - the document that content assist is invoked in
        offset - the offset into the document where content assist is invoked at

    • Method Detail

      • getInvocationOffset

        public final int getInvocationOffset()
        Returns the invocation offset.
        Returns:
        the invocation offset

      • getViewer

        public final ITextViewer getViewer()
        Returns the viewer, null if not available.
        Returns:
        the viewer, possibly null

      • getDocument

        public IDocument getDocument()
        Returns the document that content assist is invoked on, or null if not known.
        Returns:
        the document or null

      • equals

        public boolean equals​(Object obj)
        Invocation contexts are equal if they describe the same context and are of the same type. This implementation checks for null values and class equality. Subclasses should extend this method by adding checks for their context relevant fields (but not necessarily cached values).

        Example: 

         class MyContext extends ContentAssistInvocationContext {
        private final Object fState;
        private Object fCachedInfo;

        ...

        public boolean equals(Object obj) {
                if (!super.equals(obj))
                        return false;
                MyContext other= (MyContext) obj;
                return fState.equals(other.fState);
        }
 }

        Subclasses should also extend Object.hashCode().

        Overrides:
        equals in class Object
        Parameters:
        obj -
        Returns:

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object