com.github.dandelion.datatables.core.extension

Class AbstractExtension

java.lang.Object

com.github.dandelion.datatables.core.extension.AbstractExtension

All Implemented Interfaces:

Extension

Direct Known Subclasses:

AbstractFilteringFeature, AjaxFeature, AjaxReloadFeature, Bootstrap2Theme, Bootstrap3Theme, ColReorderPlugin, ExportFeature, ExternalFilterFeature, ExtraHtmlFeature, ExtraJsFeature, FixedHeaderPlugin, JQueryUITheme, PagingTypeBootstrapFullFeature, PagingTypeBootstrapFullNumbersFeature, PagingTypeBootstrapSimpleFeature, PagingTypeExtJsFeature, PagingTypeInputFeature, PagingTypeListboxFeature, PagingTypeScrollingFeature, PipeliningFeature, ResponsivePlugin, ScrollerPlugin, ServerSideFeature, SortingFeature

public abstract class AbstractExtension
extends Object
implements Extension

Abstract superclass for all extensions.

Lots of utilities are available in this class, allowing you to:

• bufferize Javascript code, at different location, before flushing it in the final TODO
• add some Parameter to the generated DataTables configuration, thanks to addParameter(Parameter), addParameter(String, Object) and #addParameter(String, Object, Mode) methods
• add some bundles to the current request
• add some Callback to the generated DataTables configuration

Also note that you can access the Dandelion Context using the getContext().

In order to use the extension mechanism, you should:

1. Create a class that extends AbstractExtension. You could directly create a class that directly implements Extension but this is not recommended.
2. Create a file called com.github.dandelion.datatables.core.extension.Extension under the META-INF/services folder:

    META - INF / services / com.github.dandelion.datatables.core.extension.Extension
    

3. Add to the above file the full qualified name of your extension class.
   For example, assuming the following extension class:

    package com.company.extension;
    
    public class MyExtension extends AbstractExtension {
       ...
    }
    

   The file com.github.dandelion.datatables.core.extension.Extension should contain:

    com.company.extension.MyExtension
    

Note that if you wish to override an already existing extension, you shouldn't override the Extension.getExtensionName() method.

Since:

0.7.1

Author:

Thibault Duchateau

Constructor Summary

Constructors

Constructor and Description
AbstractExtension()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBundle(DatatableBundles bundle) Updates the current HttpServletRequest with the passed DatatableBundles.
void	addBundleParameter(String assetName, String paramName, Object paramValue)
void	addCallback(CallbackType callbackType, String javascript) Adds a Callback to the DataTables generated configuration.
void	addCallback(CallbackType callbackType, String javascript, Parameter.Mode mode) Adds a Callback to the DataTables generated configuration, specifying a method of updating if the CallbackType already exists in the configuration.
void	addParameter(Parameter parameter) Adds the passed Parameter to a temporary list.
void	addParameter(String parameterName, Object parameterValue) Adds a new DataTables parameter to the generated configuration.
void	addParameter(String parameterName, Object parameterValue, Parameter.Mode mode) Adds a new DataTables parameter to the generated configuration, using a custom method of updating.
void	appendToAfterAll(String afterAll)
void	appendToAfterEndDocumentReady(String afterEndDocumentReady)
void	appendToAfterStartDocumentReady(String afterStartDocumentReady)
void	appendToBeforeAll(String beforeAll)
void	appendToBeforeEndDocumentReady(String beforeEndDocumentReady)
void	appendToBeforeStartDocumentReady(String beforeStartDocumentReady)
void	appendToComponentConfiguration(String componentConfiguration)
boolean	equals(Object obj)
StringBuilder	getAfterAll()
StringBuilder	getAfterStartDocumentReady()
StringBuilder	getBeforeAll()
StringBuilder	getBeforeEndDocumentReady()
StringBuilder	getBeforeStartDocumentReady()
com.github.dandelion.core.Context	getContext()
Map<String,String>	getDynamicAttributes()
List<Parameter>	getParameters()
int	hashCode()
abstract void	setup(HtmlTable table)
void	setupWrapper(HtmlTable table) Sets up the extension.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.dandelion.datatables.core.extension.Extension

getExtensionName

Constructor Detail

AbstractExtension

public AbstractExtension()

Method Detail

setupWrapper

public void setupWrapper(HtmlTable table)

Description copied from interface: Extension

Sets up the extension.

The HtmlTable object is available if a particular configuration is needed.

Specified by:

setupWrapper in interface Extension

Parameters:

table - The HTML table.

setup

public abstract void setup(HtmlTable table)

getBeforeAll

public StringBuilder getBeforeAll()

Specified by:

getBeforeAll in interface Extension

Returns:

the Javascript code to be inserted at the InsertMode#BEFOREALL placeholder.

getAfterAll

public StringBuilder getAfterAll()

Specified by:

getAfterAll in interface Extension

Returns:

the Javascript code to be inserted at the InsertMode#AFTERALL placeholder.

getBeforeStartDocumentReady

public StringBuilder getBeforeStartDocumentReady()

Specified by:

getBeforeStartDocumentReady in interface Extension

Returns:

the Javascript code to be inserted at the InsertMode#BEFORESTARTDOCUMENTREADY placeholder.

getAfterStartDocumentReady

public StringBuilder getAfterStartDocumentReady()

Specified by:

getAfterStartDocumentReady in interface Extension

Returns:

the Javascript code to be inserted at the InsertMode#AFTERSTARTDOCUMENTREADY placeholder.

getBeforeEndDocumentReady

public StringBuilder getBeforeEndDocumentReady()

Specified by:

getBeforeEndDocumentReady in interface Extension

Returns:

the Javascript code to be inserted at the InsertMode#BEFOREENDDOCUMENTREADY placeholder.

getParameters

public List<Parameter> getParameters()

Specified by:

getParameters in interface Extension

addParameter

public void addParameter(Parameter parameter)

Adds the passed Parameter to a temporary list.

Later this list is processed and all Parameters are added to the DataTables generated configuration.

Specified by:

addParameter in interface Extension

Parameters:

parameter - The param to add.

addParameter

public void addParameter(String parameterName,
                Object parameterValue)

Adds a new DataTables parameter to the generated configuration.

If the parameter already exists, it will be overriden.

Parameters:

parameterName - Name of the parameter.

parameterValue - Value of the parameter.

addParameter

public void addParameter(String parameterName,
                Object parameterValue,
                Parameter.Mode mode)

Adds a new DataTables parameter to the generated configuration, using a custom method of updating.

Parameters:

parameterName - Name of the parameter.

parameterValue - Value of the parameter.

mode - Method of updating used for this parameter.

addBundle

public void addBundle(DatatableBundles bundle)

Updates the current HttpServletRequest with the passed DatatableBundles.

Parameters:

bundle - The DatatableBundles to add.

addBundleParameter

public void addBundleParameter(String assetName,
                      String paramName,
                      Object paramValue)

addCallback

public void addCallback(CallbackType callbackType,
               String javascript)

Adds a Callback to the DataTables generated configuration.

By default, if the CallbackType already exists in the configuration, the code will be appended to the existing code.

Parameters:

callbackType - The type of the callback.

javascript - The Javascript code to execute in the callback.

addCallback

public void addCallback(CallbackType callbackType,
               String javascript,
               Parameter.Mode mode)

Adds a Callback to the DataTables generated configuration, specifying a method of updating if the CallbackType already exists in the configuration.

Parameters:

callbackType - The type of the callback.

javascript - The Javascript code to execute in the callback.

mode - Method of updating used for this parameter.

appendToBeforeAll

public void appendToBeforeAll(String beforeAll)

Specified by:

appendToBeforeAll in interface Extension

appendToBeforeStartDocumentReady

public void appendToBeforeStartDocumentReady(String beforeStartDocumentReady)

Specified by:

appendToBeforeStartDocumentReady in interface Extension

appendToAfterStartDocumentReady

public void appendToAfterStartDocumentReady(String afterStartDocumentReady)

Specified by:

appendToAfterStartDocumentReady in interface Extension

appendToBeforeEndDocumentReady

public void appendToBeforeEndDocumentReady(String beforeEndDocumentReady)

Specified by:

appendToBeforeEndDocumentReady in interface Extension

appendToAfterEndDocumentReady

public void appendToAfterEndDocumentReady(String afterEndDocumentReady)

appendToComponentConfiguration

public void appendToComponentConfiguration(String componentConfiguration)

appendToAfterAll

public void appendToAfterAll(String afterAll)

Specified by:

appendToAfterAll in interface Extension

getDynamicAttributes

public Map<String,String> getDynamicAttributes()

getContext

public com.github.dandelion.core.Context getContext()

Returns:

the Dandelion Context.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object