org.eclipse.nebula.widgets.nattable.extension.e4.css

Class NatTableCSSHelper

java.lang.Object

org.eclipse.nebula.widgets.nattable.extension.e4.css.NatTableCSSHelper

public class NatTableCSSHelper
extends Object

Helper class for converting and applying CSS styles.

Constructor Summary

Constructors

Constructor and Description
NatTableCSSHelper()

Method Summary

Modifier and Type	Method and Description
static <T> void	applyNatTableStyle(NatTable natTable, ConfigAttribute<IStyle> styleAttribute, ConfigAttribute<T> styleConfig, T value, String displayMode, String configLabel) Apply a style attribute value for the IStyle registered for the given styleAttribute.
static <T> void	applyNatTableStyle(NatTable natTable, ConfigAttribute<T> styleConfig, T value, String displayMode, String configLabel) Apply a style attribute value for the IStyle registered for CellConfigAttributes.CELL_STYLE.
static boolean	getBoolean(org.w3c.dom.css.CSSValue value, boolean defaultValue) Return the boolean value that represents the given CSSValue.
static BorderStyle	getBorderStyle(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, String displayMode) Returns the BorderStyle out of the given CSSElementContext for the given DisplayMode.
static CellEdgeEnum	getCellEdgeEnum(String value) Returns the NatTable CellEdgeEnum for the given string representation.
static Object	getContextValue(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, String displayMode, Object key) Search the value for the given key and DisplayMode out of the given CSSElementContext.
static Object	getContextValueInherited(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, org.eclipse.e4.ui.css.core.engine.CSSElementContext natTableContext, String targetDisplayMode, Object key) Search the value for the given key and DisplayMode out of the given CSSElementContext.
static List<String>	getDecoratorPainter(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, String displayMode) Returns the string representation list of cell painter decorators that should be used to build up the cell painter for rendering.
static IDisplayConverter	getDisplayConverter(String value, boolean format, Integer minFractionDigits, Integer maxFractionDigits, String datePattern) Returns the NatTable IDisplayConverter for the given string representation.
static String	getDisplayConverterString(IDisplayConverter converter)
static String	getDisplayMode(String pseudo) Returns the NatTable DisplayMode for the given pseudo class.
static org.eclipse.e4.ui.css.core.dom.properties.css2.CSS2FontProperties	getFontProperties(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, String contextKey, NatTable natTable, String displayMode, String label) Returns the CSS2FontProperties out of the given CSSElementContext for the given parameters.
static <T> T	getNatTableStyle(NatTable natTable, ConfigAttribute<T> styleConfig, String displayMode, String... configLabels) Retrieves the style attribute for the given display mode and config labels out of the NatTable configuration.
static Map<String,Object>	getPainterProperties(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, String displayMode) Returns the painter properties out of the given CSSElementContext for the given DisplayMode.
static Map<String,Object>	getPainterPropertiesInherited(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, org.eclipse.e4.ui.css.core.engine.CSSElementContext natTableContext, String targetDisplayMode) Returns the painter properties out of the given CSSElementContext for the given DisplayMode enriched with the painter property values out of inheritance.
static boolean	isConverterString(String value)
static boolean	resolvePainter(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, org.eclipse.e4.ui.css.core.engine.CSSElementContext natTableContext, String displayMode) Check if the automatic painter resolution is enabled or disabled via CSS property.
static List<String>	resolvePainterRepresentation(org.w3c.dom.css.CSSValue value) Resolves the painter representations out of the given CSSValue.
static void	setFontProperties(org.w3c.dom.css.CSSValueList valueList, org.eclipse.e4.ui.css.core.dom.properties.css2.CSS2FontProperties font) Sets the values from the given CSSValueList to the given CSS2FontPropertiesCSS2FontProperties.
static void	storeBorderStyle(org.w3c.dom.css.CSSValueList valueList, BorderStyle borderStyle, org.eclipse.e4.ui.css.core.engine.CSSEngine engine, org.eclipse.swt.widgets.Display display) Convert and store the values of the given CSSValueList to the given BorderStyle.
static void	storeContextValue(org.eclipse.e4.ui.css.core.engine.CSSElementContext context, String displayMode, Object key, Object value) Put a value for the given key and DisplayMode to the given CSSElementContext.
static void	storePadding(String paddingKey, org.w3c.dom.css.CSSValue value, org.eclipse.e4.ui.css.core.engine.CSSElementContext context, String displayMode) Convert and store the padding value for the given key in the painter properties map.

Methods inherited from class java.lang.Object

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

Constructor Detail

NatTableCSSHelper

public NatTableCSSHelper()

Method Detail

getBoolean

public static boolean getBoolean(org.w3c.dom.css.CSSValue value,
                                 boolean defaultValue)

Return the boolean value that represents the given CSSValue.

Parameters:

value - The value for which the boolean value should be returned.

defaultValue - The default value to return if the given value can not be converted to a boolean.

Returns:

The boolean representation of the given value or the default value if it can not be converted.

getDisplayMode

public static String getDisplayMode(String pseudo)

Returns the NatTable DisplayMode for the given pseudo class.

Parameters:

pseudo - The pseudo class.

Returns:

The DisplayMode value for the given pseudo class.

getCellEdgeEnum

public static CellEdgeEnum getCellEdgeEnum(String value)

Returns the NatTable CellEdgeEnum for the given string representation.

Parameters:

value - The string representation of the CellEdgeEnum

Returns:

The CellEdgeEnum for the string representation.

getDisplayConverter

public static IDisplayConverter getDisplayConverter(String value,
                                                    boolean format,
                                                    Integer minFractionDigits,
                                                    Integer maxFractionDigits,
                                                    String datePattern)

Returns the NatTable IDisplayConverter for the given string representation.

Parameters:

value - The string representation of the IDisplayConverter

format - flag for number display converters to specify whether NumberFormat should be used to format or not.

minFractionDigits - number of minimum fraction digits to use in case a NumberFormat is used for formatting a number value

maxFractionDigits - number of maximum fraction digits to use in case a NumberFormat is used for formatting a number value

datePattern - The pattern to use for formatting a date value when a date display converter requested

Returns:

The IDisplayConverter for the string representation.

getDisplayConverterString

public static String getDisplayConverterString(IDisplayConverter converter)

Parameters:

converter - The IDisplayConverter for which the String representation is requested.

Returns:

The String representation for the given IDisplayConverter.

isConverterString

public static boolean isConverterString(String value)

Parameters:

value - The value to check.

Returns:

true if the given value represents a valid converter key, false if not.

getNatTableStyle

public static <T> T getNatTableStyle(NatTable natTable,
                                     ConfigAttribute<T> styleConfig,
                                     String displayMode,
                                     String... configLabels)

Retrieves the style attribute for the given display mode and config labels out of the NatTable configuration. Uses the NatTable internal inheritance model to always retrieve a style configuration attribute if there is one configured at any level.

Parameters:

natTable - The NatTable whose ConfigRegistry should be checked for the style configuration.

styleConfig - The style ConfigAttribute that is requested.

displayMode - The DisplayMode for which the configuration is requested.

configLabels - The config labels for which the configuration is requested.

Returns:

The style attribute for the given display mode and config labels out of the NatTable configuration.

applyNatTableStyle

public static <T> void applyNatTableStyle(NatTable natTable,
                                          ConfigAttribute<T> styleConfig,
                                          T value,
                                          String displayMode,
                                          String configLabel)

Apply a style attribute value for the IStyle registered for CellConfigAttributes.CELL_STYLE.

Parameters:

natTable - The NatTable to apply the style configuration to.

styleConfig - The style ConfigAttribute that should be applied.

value - The value to apply.

displayMode - The DisplayMode for which the configuration should be applied.

configLabel - The label for which the configuration should be applied.

applyNatTableStyle

public static <T> void applyNatTableStyle(NatTable natTable,
                                          ConfigAttribute<IStyle> styleAttribute,
                                          ConfigAttribute<T> styleConfig,
                                          T value,
                                          String displayMode,
                                          String configLabel)

Apply a style attribute value for the IStyle registered for the given styleAttribute.

Parameters:

natTable - The NatTable to apply the style configuration to.

styleAttribute - The ConfigAttribute that points to the IStyle that should be configured.

styleConfig - The style ConfigAttribute that should be applied.

value - The value to apply.

displayMode - The DisplayMode for which the configuration should be applied.

configLabel - The label for which the configuration should be applied.

getFontProperties

public static org.eclipse.e4.ui.css.core.dom.properties.css2.CSS2FontProperties getFontProperties(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                                                                                  String contextKey,
                                                                                                  NatTable natTable,
                                                                                                  String displayMode,
                                                                                                  String label)

Returns the CSS2FontProperties out of the given CSSElementContext for the given parameters. If no CSS2FontProperties exist, a new instance will be created and pre-filled with font values based on inheritance.

Parameters:

context - The CSSElementContext to search for the context value.

contextKey - The context key under which the font properties are stored.

natTable - The NatTable instance to apply the styles to

displayMode - The target DisplayMode to check for the value.

label - The label for which the font properties are requested.

Returns:

The CSS2FontProperties for the given attributes.

setFontProperties

public static void setFontProperties(org.w3c.dom.css.CSSValueList valueList,
                                     org.eclipse.e4.ui.css.core.dom.properties.css2.CSS2FontProperties font)

Sets the values from the given CSSValueList to the given CSS2FontPropertiesCSS2FontProperties.

Parameters:

valueList - The value list containing the css property values

font - The font properties to set the values to

getBorderStyle

public static BorderStyle getBorderStyle(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                         String displayMode)

Returns the BorderStyle out of the given CSSElementContext for the given DisplayMode.

Parameters:

context - The CSSElementContext to search for the context value.

displayMode - The DisplayMode for which the value should be stored.

Returns:

The BorderStyle

storeBorderStyle

public static void storeBorderStyle(org.w3c.dom.css.CSSValueList valueList,
                                    BorderStyle borderStyle,
                                    org.eclipse.e4.ui.css.core.engine.CSSEngine engine,
                                    org.eclipse.swt.widgets.Display display)
                             throws Exception

Convert and store the values of the given CSSValueList to the given BorderStyle.

Parameters:

valueList - The CSSValueList with the values to convert.

borderStyle - The BorderStyle to store the converted values to.

engine - The CSSEngine needed for conversion.

display - The display needed for color conversion.

Throws:

Exception - if the value conversion fails

storePadding

public static void storePadding(String paddingKey,
                                org.w3c.dom.css.CSSValue value,
                                org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                String displayMode)

Convert and store the padding value for the given key in the painter properties map.

Parameters:

paddingKey - The key of the padding property.

value - The CSSValue of the padding that should be converted and stored.

context - The CSSElementContext to search for the configuration value.

displayMode - The target DisplayMode to check for the value.

resolvePainter

public static boolean resolvePainter(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                     org.eclipse.e4.ui.css.core.engine.CSSElementContext natTableContext,
                                     String displayMode)

Check if the automatic painter resolution is enabled or disabled via CSS property.

Parameters:

context - The CSSElementContext to search for the configuration value.

natTableContext - The CSSElementContext of the parent NatTable or null in case the context parameter is already from the NatTable itself.

displayMode - The target DisplayMode to check for the value.

Returns:

true if the painter to use should be automatically resolved, false if the painter is configured elsewhere and therefore no automatic resolution should be performed. Default is true.

getDecoratorPainter

public static List<String> getDecoratorPainter(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                               String displayMode)

Returns the string representation list of cell painter decorators that should be used to build up the cell painter for rendering.

Parameters:

context - The CSSElementContext to search for the context value.

displayMode - The DisplayMode for which the value should be stored.

Returns:

The string representation of decorator painter that should be used for rendering.

getPainterProperties

public static Map<String,Object> getPainterProperties(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                                      String displayMode)

Returns the painter properties out of the given CSSElementContext for the given DisplayMode.

Parameters:

context - The CSSElementContext to search for the context value.

displayMode - The DisplayMode for which the value should be stored.

Returns:

The properties that should be used to create content painter.

getPainterPropertiesInherited

public static Map<String,Object> getPainterPropertiesInherited(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                                               org.eclipse.e4.ui.css.core.engine.CSSElementContext natTableContext,
                                                               String targetDisplayMode)

Returns the painter properties out of the given CSSElementContext for the given DisplayMode enriched with the painter property values out of inheritance.

Parameters:

context - The CSSElementContext to search for the context value.

natTableContext - The CSSElementContext of the parent NatTable or null in case the context parameter is already from the NatTable itself.

targetDisplayMode - The target DisplayMode to check for the value.

Returns:

The painter properties with values out of inheritance

resolvePainterRepresentation

public static List<String> resolvePainterRepresentation(org.w3c.dom.css.CSSValue value)

Resolves the painter representations out of the given CSSValue.

Parameters:

value - The CSSValue to resolve.

Returns:

The list of string representations for painters.

storeContextValue

public static void storeContextValue(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                     String displayMode,
                                     Object key,
                                     Object value)

Put a value for the given key and DisplayMode to the given CSSElementContext.

Parameters:

context - The CSSElementContext to put the value to.

displayMode - The DisplayMode for which the value should be stored.

key - The key for which the value should be stored.

value - The value to store.

getContextValue

public static Object getContextValue(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                     String displayMode,
                                     Object key)

Search the value for the given key and DisplayMode out of the given CSSElementContext.

Parameters:

context - The CSSElementContext out of which the value should be retrieved.

displayMode - The DisplayMode for which the value is requested.

key - The key for which the value is requested.

Returns:

The value for the given DisplayMode and key out of the given CSSElementContext. If no value is found for the given DisplayMode, the value out of the given CSSElementContext directly is returned. Can be null.

getContextValueInherited

public static Object getContextValueInherited(org.eclipse.e4.ui.css.core.engine.CSSElementContext context,
                                              org.eclipse.e4.ui.css.core.engine.CSSElementContext natTableContext,
                                              String targetDisplayMode,
                                              Object key)

Search the value for the given key and DisplayMode out of the given CSSElementContext. Will search for the value also via inheritance, that means first it will check the IDisplayModeOrdering and if there is no value found, it searches in the parent NatTable context.

Parameters:

context - The CSSElementContext to search for the context value.

natTableContext - The CSSElementContext of the parent NatTable or null in case the context parameter is already from the NatTable itself.

targetDisplayMode - The target DisplayMode to check for the value.

key - The key of the context value to search for.

Returns:

The context value for the given key.