com.github.dandelion.datatables.core.extension

Class Parameter

java.lang.Object

com.github.dandelion.datatables.core.extension.Parameter

public class Parameter
extends Object

A parameter can be seen as a name/value pair in the DataTables configuration Javascript object.

Some extension may need to modify the DataTables parameters object, that's why there's a Mode attribute, which defines the way the configuration will affect this object.

For example, in order to use the ScrollerPlugin, you need to modify the sDom parameter, adding a S to the default value (which is lfrtip). That's why in the setup method, you will find among others :

 addParameter(new Configuration(DTConstants.DT_DOM, "S", Configuration.Mode.APPEND));
 

So the final value of the sDom parameter will be lfrtipS

Since:

0.5.0

Author:

Thibault Duchateau

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.Mode

Constructor Summary

Constructors

Constructor and Description
Parameter(String name)
Parameter(String name, Object value)
Parameter(String name, Object value, Parameter.Mode mode)

Method Summary

Methods

Modifier and Type	Method and Description
Parameter.Mode	getMode()
String	getName()
Object	getValue()
void	setMode(Parameter.Mode mode)
void	setName(String name)
void	setValue(Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(String name)

Parameter

public Parameter(String name,
         Object value)

Parameter

public Parameter(String name,
         Object value,
         Parameter.Mode mode)

Method Detail

getName

public String getName()

setName

public void setName(String name)

getValue

public Object getValue()

setValue

public void setValue(Object value)

getMode

public Parameter.Mode getMode()

setMode

public void setMode(Parameter.Mode mode)