jACOB 2.7 API Documentation.

de.tif.jacob.screen
Interface ILabelProvider

All Known Implementing Classes:
RecordLabelProvider

public interface ILabelProvider

Provide the text and/or image for the label of a given element. Used by most structured viewers, except browsers.


Method Summary
 java.lang.String getImage(IClientContext context, java.lang.Object element)
          Returns the resource name of the image for the label of the given element.
 java.lang.String getText(IClientContext context, java.lang.Object element)
          Returns the text for the label of the given element.
 

Method Detail

getImage

java.lang.String getImage(IClientContext context,
                          java.lang.Object element)
Returns the resource name of the image for the label of the given element.
The image must be stored in the java package jacob.resources.*
Example: if you return Task you must provide an image named Task.png or Task.gif in the java package jacob.resources.*

Parameters:
element - the element for which to provide the label image
Returns:
the resource name of the image, or null if there is no image for the given object

getText

java.lang.String getText(IClientContext context,
                         java.lang.Object element)
Returns the text for the label of the given element.

Parameters:
element - the element for which to provide the label text
Returns:
the text string used to label the element, or null if there is no text label for the given object

jACOB 2.7 API Documentation.