Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

SWT LPEX
v3.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.lpex.alef.contentassist
Interface IContextInformation

All Known Implementing Classes:

ContextInformation

public interface IContextInformation

The interface for context information presented to the user and generated by content-assist processors. The interface can be implemented by clients. Clients may use the default ContextInformation implementation of this interface.

This is the LPEX version of org.eclipse.jface.text.contentassist.IContextInformation.

See Also:

IContentAssistProcessor

Method Summary

boolean	equals(Object object) Compare the given object with this receiver.
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.
String	getInformationDisplayString() Return the string to be displayed in the tooltip-like information popup.

Method Detail

getContextDisplayString

public 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 String getInformationDisplayString()

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

equals

public boolean equals(Object object)

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