|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Javadoc processor proposes completions and computes context information for a particular content type.
This interface must be implemented by clients who extend the
org.eclipse.jdt.ui.javadocCompletionProcessor
extension-point
Field Summary | |
---|---|
static int |
RESTRICT_TO_MATCHING_CASE
Flag used by computeCompletionProposals .
|
Method Summary | |
---|---|
IJavaCompletionProposal[] |
computeCompletionProposals(ICompilationUnit cu,
int offset,
int length,
int flags)
Returns the completion proposals based on the specified location within the compilation unit. |
IContextInformation[] |
computeContextInformation(ICompilationUnit cu,
int offset)
Returns information about possible contexts based on the specified location within the compilation unit. |
String |
getErrorMessage()
Returns the reason why this completion processor was unable to produce a completion proposals or context information. |
Field Detail |
public static final int RESTRICT_TO_MATCHING_CASE
computeCompletionProposals
.
Specifies that only proposals should be returned that match
the case of the prefix in the code (value: 1
).
Method Detail |
public IContextInformation[] computeContextInformation(ICompilationUnit cu, int offset)
cu
- the working copy of the compilation unit which
is used to compute the possible contextsoffset
- an offset within the compilation unit for
which context information should be computed
null
if no context could be foundpublic IJavaCompletionProposal[] computeCompletionProposals(ICompilationUnit cu, int offset, int length, int flags)
cu
- the working copy of the compilation unit in which the
completion request has been called.offset
- an offset within the compilation unit for which
completion proposals should be computedlength
- the length of the current selection.flags
- settings for the code assist. Flags as defined in this interface,
e.g. RESTRICT_TO_MATCHING_CASE
.
null
if
no proposals could be foundpublic String getErrorMessage()
null
if no error occurred
|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |