com.github.dandelion.datatables.core.extension
Interface Extension

All Known Implementing Classes:

AbstractExtension, AbstractFilteringFeature, AjaxFeature, AjaxReloadFeature, AppearFeature, Bootstrap2ResponsiveTheme, Bootstrap2Theme, Bootstrap3ResponsiveTheme, Bootstrap3Theme, ColReorderPlugin, ExportFeature, ExtraHtmlFeature, ExtraJsFeature, FixedHeaderPlugin, JQueryUITheme, MultiFilterFeature, PaginationTypeBootstrapFeature, PaginationTypeBootstrapFourButtonFeature, PaginationTypeBootstrapFullNumbersFeature, PaginationTypeExtJsFeature, PaginationTypeFourButtonFeature, PaginationTypeInputFeature, PaginationTypeListboxFeature, PaginationTypeScrollingFeature, PipeliningFeature, ScrollerPlugin, ServerSideFeature, SortingFeature

public interface Extension

Common interface for all extensions. An extension can be a plugin (e.g. ScrollerPlugin, ColReorderPlugin), a feature (e.g. PaginationTypeBootstrapFeature, AbstractFilteringFeature add-on) or a theme (e.g. Bootstrap2Theme).

An extension can be composed of :

• one or more JsResource, i.e. Javascript code externalized in a file
• one or more CssResource, i.e. CSS code externalized in a file
• one or more Parameter, i.e. one or more specific DataTables parameters that will be used during the DataTables initialization
• an AbstractConfigurationGenerator if the extension needs its own configuration generator. The one used for the main DataTables configuration is the DatatablesGenerator. You can also take a look at the ColumnFilteringGenerator to see the configuration generated for the Column Filtering add-on.
• a potential Javascript function name that will be called after DataTables initialization.
  Example : columnFilter

   oTable_myTableId = $('#myTableId').dataTable(oTable_myTableId_params).columnFilter({...});
   

• Javascript code to add in the main JS resource, i.e. the resource that contains the DataTables initilization Javascript code. You can add Javascript code at multiple locations in this file thanks to the following attributes :
  • beforeAll
  • beforeStartDocumentReady
  • afterStartDocumentReady
  • beforeEndDocumentReady
  • afterAll
  These attributes can be visualized in the following Javascript snippet :

   => BEFOREALL
   var oTable_tableId = $('#myTableId');
   var oTable_tableId_params = {...};
   => BEFORESTARTDOCUMENTREADY
   $(document).ready(function(){
      => AFTERSTARTDOCUMENTREADY
      oTable_myTableId = $('#myTableId').dataTable(oTable_myTableId_params);
      => BEFOREENDDOCUMENTREADY
   });
   => AFTERALL
   

Since:

0.7.1

Author:

Thibault Duchateau

See Also:

ExtensionLoader, ExtensionProcessor

Method Summary

void	addParameter(Parameter conf)
void	appendToAfterAll(String afterAll)
void	appendToAfterStartDocumentReady(String afterStartDocumentReady)
void	appendToBeforeAll(String beforeAll)
void	appendToBeforeEndDocumentReady(String beforeEndDocumentReady)
void	appendToBeforeStartDocumentReady(String beforeStartDocumentReady)
StringBuilder	getAfterAll()
StringBuilder	getAfterStartDocumentReady()
StringBuilder	getBeforeAll()
StringBuilder	getBeforeEndDocumentReady()
StringBuilder	getBeforeStartDocumentReady()
AbstractConfigurationGenerator	getConfigGenerator()
String	getFunction()
String	getName() Returns the extension's name.
List<Parameter>	getParameters()
void	setConfigGenerator(AbstractConfigurationGenerator configGenerator)
void	setConfs(List<Parameter> confs)
void	setFunction(String function)
void	setupWrapper(HtmlTable table) Set the extension up.

Method Detail

getName

String getName()

Returns the extension's name. The name is case-insensitive when loaded by the JSP taglib or the Thymelead dialect.

setupWrapper

void setupWrapper(HtmlTable table)

Set the extension up.

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

Parameters:

table - The HTML table.

getBeforeAll

StringBuilder getBeforeAll()

Returns:

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

getAfterAll

StringBuilder getAfterAll()

Returns:

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

getBeforeStartDocumentReady

StringBuilder getBeforeStartDocumentReady()

Returns:

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

getAfterStartDocumentReady

StringBuilder getAfterStartDocumentReady()

Returns:

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

getBeforeEndDocumentReady

StringBuilder getBeforeEndDocumentReady()

Returns:

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

getParameters

List<Parameter> getParameters()

setConfs

void setConfs(List<Parameter> confs)

addParameter

void addParameter(Parameter conf)

getConfigGenerator

AbstractConfigurationGenerator getConfigGenerator()

setConfigGenerator

void setConfigGenerator(AbstractConfigurationGenerator configGenerator)

appendToBeforeAll

void appendToBeforeAll(String beforeAll)

appendToBeforeStartDocumentReady

void appendToBeforeStartDocumentReady(String beforeStartDocumentReady)

appendToAfterStartDocumentReady

void appendToAfterStartDocumentReady(String afterStartDocumentReady)

appendToBeforeEndDocumentReady

void appendToBeforeEndDocumentReady(String beforeEndDocumentReady)

appendToAfterAll

void appendToAfterAll(String afterAll)

getFunction

String getFunction()

setFunction

void setFunction(String function)