com.ibm.lpex.alef.contentassist
Interface IContextInformation

All Known Implementing Classes:

ContextInformation

public interface IContextInformation

The inferface of context information presented to the user and generated by content assist processors. The interface can be implemented by clients. By default, clients use ContextInformation as the standard implementer of this interface.

See Also:

IContentAssistProcessor

Method Summary

boolean	equals(java.lang.Object object) Compare the given object with this receiver.
java.lang.String	getContextDisplayString() Return the string to be displayed in the list of contexts.
org.eclipse.swt.graphics.Image	getImage() Return the image for this context information.
java.lang.String	getInformationDisplayString() Return the string to be displayed in the tooltip like information popup.

Method Detail

getContextDisplayString

public java.lang.String getContextDisplayString()

Return the string to be displayed in the list of contexts. This method is used to supply a unique presentation for situations where the context is ambiguous. These strings are used to allow the user to select the specific context.

Returns:

the string to be displayed for the context

getImage

public org.eclipse.swt.graphics.Image getImage()

Return the image for this context information. The image will be shown to the left of the display string.

Returns:

the image to be shown or null if no image is desired

getInformationDisplayString

public java.lang.String getInformationDisplayString()

Return the string to be displayed in the tooltip like information popup.

Returns:

the string to be displayed

equals

public boolean equals(java.lang.Object object)

Compare the given object with this receiver. Two context informations are equal if there information display strings and their context display strings are equal.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)