com.github.dandelion.datatables.core.util

Class ConfigUtils

java.lang.Object

com.github.dandelion.datatables.core.util.ConfigUtils

public final class ConfigUtils
extends Object

Set of utilities to help dealing with DatatableOptions.

Since:

1.0.0

Author:

Thibault Duchateau

Field Summary

Fields

Modifier and Type	Field and Description
static String	DDL_DT_REQUESTATTR_TABLES
protected static org.slf4j.Logger	logger

Method Summary

Methods

Modifier and Type	Method and Description
static void	applyStagingOptions(Map<Option<?>,Object> stagingConf, HtmlTable table) Overloads the configurations stored in the TableConfiguration instance with the one passed as parameter.
static void	applyStagingOptionsAndExtensions(Map<Option<?>,Object> stagingConf, Map<Option<?>,Extension> stagingExtensions, HtmlColumn column) Overloads the configurations stored in the ColumnConfiguration instance with the one passed as parameter.
static void	processOptions(HtmlColumn column, HtmlTable table) At this point, the configuration stored inside the ColumnConfiguration contains only Strings.
static void	processOptions(HtmlTable table) At this point, the configuration stored inside the TableConfiguration contains only Strings.
static void	storeTableInRequest(javax.servlet.http.HttpServletRequest request, HtmlTable table) Stores the provided HtmlTable in a particular request attribute so that it can be used by the debugger.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.slf4j.Logger logger

DDL_DT_REQUESTATTR_TABLES

public static final String DDL_DT_REQUESTATTR_TABLES

See Also:

Constant Field Values

Method Detail

applyStagingOptions

public static void applyStagingOptions(Map<Option<?>,Object> stagingConf,
                       HtmlTable table)

Overloads the configurations stored in the TableConfiguration instance with the one passed as parameter.

Parameters:

stagingConf - The staging configurations filled either with the JSP taglib or with the Thymeleaf dialect.

table - The table which holds the TableConfiguration to overload.

processOptions

public static void processOptions(HtmlTable table)

At this point, the configuration stored inside the TableConfiguration contains only Strings. All these strings will be processed in this method, depending on the DatatableOptions they are bound to.

Once processed, all strings will be replaced by the typed value.

Only configuration token with not blank values will be merged into the TableConfiguration instance.

Parameters:

table - The table which holds the configuration to process.

applyStagingOptionsAndExtensions

public static void applyStagingOptionsAndExtensions(Map<Option<?>,Object> stagingConf,
                                    Map<Option<?>,Extension> stagingExtensions,
                                    HtmlColumn column)

Overloads the configurations stored in the ColumnConfiguration instance with the one passed as parameter.

Only configuration token with not blank values will be merged into the ColumnConfiguration instance.

Parameters:

stagingConf - The staging configurations filled either with the JSP taglib or with the Thymeleaf dialect.

stagingExtensions - The staging extensions filled either with the JSP taglib or with the Thymeleaf dialect.

column - The column which holds the ColumnConfiguration to overload.

processOptions

public static void processOptions(HtmlColumn column,
                  HtmlTable table)

At this point, the configuration stored inside the ColumnConfiguration contains only Strings. All these strings will be processed in this method, depending on the DatatableOptions they are bound to.

Once processed, all strings will be replaced by the typed value.

Parameters:

column - The column which contains the configurations to process.

table - The table may be used by processor to register extensions.

storeTableInRequest

public static void storeTableInRequest(javax.servlet.http.HttpServletRequest request,
                       HtmlTable table)

Stores the provided HtmlTable in a particular request attribute so that it can be used by the debugger.

Parameters:

request - The request in which the provided table is stored.

table - The table to store.