org.eclipse.jface.fieldassist

Interface IContentProposal

All Known Implementing Classes:

ContentProposal

public interface IContentProposal

IContentProposal describes a content proposal to be shown. It consists of the content that will be provided if the proposal is accepted, an optional label used to describe the content to the user, and an optional description that further elaborates the meaning of the proposal. It also includes a a zero-based index position within the contents where the cursor should be placed after a proposal is accepted.

Since:

3.2

See Also:

ContentProposal

Method Summary

Modifier and Type	Method and Description
String	getContent() Return the content represented by this proposal.
int	getCursorPosition() Return the integer position within the contents that the cursor should be placed after the proposal is accepted.
String	getDescription() Return a description that describes this proposal.
String	getLabel() Return the label used to describe this proposal.

Method Detail

getContent

String getContent()

Return the content represented by this proposal.

Returns:

the String content represented by this proposal.

getCursorPosition

int getCursorPosition()

Return the integer position within the contents that the cursor should be placed after the proposal is accepted.

Returns:

the zero-based index position within the contents where the cursor should be placed after the proposal is accepted. The range of the cursor position is from 0..N where N is the number of characters in the contents.

getLabel

String getLabel()

Return the label used to describe this proposal.

Returns:

the String label used to display the proposal. If null, then the content will be displayed as the label.

getDescription

String getDescription()

Return a description that describes this proposal.

Returns:

the String label used to further the proposal. If null, then no description will be displayed.