Package org.eclipse.nebula.widgets.nattable.layer.cell

Class AbstractOverrider

java.lang.Object

org.eclipse.nebula.widgets.nattable.layer.cell.AbstractOverrider

All Implemented Interfaces:

IConfigLabelAccumulator, IConfigLabelProvider

Direct Known Subclasses:

CellOverrideLabelAccumulator, ColumnOverrideLabelAccumulator, RowOverrideLabelAccumulator

public abstract class AbstractOverrider
extends Object
implements IConfigLabelProvider

Constructor Summary

Constructors

Constructor	Description
AbstractOverrider()

Method Summary

Modifier and Type	Method	Description
void	addOverrides(Map<Serializable,List<String>> overrides)	Adds the given map of key-label overrides to the override map of this overrider.
Map<Serializable,List<String>>	getOverrides()
List<String>	getOverrides(Serializable key)	Return the labels that are registered for the given key.
Collection<String>	getProvidedLabels()	Returns the labels that are provided by this IConfigLabelAccumulator.
void	registerOverrides(Serializable key, String... configLabels)	Add the given labels to the label collection for the given key.
void	registerOverrides(Serializable key, List<String> configLabels)	Add the given labels to the label collection for the given key.
void	registerOverridesOnTop(Serializable key, String... configLabels)	Add the given labels on top of the label collection for the given key.
void	registerOverridesOnTop(Serializable key, List<String> configLabels)	Add the given labels on top of the label collection for the given key.
void	removeOverride(Serializable key)	Remove all registered labels from the key-label overrides for the given key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.cell.IConfigLabelAccumulator

accumulateConfigLabels

Constructor Detail

AbstractOverrider

public AbstractOverrider()

Method Detail

removeOverride

public void removeOverride(Serializable key)

Remove all registered labels from the key-label overrides for the given key.

Parameters:

key - The key for which all labels should be removed.

registerOverrides

public void registerOverrides(Serializable key,
                              String... configLabels)

Add the given labels to the label collection for the given key.

Parameters:

key - The key for which the labels should be added.

configLabels - The labels to add.

registerOverrides

public void registerOverrides(Serializable key,
                              List<String> configLabels)

Add the given labels to the label collection for the given key.

Parameters:

key - The key for which the labels should be added.

configLabels - The labels to add.

registerOverridesOnTop

public void registerOverridesOnTop(Serializable key,
                                   String... configLabels)

Add the given labels on top of the label collection for the given key.

Parameters:

key - The key for which the labels should be added.

configLabels - The labels to add.

registerOverridesOnTop

public void registerOverridesOnTop(Serializable key,
                                   List<String> configLabels)

Add the given labels on top of the label collection for the given key.

Parameters:

key - The key for which the labels should be added.

configLabels - The labels to add.

getOverrides

public Map<Serializable,List<String>> getOverrides()

Returns:

The map of registered key-label overrides.

getOverrides

public List<String> getOverrides(Serializable key)

Return the labels that are registered for the given key.

Parameters:

key - The key for which the labels are requested.

Returns:

The labels that are registered for the given key.

addOverrides

public void addOverrides(Map<Serializable,List<String>> overrides)

Adds the given map of key-label overrides to the override map of this overrider.

Parameters:

overrides - The key-label overrides to add.

getProvidedLabels

public Collection<String> getProvidedLabels()

Returns the labels that are provided by this IConfigLabelAccumulator. It needs to return all labels that might be applied to support the usage of corresponding selectors in NatTable CSS styling.

Specified by:

getProvidedLabels in interface IConfigLabelProvider

Returns:

The labels that are provided by this IConfigLabelAccumulator.

Since:

1.4