META-INF.dandelion-datatables.tld Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of datatables-jsp Show documentation
Show all versions of datatables-jsp Show documentation
JSP taglib for the Dandelion-DataTables component.
Set of tags for manipulating HTML table with
DataTables.
dandelion-datatables
0.87
datatables
http://github.com/dandelion/datatables
Generate a HTML table thanks to the awesome
DataTables jQuery plugin.
table
com.github.dandelion.datatables.jsp.tag.TableTag
com.github.dandelion.datatables.jsp.tei.TableTagExtraInfo
JSP
(required) DOM id of the HTML table.
id
true
true
Collection of data used to populate the table.
(Either data or url attribute is required)
data
true
java.lang.Object
Web service URL used to populate the table.
(Either data or url attribute is required)
url
true
Name of the object representing the current
row.
If
data must be displayed without any decoration,
use
property
attribute on column tag.
row
true
(block|fadein[,duration]) Display mode used when
the table has finished loading and must appear in the page.
A duration
can be set (in milliseconds) if the display mode
is set to
"fadein". (Default : "fadein")
appear
(true|false) Allows to retrieve JSON data from any
domain name, regardless of XSS protection.
jsonp
(true|false) Enable the DataTables source files
to
be loaded
from the Microsoft CDN (Content Delivery
Framework)
preventing you from hosting the files
yourself. (Default :
false)
cdn
CSS style applied on the HTML table. (HTML
style
attribute)
cssStyle
CSS class(es) applied on the HTML table. (HTML
class attribute)
cssClass
Useful if you want each row has a DOM id. This
attribute is evaluated as a property of the current
iterated
bean. (Only if DOM datasource)
rowIdBase
true
String which is prepended to the rowIdBase
attribute, in order to build row id. (HTML id attribute)
rowIdPrefix
true
String which is appended to the rowIdBase
attribute, in order to build row id. (HTML id attribute)
rowIdSufix
true
Base URL of an AJAX loaded file which contains
all
the
labels used in tables. (See :
http://www.datatables.net/release-datatables/examples/advanced_init/language_file.html)
labels
true
(true|false) Defer the creation of the table
elements for each row until they are needed for a draw.
(Default : false, see
http://datatables.net/ref#bDeferRender)
deferRender
(true|false) Enable or disable the table
information display. This shows information about the
data
that is currently visible on the page, including
information
about filtered data if that action is being
performed.
(Default : true, see
http://datatables.net/ref#bInfo)
info
(true|false) Enable or disable pagination.
(Default : true, see
http://datatables.net/ref#bPaginate)
paginate
(true|false) If paginate is enabled, allows the
end user to select the size of a formatted page from a
select menu (sizes are 10, 25, 50 and 100). (Default :
true,
see http://datatables.net/ref#bLengthChange)
lengthChange
(two_button|full_numbers) Choice between the
two
different built-in pagination interaction methods
('two_button' or 'full_numbers') which present different
page controls to the end user. (Default : two_button,
see
http://datatables.net/ref#sPaginationType)
paginationType
(true|false) Enable or disable filtering of
data.
(Default : true, see
http://datatables.net/ref#bFilter)
filter
(true|false) Enable or disable sorting of all
columns.
Sorting of individual columns can be disabled by
the
"sortable" attribute of column tag. (Default : true,
see
http://datatables.net/ref#bSort)
sort
(true|false) Enable or disable automatic column
width calculation. (Default : true, see
http://datatables.net/ref#bAutoWidth)
autoWidth
java.lang.Boolean
(true|false) Enable or disable the display of a
'processing' indicator when the table is being processed
(e.g. a sort). This is particularly useful for tables
with
large amounts of data where it can take a noticeable
amount
of time to sort the entries. (Default : false, see
http://datatables.net/ref#bProcessing)
processing
Configure DataTables to use server-side processing
serverSide
Allows you to override the default function which obtains the data from the server ($.getJSON) so something more suitable for your application
serverData
Allows you to send extra information to the server when using AJAX source
serverParams
Enable pipelining data for paging when server-side
processing is enabled
pipelining
Pipe size used when pipelining is enabled, ie
times that the user can page before a request must be made
of the server. (Default : 5)
pipeSize
(true|false) Enable or disable state saving.
When
enabled a cookie will be used to save table display
information such as pagination information, display
length,
filtering and sorting. As such when the end user
reloads the
page the display display will match what thy
had previously
set up. (Default : false, see
http://datatables.net/ref#bStateSave)
stateSave
(true|false) Enable or disable the export
functionality
export
(TOP_LEFT|TOP_MIDDLE|TOP_RIGHT|BOTTOM_LEFT|BOTTOM_MIDDLE|BOTTOM_RIGHT)
Comma-separated list of positions where the export
links will
be generated (Default : TOP_RIGHT)
exportLinks
(true|false) Enable jQuery UI ThemeRoller
support
(Default : false, see
http://datatables.net/ref#bJQueryUI)
jqueryUI
(header) Choose if you want to have the footer
appear.
(Default : none)
footer
Name of a theme to activate for the current table.
(Default : none)
theme
Name of an option to activate in relation to the
current activated theme.
themeOption
Specify the entries in the length drop down menu that DataTables show when pagination is enabled.
lengthMenu
Comma-separated list of CSS classes that should be applied to displayed rows. This array may be of any length, and DataTables will apply each class sequentially, looping when required.
cssStripes
Number of rows to display on a single page when using pagination.
displayLength
(true|false) Enable or disable the DataTables
FixedHeader plugin. (Default : false) (See :
http://datatables.net/extras/fixedheader/)
fixedHeader
(top|bottom|left|right) Respectively fix the
header, footer, left column, right column. (Default :
top)
fixedPosition
Offset applied on the top.
offsetTop
java.lang.Integer
(true|false) Enable or disable the DataTables
Scroller plugin. (Default : false) (See :
http://datatables.net/extras/scroller/)
scroller
Table's height to display in scrolling mode.
(default : 300px)
scrollY
(true|false) When vertical (y) scrolling is enabled,
DataTables will force the height of the table's viewport to the
given height at all times (useful for layout). However, this can
look odd when filtering data down to a small data set, and
the footer is left "floating" further down. This parameter
(when enabled) will cause DataTables to collapse the table's
viewport down when the result set will fit within the given
Y height. (default : false)
scrollCollapse
(true|false) Enable or disable the DataTables
ColReorder plugin. (Default : false) (See :
http://datatables.net/extras/colreorder/)
colReorder
Allows to fill an HTML caption tag in the table.
caption
com.github.dandelion.datatables.jsp.tag.CaptionTag
JSP
"title" attribute of the HTML caption tag.
title
(required) DOM id of the HTML table.
id
CSS style applied on the HTML table. (HTML style
attribute)
cssStyle
CSS class(es) applied on the HTML table. (HTML
class attribute)
cssClass
Allows to fill a column header with more complex
content than a usual title.
columnHead
com.github.dandelion.datatables.jsp.tag.ColumnHeadTag
JSP
Unique arbitrary id of the column, used in
relation to the column tag.
uid
true
Describe a column of the HTML table.
column
com.github.dandelion.datatables.jsp.tag.ColumnTag
JSP
Unique arbitrary id of the column, used in
relation to the columnHead tag
uid
true
Column title.
title
true
Name of the attribute of the current object
being
iterated object on, regardless the data source (DOM
or AJAX)
property
Default value if the property's value is null
(Default : empty string)
default
(true|false) Enable or disable sorting on
column.
(Default : true)
sortable
(asc|desc) If sortable is enabled, set the
default
sorting direction (Default : asc)
sortInit
If sortable is enabled, allow to control the
sorting direction(s)
sortDirection
(true|false) Enable or disable a filtering field in the column's foot. (Default : false)
filterable
(true|false) Enable or disable filtering on
column. (Default : true)
searchable
(SELECT|INPUT) If filterable is enabled, you
can
choose the filter type between 'SELECT' and 'INPUT',
adding
either select box or input field in the table's
footer
(Default : INPUT)
filterType
If filterable is enabled and filterType is
'INPUT', you can apply a CSS class to the input field
with
this attribute
filterCssClass
If filterable is enabled and filterType is
'INPUT', fill in the input field with this attribute
(Default : the column's title)
filterPlaceholder
CSS style applied on header cell (th HTML tag)
cssStyle
CSS style applied on every table cell (td HTML
tag)
cssCellStyle
CSS class applied on header cell (th HTML tag)
cssClass
CSS class applied on every table cell (td HTML
tag)
cssCellClass
(ALL[,HTML|,XML|,CSV]) Comma-separated list of
string which indicates in which view(s) the column's body
will be displayed. (Default : ALL)
display
Name of an external Javascript function that will be used to render the column (AJAX only)
renderFunction
A MessageFormat pattern that will be used to format the property. (DOM only)
format
true
extraFile
com.github.dandelion.datatables.jsp.tag.ExtraFileTag
empty
Location of the file containing DataTables
configuration.
src
true
true
(BEFOREALL|AFTERSTARTDOCUMENTREADY|BEFORENDDOCUMENTREADY|AFTERALL)
Specify where the extra file must be inserted. (Default
:
BEFOREALL)
insert
Allow to specify the location of a file containing
a
JSON-formatted DataTables configuration to merge with the
generated one.
extraConf
com.github.dandelion.datatables.jsp.tag.ExtraConfTag
empty
Location of the file containing the extra
DataTables configuration
src
true
true
Allow to override properties normally defined in
the
Dandelion properties file.
prop
com.github.dandelion.datatables.jsp.tag.PropTag
empty
Property's name to override.
name
true
Property's value to override.
value
true
Configure the HTML link and properties for a given
export type.
export
com.github.dandelion.datatables.jsp.tag.ExportTag
empty
(XML|CSV) Type of export (Default : XML,CSV)
type
true
Name of the file containing exported data
(Default
: the export type uppercased)
fileName
true
Label of the HTML link
label
true
CSS style applied to the HTML link
cssStyle
CSS class applied to the HTML link
cssClass
(true|false) Indicated whether headers should
be
added in export or not (for compatible export)
(Default :
true)
includeHeader
(true|false) Indicates whether columns should be
auto-sized or not (only for XLS export)
(Default : true)
autoSize
Add a DataTables callback.
callback
com.github.dandelion.datatables.jsp.tag.CallbackTag
empty
Type of callback
type
true
Name of the function to execute as a callback
function
true
true