Package org.eclipse.ui.views.markers
Class MarkerField
java.lang.Object
org.eclipse.ui.views.markers.MarkerField
MarkerField is the abstract superclass of the definition of the content
providers for columns in a Markers View.
- Since:
- 3.4
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionannotateImage(MarkerItem item, Image image) Annotate the image with indicators for whether or not help or quick fix are available.intcompare(MarkerItem item1, MarkerItem item2) Compare item1 and item2 for sorting purposes.Return the text to be displayed in the column header for this field.Return the text for the column tooltip.final IConfigurationElementGet the configuration element for the receiver.intgetDefaultColumnWidth(Control control) Get the number of characters that should be reserved for the receiver.getEditingSupport(ColumnViewer viewer) Return the editing support for entries for this field.protected ResourceManagerReturn the image manager used by the receiver.getName()Return the name of this field.abstract StringgetValue(MarkerItem item) final voidSet the configuration element used by the receiver.final voidsetImageManager(ResourceManager manager) Set the imageManager.toString()voidupdate(ViewerCell cell) Update the contents of the cell.
-
Constructor Details
-
MarkerField
public MarkerField()
-
-
Method Details
-
annotateImage
Annotate the image with indicators for whether or not help or quick fix are available.- Parameters:
item- the item being decoratedimage- the image being overlaid- Returns:
- Image
-
compare
Compare item1 and item2 for sorting purposes.- Parameters:
item1- first itemitem2- second item- Returns:
- Either:
- a negative number if the value of item1 is less than the value of item2 for this field.
0if the value of item1 and the value of item2 are equal for this field.- a positive number if the value of item1 is greater than the value of item2 for this field.
- See Also:
-
getColumnHeaderImage
- Returns:
- The image to be displayed in the column header for this field or
null.
-
getColumnHeaderText
Return the text to be displayed in the column header for this field.- Returns:
- String
- See Also:
-
getName
Return the name of this field.- Returns:
- String
- Since:
- 3.6
-
getColumnTooltipText
Return the text for the column tooltip.- Returns:
- String
- See Also:
-
getConfigurationElement
Get the configuration element for the receiver. This is used by the markerSupport internals to retrieve the values defined in the extension.- Returns:
- IConfigurationElement
-
getDefaultColumnWidth
Get the number of characters that should be reserved for the receiver.- Parameters:
control- the control to scale from- Returns:
- int
-
getEditingSupport
Return the editing support for entries for this field. Return null if it cannot be in-line edited.- Parameters:
viewer- the viewer this will be applied to- Returns:
EditingSupportornull.
-
getImageManager
Return the image manager used by the receiver.- Returns:
- ResourceManager
-
getValue
- Parameters:
item- the object- Returns:
- The String value of the object for this particular field to be displayed to the user.
-
setConfigurationElement
Set the configuration element used by the receiver.- Parameters:
element- the element
-
setImageManager
Set the imageManager. This is not normally required to be send if using aMarkerSupportViewas this is done for you.- Parameters:
manager- the image manager
-
update
Update the contents of the cell.- Parameters:
cell- cell to update; notnull
-
toString
-