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

Class EntryCellContentProvider

java.lang.Object

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

All Implemented Interfaces:

ISecretCellContentProvider, IVizCellContentProvider, IVizComboCellContentProvider

public class EntryCellContentProvider
extends java.lang.Object
implements IVizCellContentProvider, IVizComboCellContentProvider, ISecretCellContentProvider

This class provides a basic JFace content provider that wraps an ICE Entry. The text and value for an Entry are considered the same thing, while the tooltip is the Entry's description.

Author:

Jordan Deyton

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.service.connections.preferences.ISecretCellContentProvider

PUBLIC_CHAR, SECRET_CHAR

Constructor Summary

Constructors

Constructor and Description
EntryCellContentProvider()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllowedValues(java.lang.Object element) Gets the Entry's allowed values, or an empty list if it has none.
org.eclipse.swt.graphics.Image	getImage(java.lang.Object element) Returns null for no Image.
char	getSecretChar() Gets the default secret character used to obscure text.
java.lang.String	getText(java.lang.Object element) Returns the value, which is converted to a string, of the Entry.
java.lang.String	getToolTipText(java.lang.Object element) Returns the description of the Entry.
java.lang.Object	getValue(java.lang.Object element) Returns the Entry's value.
boolean	isEnabled(java.lang.Object element) By default, any valid Entry is enabled.
boolean	isSecret(java.lang.Object element) An Entry should be obscured if its "secret" flag is true.
boolean	isValid(java.lang.Object element) By default, any Entry that is not null is valid.
boolean	requiresCombo(java.lang.Object element) An Entry requires a combo widget if its AllowedValueType is discrete.
boolean	setValue(java.lang.Object element, java.lang.Object value) Converts the value to a string and sets it as the Entry's value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryCellContentProvider

public EntryCellContentProvider()

Method Detail

getAllowedValues

public java.util.List<java.lang.String> getAllowedValues(java.lang.Object element)

Gets the Entry's allowed values, or an empty list if it has none.

Specified by:

getAllowedValues in interface IVizComboCellContentProvider

Parameters:

element - The element whose allowed values are being requested.

Returns:

A list containing the allowed values for the element, or an empty list if the element is invalid or does not restrict its allowed values.

See Also:

IVizComboCellContentProvider.requiresCombo(Object)

getImage

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

Returns null for no Image.

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.

getSecretChar

public char getSecretChar()

Gets the default secret character used to obscure text.

Specified by:

getSecretChar in interface ISecretCellContentProvider

Returns:

The "echo" character used for obscured or secret text.

getText

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

Returns the value, which is converted to a string, of the Entry.

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)

Returns the description of the Entry.

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)

Returns the Entry's value.

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)

By default, any valid Entry is 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.

isSecret

public boolean isSecret(java.lang.Object element)

An Entry should be obscured if its "secret" flag is true.

Specified by:

isSecret in interface ISecretCellContentProvider

Parameters:

element - The element to test.

Returns:

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

isValid

public boolean isValid(java.lang.Object element)

By default, any Entry that is not null is valid.

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.

requiresCombo

public boolean requiresCombo(java.lang.Object element)

An Entry requires a combo widget if its AllowedValueType is discrete.

Specified by:

requiresCombo in interface IVizComboCellContentProvider

Parameters:

element - The element to test.

Returns:

True if the element has multiple allowed values that could displayed in a Combo widget, false otherwise.

See Also:

IVizComboCellContentProvider.getAllowedValues(Object)

setValue

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

Converts the value to a string and sets it as the Entry's value.

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.