org.eclipse.eavp.viz.service.connections.preferences

Interface IVizCellContentProvider

All Known Subinterfaces:

ISecretCellContentProvider, IVizComboCellContentProvider

All Known Implementing Classes:

EntryCellContentProvider, TableComponentCellContentProvider

public interface IVizCellContentProvider

For individual columns in a JFace TableViewer, we often require a CellLabelProvider to generate labels for table cells and an EditingSupport to enable editing the values in those cells. An ICellContentProvider provides the necessary methods to link these to the underlying model so that the code that touches the model resides primarily in the content provider.

Author:

Jordan H. Deyton

Method Summary

Modifier and Type	Method and Description
org.eclipse.swt.graphics.Image	getImage(java.lang.Object element) Gets an Image representing the specified element.
java.lang.String	getText(java.lang.Object element) Gets the string to display for the specified element's cell.
java.lang.String	getToolTipText(java.lang.Object element) Gets the string to display for the specified element's cell tool tip.
java.lang.Object	getValue(java.lang.Object element) Gets the current value associated with the specified element.
boolean	isEnabled(java.lang.Object element) Gets whether or not the specified element's cell should be enabled.
boolean	isValid(java.lang.Object element) Gets whether or not the specified element is a valid Object to be put in a cell.
boolean	setValue(java.lang.Object element, java.lang.Object value) Sets a new value for the specified element.

Method Detail

isValid

boolean isValid(java.lang.Object element)

Gets whether or not the specified element is a valid Object to be put in a cell.

Parameters:

element - The element to test.

Returns:

True if the element is supported by this content provider, false otherwise.

isEnabled

boolean isEnabled(java.lang.Object element)

Gets whether or not the specified element's cell should be enabled.

Parameters:

element - The element to test.

Returns:

True if the element's cell should be enabled, false otherwise.

getText

java.lang.String getText(java.lang.Object element)

Gets the string to display for the specified element's cell.

Parameters:

element - The element that needs a string.

Returns:

A string representing the element. This value should never be null.

getToolTipText

java.lang.String getToolTipText(java.lang.Object element)

Gets the string to display for the specified element's cell tool tip.

Parameters:

element - The element that needs a tool tip.

Returns:

A string representing the element. This value should never be null.

getImage

org.eclipse.swt.graphics.Image getImage(java.lang.Object element)

Gets an Image representing the specified element. This will be placed in its cell.

Parameters:

element - The element that needs a cell Image.

Returns:

An Image for the cell, or null if Image s are not supported.

getValue

java.lang.Object getValue(java.lang.Object element)

Gets the current value associated with the specified element.

Parameters:

element - The element whose value is requested.

Returns:

The value that should be represented in the element's cell, or null if the element is invalid.

setValue

boolean setValue(java.lang.Object element,
                 java.lang.Object value)

Sets a new value for the specified element.

Parameters:

element - The element whose value is being set.

value - The value that should be set for the element. This is expected to match the underlying element's value type.

Returns:

True if the value changed, false otherwise.