| org.eclipse.jdt.ui.text.java.IJavadocCompletionProcessor
IJavadocCompletionProcessor | public interface IJavadocCompletionProcessor (Code) | | 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 .
since: 2.1 |
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.
Parameters: cu - the working copy of the compilation unit in which thecompletion request has been called. Parameters: offset - an offset within the compilation unit for whichcompletion proposals should be computed Parameters: length - the length of the current selection. Parameters: flags - settings for the code assist. | 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. |
RESTRICT_TO_MATCHING_CASE | int RESTRICT_TO_MATCHING_CASE(Code) | | Flag used by computeCompletionProposals .
Specifies that only proposals should be returned that match
the case of the prefix in the code (value: 1 ).
|
computeCompletionProposals | IJavaCompletionProposal[] computeCompletionProposals(ICompilationUnit cu, int offset, int length, int flags)(Code) | | Returns the completion proposals based on the specified location
within the compilation unit.
Parameters: cu - the working copy of the compilation unit in which thecompletion request has been called. Parameters: offset - an offset within the compilation unit for whichcompletion proposals should be computed Parameters: length - the length of the current selection. Parameters: flags - settings for the code assist. Flags as defined in this interface,e.g. RESTRICT_TO_MATCHING_CASE . an array of completion proposals or null ifno proposals could be found |
computeContextInformation | IContextInformation[] computeContextInformation(ICompilationUnit cu, int offset)(Code) | | Returns information about possible contexts based on the
specified location within the compilation unit.
Parameters: cu - the working copy of the compilation unit whichis used to compute the possible contexts Parameters: offset - an offset within the compilation unit forwhich context information should be computed an array of context information objects or null if no context could be found |
getErrorMessage | String getErrorMessage()(Code) | | Returns the reason why this completion processor was unable
to produce a completion proposals or context information.
an error message or null if no error occurred |
|
|