org.eclipse.nebula.widgets.nattable.config

Interface IConfigRegistry

All Known Implementing Classes:

ConfigRegistry

public interface IConfigRegistry

Holds all the settings, bindings and other configuration for NatTable.

See ConfigRegistryTest for a better understanding.

See Also:

ConfigRegistry

Method Summary

Modifier and Type	Method and Description
<T> T	getConfigAttribute(ConfigAttribute<T> configAttribute, String targetDisplayMode, List<String> configLabels)
<T> T	getConfigAttribute(ConfigAttribute<T> configAttribute, String targetDisplayMode, String... configLabels) If retrieving registered values
IDisplayModeOrdering	getDisplayModeOrdering()
<T> T	getSpecificConfigAttribute(ConfigAttribute<T> configAttribute, String displayMode, String configLabel)
<T> void	registerConfigAttribute(ConfigAttribute<T> configAttribute, T attributeValue) Register a configuration attribute.
<T> void	registerConfigAttribute(ConfigAttribute<T> configAttribute, T attributeValue, String targetDisplayMode) Register a configuration attribute against a DisplayMode.
<T> void	registerConfigAttribute(ConfigAttribute<T> configAttribute, T attributeValue, String targetDisplayMode, String configLabel) Register an attribute against a DisplayMode and configuration label (applied to cells)
<T> void	unregisterConfigAttribute(ConfigAttribute<T> configAttributeType) Unregister the given configuration attribute.
<T> void	unregisterConfigAttribute(ConfigAttribute<T> configAttributeType, String displayMode) Unregister the given configuration attribute for the given DisplayMode.
<T> void	unregisterConfigAttribute(ConfigAttribute<T> configAttributeType, String displayMode, String configLabel) Unregister the given configuration attribute for the given DisplayMode that was registered against the given configuration label.

Method Detail

getConfigAttribute

<T> T getConfigAttribute(ConfigAttribute<T> configAttribute,
                         String targetDisplayMode,
                         String... configLabels)

If retrieving registered values

Example 1:

configRegistry.getConfigAttribute(attribute, DisplayMode.EDIT);

1. It will look for an attribute registered using the EDIT display mode
2. If it can't find that it will try and find an attribute under the NORMAL mode
3. If it can't find one it will try and find one registered without a display mode registerConfigAttribute(ConfigAttribute, Object)

Example 2:

configRegistry.getConfigAttribute(attribute, DisplayMode.NORMAL, "testLabel", "testLabel_1");

1. It will look for an attribute registered by display mode NORMAL and "testLabel"
2. It will look for an attribute registered by display mode NORMAL and "testLabel_1"

Type Parameters:

T - Type of the attribute

Parameters:

configAttribute - to be registered

targetDisplayMode - display mode the cell needs to be in, for this attribute to be returned

configLabels - the cell needs to have, for this attribute to be returned

Returns:

the configAttribute, if the display mode and the configLabels match

getConfigAttribute

<T> T getConfigAttribute(ConfigAttribute<T> configAttribute,
                         String targetDisplayMode,
                         List<String> configLabels)

See Also:

getConfigAttribute(ConfigAttribute, String, String...)

getSpecificConfigAttribute

<T> T getSpecificConfigAttribute(ConfigAttribute<T> configAttribute,
                                 String displayMode,
                                 String configLabel)

See Also:

getConfigAttribute(ConfigAttribute, String, String...)

registerConfigAttribute

<T> void registerConfigAttribute(ConfigAttribute<T> configAttribute,
                                 T attributeValue)

Register a configuration attribute.

Parameters:

configAttribute - The ConfigAttribute for which a value should be registered.

attributeValue - The value that should be set for the given The ConfigAttribute.

registerConfigAttribute

<T> void registerConfigAttribute(ConfigAttribute<T> configAttribute,
                                 T attributeValue,
                                 String targetDisplayMode)

Register a configuration attribute against a DisplayMode.

Parameters:

configAttribute - The ConfigAttribute for which a value should be registered.

attributeValue - The value that should be set for the given The ConfigAttribute.

targetDisplayMode - The DisplayMode for which the ConfigAttribute should be registered.

registerConfigAttribute

<T> void registerConfigAttribute(ConfigAttribute<T> configAttribute,
                                 T attributeValue,
                                 String targetDisplayMode,
                                 String configLabel)

Register an attribute against a DisplayMode and configuration label (applied to cells)

Parameters:

configAttribute - The ConfigAttribute for which a value should be registered.

attributeValue - The value that should be set for the given The ConfigAttribute.

targetDisplayMode - The DisplayMode for which the ConfigAttribute should be registered.

configLabel - The configuration label against which the ConfigAttribute should be registered.

unregisterConfigAttribute

<T> void unregisterConfigAttribute(ConfigAttribute<T> configAttributeType)

Unregister the given configuration attribute.

Parameters:

configAttributeType - The ConfigAttribute to unregister.

unregisterConfigAttribute

<T> void unregisterConfigAttribute(ConfigAttribute<T> configAttributeType,
                                   String displayMode)

Unregister the given configuration attribute for the given DisplayMode.

Parameters:

configAttributeType - The ConfigAttribute to unregister.

displayMode - The DisplayMode for which the ConfigAttribute should be unregistered.

unregisterConfigAttribute

<T> void unregisterConfigAttribute(ConfigAttribute<T> configAttributeType,
                                   String displayMode,
                                   String configLabel)

Unregister the given configuration attribute for the given DisplayMode that was registered against the given configuration label.

Parameters:

configAttributeType - The ConfigAttribute to unregister.

displayMode - The DisplayMode for which the ConfigAttribute should be unregistered.

configLabel - The configuration label against which the ConfigAttribute was registered.

getDisplayModeOrdering

IDisplayModeOrdering getDisplayModeOrdering()

Returns:

The IDisplayModeOrdering which is used to specify in which order to search through the IConfigRegistry for DisplayMode.