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

Class TableComponentCellContentProvider

java.lang.Object

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

All Implemented Interfaces:

IVizCellContentProvider

public class TableComponentCellContentProvider
extends java.lang.Object
implements IVizCellContentProvider

This class provides the content for cells in a JFace viewer when the underlying data is a TableComponent.

This class is designed so that a single backing content provider can be re-used for each column in a table, as all elements in a TableComponent are the same data structure (see Entry).

The element object passed to instances of this content provider is expected to be a List of Entrys.

Author:

Jordan Deyton

Constructor Summary

Constructors

Constructor and Description
TableComponentCellContentProvider(IVizCellContentProvider contentProvider, int index) The default constructor.

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableComponentCellContentProvider

public TableComponentCellContentProvider(IVizCellContentProvider contentProvider,
                                         int index)

The default constructor.

Parameters:

contentProvider - The underlying content provider used for each cell in the JFace viewer.

index - The column index for this provider. This provider expects a row (which should be a List) as input, and this index specifies which column in that row provides the real content for the cell.

Method Detail

getImage

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

Description copied from interface: IVizCellContentProvider

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

Specified by:

getImage in interface IVizCellContentProvider

Parameters:

element - The element that needs a cell Image.

Returns:

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

getText

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

Description copied from interface: IVizCellContentProvider

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

Specified by:

getText in interface IVizCellContentProvider

Parameters:

element - The element that needs a string.

Returns:

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

getToolTipText

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

Description copied from interface: IVizCellContentProvider

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

Specified by:

getToolTipText in interface IVizCellContentProvider

Parameters:

element - The element that needs a tool tip.

Returns:

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

getValue

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

Description copied from interface: IVizCellContentProvider

Gets the current value associated with the specified element.

Specified by:

getValue in interface IVizCellContentProvider

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.

isEnabled

public boolean isEnabled(java.lang.Object element)

Description copied from interface: IVizCellContentProvider

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

Specified by:

isEnabled in interface IVizCellContentProvider

Parameters:

element - The element to test.

Returns:

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

isValid

public boolean isValid(java.lang.Object element)

Description copied from interface: IVizCellContentProvider

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

Specified by:

isValid in interface IVizCellContentProvider

Parameters:

element - The element to test.

Returns:

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

setValue

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

Description copied from interface: IVizCellContentProvider

Sets a new value for the specified element.

Specified by:

setValue in interface IVizCellContentProvider

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.