Eclipse Platform
Release 3.2

org.eclipse.jface.fieldassist
Interface IContentProposal


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.

Since:
3.2

Method Summary
 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

public String getContent()
Return the content represented by this proposal.

Returns:
the String content represented by this proposal.

getCursorPosition

public 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.

getLabel

public 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

public 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.

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.