Class ContextInformation
java.lang.Object
org.eclipse.jface.text.contentassist.ContextInformation
- All Implemented Interfaces:
IContextInformation
A default implementation of the
IContextInformation interface.-
Constructor Summary
ConstructorsConstructorDescriptionContextInformation(String contextDisplayString, String informationDisplayString) Creates a new context information without an image.ContextInformation(Image image, String contextDisplayString, String informationDisplayString) Creates a new context information with an image. -
Method Summary
-
Constructor Details
-
ContextInformation
Creates a new context information without an image.- Parameters:
contextDisplayString- the string to be used when presenting the contextinformationDisplayString- the string to be displayed when presenting the context information
-
ContextInformation
public ContextInformation(Image image, String contextDisplayString, String informationDisplayString) Creates a new context information with an image.- Parameters:
image- the image to display when presenting the context informationcontextDisplayString- the string to be used when presenting the contextinformationDisplayString- the string to be displayed when presenting the context information, may not benull
-
-
Method Details
-
equals
Description copied from interface:IContextInformationCompares the given object with this receiver. Two context informations are equal if there information display strings and their context display strings are equal.Note: As specified in
Object.equals(Object)clients will most likely also have to implementObject.hashCode().- Specified by:
equalsin interfaceIContextInformation- Overrides:
equalsin classObject- See Also:
-
hashCode
public int hashCode() -
getInformationDisplayString
Description copied from interface:IContextInformationReturns the string to be displayed in the tool tip like information popup.- Specified by:
getInformationDisplayStringin interfaceIContextInformation- Returns:
- the string to be displayed
-
getImage
Description copied from interface:IContextInformationReturns the image for this context information. The image will be shown to the left of the display string.- Specified by:
getImagein interfaceIContextInformation- Returns:
- the image to be shown or
nullif no image is desired
-
getContextDisplayString
Description copied from interface:IContextInformationReturns 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.- Specified by:
getContextDisplayStringin interfaceIContextInformation- Returns:
- the string to be displayed for the context
-