|
Eclipse JDT Release 3.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.ui.text.java.ContentAssistInvocationContext
public class ContentAssistInvocationContext
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.
Constructor Summary | |
---|---|
protected |
ContentAssistInvocationContext()
Creates a new context with no viewer or invocation offset set. |
|
ContentAssistInvocationContext(IDocument document,
int offset)
Creates a new context for the given document and offset. |
|
ContentAssistInvocationContext(ITextViewer viewer)
Equivalent to ContentAssistInvocationContext(viewer, viewer.getSelectedRange().x). |
|
ContentAssistInvocationContext(ITextViewer viewer,
int offset)
Creates a new context for the given viewer and offset. |
Method Summary | |
---|---|
CharSequence |
computeIdentifierPrefix()
Computes the identifier (as specified by Character.isJavaIdentifierPart(char) ) that
immediately precedes the invocation offset. |
boolean |
equals(Object obj)
Invocation contexts are equal if they describe the same context and are of the same type. |
IDocument |
getDocument()
Returns the document that content assist is invoked on, or null if not known. |
int |
getInvocationOffset()
Returns the invocation offset. |
ITextViewer |
getViewer()
Returns the viewer, null if not available. |
int |
hashCode()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ContentAssistInvocationContext(ITextViewer viewer)
viewer
- the text viewer that content assist is invoked inpublic ContentAssistInvocationContext(ITextViewer viewer, int offset)
viewer
- the text viewer that content assist is invoked inoffset
- the offset into the viewer's document where content assist is invoked atprotected ContentAssistInvocationContext()
public ContentAssistInvocationContext(IDocument document, int offset)
document
- the document that content assist is invoked inoffset
- the offset into the document where content assist is invoked atMethod Detail |
---|
public final int getInvocationOffset()
public final ITextViewer getViewer()
null
if not available.
null
public IDocument getDocument()
null
if not known.
null
public CharSequence computeIdentifierPrefix() throws BadLocationException
Character.isJavaIdentifierPart(char)
) that
immediately precedes the invocation offset.
null
if
there is no document
BadLocationException
- if accessing the document failspublic boolean equals(Object obj)
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()
.
equals
in class Object
obj
-
public int hashCode()
hashCode
in class Object
|
Eclipse JDT Release 3.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2013 IBM Corporation and others. All rights reserved.