org.eclipse.ui.views.markers
Class MarkerField

java.lang.Object
  
org.eclipse.ui.views.markers.MarkerField

public abstract class MarkerField
extends 
Object

MarkerField is the abstract superclass of the definition of the content providers for columns in a Markers View.

Since:

3.4

Constructor Summary
MarkerField ()

 

Method Summary
Image	annotateImage ( MarkerItem item, Image image)           Annotate the image with indicators for whether or not help or quick fix are available.
int	compare ( MarkerItem item1, MarkerItem item2)           Compare item1 and item2 for sorting purposes.
Image	getColumnHeaderImage ()
String	getColumnHeaderText ()           Return the text to be displayed in the column header for this field.
String	getColumnTooltipText ()           Return the text for the column tooltip.
IConfigurationElement	getConfigurationElement ()           Get the configuration element for the receiver.
int	getDefaultColumnWidth ( Control control)           Get the number of characters that should be reserved for the receiver.
EditingSupport	getEditingSupport ( ColumnViewer viewer)           Return the editing support for entries for this field.
protected   ResourceManager	getImageManager ()           Return the image manager used by the receiver.
abstract   String	getValue ( MarkerItem item)
void	setConfigurationElement ( IConfigurationElement element)           Set the configuration element used by the receiver.
void	setImageManager ( ResourceManager manager)           Set the imageManager.
void	update ( ViewerCell cell)           Update the contents of the cell.

 

Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

MarkerField

public MarkerField()

annotateImage

public 
Image annotateImage(
MarkerItem item,
                           
Image image)

Annotate the image with indicators for whether or not help or quick fix are available.

Parameters:

item - the item being decorated

image - the image being overlaid

Returns:

Image

compare

public int compare(
MarkerItem item1,
                   
MarkerItem item2)

Compare item1 and item2 for sorting purposes.

Parameters:

item1 -

item2 -

Returns:

Either:

a negative number if the value of item1 is less than the value of item2 for this field.

0 if 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.

getColumnHeaderImage

public 
Image getColumnHeaderImage()

Returns:

The image to be displayed in the column header for this field or null.

public 
String getColumnHeaderText()

public 
String getColumnTooltipText()

public final 
IConfigurationElement getConfigurationElement()

public int getDefaultColumnWidth(
Control control)

public 
EditingSupport getEditingSupport(
ColumnViewer viewer)

protected 
ResourceManager getImageManager()

public abstract 
String getValue(
MarkerItem item)

public final void setConfigurationElement(
IConfigurationElement element)

public final void setImageManager(
ResourceManager manager)

public void update(
ViewerCell cell)