com.github.dandelion.datatables.jsp.tag
Class AbstractTableTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.github.dandelion.datatables.jsp.tag.AbstractTableTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

TableTag

public abstract class AbstractTableTag
extends javax.servlet.jsp.tagext.BodyTagSupport

Abstract class which contains :

• all the boring technical stuff needed by Java tags (getters and setters for all Table tag attributes)
• helper methods used to init the table

Since:

0.1.0

Author:

Thibault Duchateau

See Also:

Serialized Form

Field Summary

protected String	appear
protected Boolean	autoWidth
protected Boolean	cdn
protected Boolean	colReorder
protected String	cssClass
protected String	cssStripes
protected String	cssStyle
protected Object	currentObject
protected Object	data
protected Boolean	deferRender
protected Integer	displayLength
protected String	dom
protected String	export
protected String	exportLinks
protected Boolean	filter
protected Boolean	fixedHeader
protected Integer	fixedOffsetTop
protected String	fixedPosition
protected String	footer
protected String	id
protected Boolean	info
protected int	iterationNumber
protected Iterator<Object>	iterator
protected Boolean	jqueryUI
protected Boolean	jsonp
protected String	labels
protected Boolean	lengthChange
protected String	lengthMenu
protected String	loadingType
protected Boolean	paginate
protected String	paginationType
protected Boolean	pipelining
protected Integer	pipeSize
protected Boolean	processing
protected String	row
protected String	rowIdBase
protected String	rowIdPrefix
protected String	rowIdSufix
protected Boolean	scrollCollapse
protected Boolean	scroller
protected String	scrollY
protected String	serverData
protected String	serverMethod
protected String	serverParams
protected Boolean	serverSide
protected Boolean	sort
protected Boolean	stateSave
protected HtmlTable	table
protected String	theme
protected String	themeOption
protected String	url

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

AbstractTableTag()

Method Summary

protected Boolean	canBeExported() Test if the user want his table to be exported.
protected void	generateLinkTag(String href) Generate and write a new HTML link tag.
protected void	generateScriptTag(String src) Generate and write a new HTML script tag.
String	getAppear()
Boolean	getAutoWidth()
Boolean	getColReorder()
String	getCssClass()
String	getCssStripes()
String	getCssStyle()
protected ExportType	getCurrentExportType() Return the current export type asked by the user on export link click.
Object	getCurrentObject()
Boolean	getDeferRender()
Integer	getDisplayLength()
String	getDom()
String	getExport()
String	getExportLinks()
Boolean	getFilter()
Boolean	getFixedHeader()
String	getFixedPosition()
String	getFooter()
Boolean	getInfo()
Integer	getIterationNumber()
Boolean	getJqueryUI()
Boolean	getJsonp()
String	getLabels()
Boolean	getLengthChange()
String	getLengthMenu()
String	getLoadingType()
Integer	getOffsetTop()
Boolean	getPaginate()
String	getPaginationType()
Boolean	getPipelining()
Integer	getPipeSize()
Boolean	getProcessing()
protected String	getRowId() Return the row id using prefix, base and suffix.
String	getRowIdBase()
String	getRowIdPrefix()
String	getRowIdSufix()
Boolean	getScrollCollapse()
Boolean	getScroller()
String	getScrollY()
String	getServerData()
String	getServerMethod()
String	getServerParams()
Boolean	getServerSide()
Boolean	getSort()
Boolean	getStateSave()
HtmlTable	getTable() Getters and setters for all attributes
String	getTheme()
String	getThemeOption()
String	getUrl()
Boolean	isFirstIteration()
protected int	processIteration() Process the iteration over the data (only for DOM source).
protected void	registerBasicConfiguration() Register all common configuration with the table.
protected void	registerExportConfiguration() Register export configuration.
protected void	registerFeatures() Register activated features with the table.
protected void	registerPlugins() Register activated plugins with the table.
protected void	registerTheme() Register the theme if activated in the table tag.
void	setAppear(String appear)
void	setAutoWidth(Boolean autoWidth)
void	setCdn(Boolean cdn)
void	setColReorder(Boolean colReorder)
void	setCssClass(String cssClass)
void	setCssStripes(String cssStripes)
void	setCssStyle(String cssStyle)
void	setCurrentObject(Object currentObject)
void	setData(Collection<Object> data)
void	setDeferRender(Boolean deferRender)
void	setDisplayLength(Integer displayLength)
void	setDom(String dom)
void	setExport(String export)
void	setExportLinks(String exportButtons)
void	setFilter(Boolean filterable)
void	setFixedHeader(Boolean fixedHeader)
void	setFixedPosition(String fixedPosition)
void	setFooter(String footer)
void	setId(String id)
void	setInfo(Boolean info)
void	setJqueryUI(Boolean jqueryUI)
void	setJsonp(Boolean jsonp)
void	setLabels(String labels)
void	setLengthChange(Boolean lengthChange)
void	setLengthMenu(String lengthMenu)
void	setOffsetTop(Integer fixedOffsetTop)
void	setPaginate(Boolean paginate)
void	setPaginationType(String paginationType)
void	setPipelining(Boolean pipelining)
void	setPipeSize(Integer pipeSize)
void	setProcessing(Boolean processing)
void	setRow(String row)
void	setRowIdBase(String rowIdBase)
void	setRowIdPrefix(String rowIdPrefix)
void	setRowIdSufix(String rowIdSufix)
void	setScrollCollapse(Boolean scrollCollapse)
void	setScroller(Boolean scroller)
void	setScrollY(String scrollY)
void	setServerData(String serverData)
void	setServerMethod(String serverMethod)
void	setServerParams(String serverParams)
void	setServerSide(Boolean serverSide)
void	setSort(Boolean sort)
void	setStateSave(Boolean stateSave)
void	setTheme(String theme)
void	setThemeOption(String themeOption)
void	setUrl(String url)

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doEndTag, doInitBody, doStartTag, getBodyContent, getPreviousOut, release, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

data

protected Object data

url

protected String url

row

protected String row

id

protected String id

cssStyle

protected String cssStyle

cssClass

protected String cssClass

cssStripes

protected String cssStripes

rowIdBase

protected String rowIdBase

rowIdPrefix

protected String rowIdPrefix

rowIdSufix

protected String rowIdSufix

autoWidth

protected Boolean autoWidth

filter

protected Boolean filter

info

protected Boolean info

paginate

protected Boolean paginate

lengthChange

protected Boolean lengthChange

paginationType

protected String paginationType

sort

protected Boolean sort

cdn

protected Boolean cdn

appear

protected String appear

footer

protected String footer

lengthMenu

protected String lengthMenu

displayLength

protected Integer displayLength

dom

protected String dom

deferRender

protected Boolean deferRender

stateSave

protected Boolean stateSave

labels

protected String labels

jqueryUI

protected Boolean jqueryUI

processing

protected Boolean processing

serverSide

protected Boolean serverSide

pipelining

protected Boolean pipelining

pipeSize

protected Integer pipeSize

jsonp

protected Boolean jsonp

serverData

protected String serverData

serverParams

protected String serverParams

serverMethod

protected String serverMethod

fixedHeader

protected Boolean fixedHeader

fixedPosition

protected String fixedPosition

fixedOffsetTop

protected Integer fixedOffsetTop

scroller

protected Boolean scroller

scrollY

protected String scrollY

scrollCollapse

protected Boolean scrollCollapse

colReorder

protected Boolean colReorder

export

protected String export

exportLinks

protected String exportLinks

theme

protected String theme

themeOption

protected String themeOption

iterationNumber

protected int iterationNumber

table

protected HtmlTable table

iterator

protected Iterator<Object> iterator

currentObject

protected Object currentObject

loadingType

protected String loadingType

Constructor Detail

AbstractTableTag

public AbstractTableTag()

Method Detail

registerBasicConfiguration

protected void registerBasicConfiguration()
                                   throws BadConfigurationException

Register all common configuration with the table.

Throws:

BadConfigurationException

registerTheme

protected void registerTheme()
                      throws javax.servlet.jsp.JspException

Register the theme if activated in the table tag.

Throws:

javax.servlet.jsp.JspException

registerPlugins

protected void registerPlugins()

Register activated plugins with the table.

registerFeatures

protected void registerFeatures()
                         throws javax.servlet.jsp.JspException

Register activated features with the table.

Throws:

javax.servlet.jsp.JspException

registerExportConfiguration

protected void registerExportConfiguration()
                                    throws BadConfigurationException

Register export configuration.

Depending on the export configuration, export links are generated and customized around the table.

Throws:

BadExportConfigurationException

BadConfigurationException

processIteration

protected int processIteration()
                        throws javax.servlet.jsp.JspException

Process the iteration over the data (only for DOM source).

Returns:

EVAL_BODY_BUFFERED if some data remain in the Java Collection, SKIP_BODY otherwise.

Throws:

javax.servlet.jsp.JspException - if something went wrong during the row id generation.

getCurrentExportType

protected ExportType getCurrentExportType()

Return the current export type asked by the user on export link click.

Returns:

An enum corresponding to the type of export.

canBeExported

protected Boolean canBeExported()

Test if the user want his table to be exported.

Returns:

true if the table can be exported, false otherwise.

getRowId

protected String getRowId()
                   throws javax.servlet.jsp.JspException

Return the row id using prefix, base and suffix. Prefix and sufix are just prepended and appended strings. Base is extracted from the current iterated object.

Returns:

return the row id using prefix, base and suffix.

Throws:

javax.servlet.jsp.JspException - is the rowIdBase doesn't have a corresponding property accessor method.

generateLinkTag

protected void generateLinkTag(String href)
                        throws IOException

Generate and write a new HTML link tag.

Parameters:

href -

Throws:

IOException

generateScriptTag

protected void generateScriptTag(String src)
                          throws IOException

Generate and write a new HTML script tag.

Parameters:

href -

Throws:

IOException

getTable

public HtmlTable getTable()

Getters and setters for all attributes

setRow

public void setRow(String row)

isFirstIteration

public Boolean isFirstIteration()

getIterationNumber

public Integer getIterationNumber()

getCurrentObject

public Object getCurrentObject()

setCurrentObject

public void setCurrentObject(Object currentObject)

setId

public void setId(String id)

Overrides:

setId in class javax.servlet.jsp.tagext.TagSupport

getCssStyle

public String getCssStyle()

setCssStyle

public void setCssStyle(String cssStyle)

getCssClass

public String getCssClass()

setCssClass

public void setCssClass(String cssClass)

getRowIdBase

public String getRowIdBase()

setRowIdBase

public void setRowIdBase(String rowIdBase)

getRowIdPrefix

public String getRowIdPrefix()

setRowIdPrefix

public void setRowIdPrefix(String rowIdPrefix)

getRowIdSufix

public String getRowIdSufix()

setRowIdSufix

public void setRowIdSufix(String rowIdSufix)

getAutoWidth

public Boolean getAutoWidth()

setAutoWidth

public void setAutoWidth(Boolean autoWidth)

getDeferRender

public Boolean getDeferRender()

setDeferRender

public void setDeferRender(Boolean deferRender)

getFilter

public Boolean getFilter()

setFilter

public void setFilter(Boolean filterable)

getInfo

public Boolean getInfo()

setInfo

public void setInfo(Boolean info)

getPaginate

public Boolean getPaginate()

setPaginate

public void setPaginate(Boolean paginate)

getLengthChange

public Boolean getLengthChange()

setLengthChange

public void setLengthChange(Boolean lengthChange)

getProcessing

public Boolean getProcessing()

setProcessing

public void setProcessing(Boolean processing)

getServerSide

public Boolean getServerSide()

setServerSide

public void setServerSide(Boolean serverSide)

getPaginationType

public String getPaginationType()

setPaginationType

public void setPaginationType(String paginationType)

getSort

public Boolean getSort()

setSort

public void setSort(Boolean sort)

getStateSave

public Boolean getStateSave()

setStateSave

public void setStateSave(Boolean stateSave)

getFixedHeader

public Boolean getFixedHeader()

setFixedHeader

public void setFixedHeader(Boolean fixedHeader)

getScroller

public Boolean getScroller()

setScroller

public void setScroller(Boolean scroller)

getColReorder

public Boolean getColReorder()

setColReorder

public void setColReorder(Boolean colReorder)

getScrollY

public String getScrollY()

setScrollY

public void setScrollY(String scrollY)

getScrollCollapse

public Boolean getScrollCollapse()

setScrollCollapse

public void setScrollCollapse(Boolean scrollCollapse)

getFixedPosition

public String getFixedPosition()

setFixedPosition

public void setFixedPosition(String fixedPosition)

getLabels

public String getLabels()

setLabels

public void setLabels(String labels)

getOffsetTop

public Integer getOffsetTop()

setOffsetTop

public void setOffsetTop(Integer fixedOffsetTop)

setCdn

public void setCdn(Boolean cdn)

getExport

public String getExport()

setExport

public void setExport(String export)

getLoadingType

public String getLoadingType()

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getJqueryUI

public Boolean getJqueryUI()

setJqueryUI

public void setJqueryUI(Boolean jqueryUI)

getPipelining

public Boolean getPipelining()

setPipelining

public void setPipelining(Boolean pipelining)

getPipeSize

public Integer getPipeSize()

setPipeSize

public void setPipeSize(Integer pipeSize)

getExportLinks

public String getExportLinks()

setExportLinks

public void setExportLinks(String exportButtons)

getTheme

public String getTheme()

setTheme

public void setTheme(String theme)

getThemeOption

public String getThemeOption()

setThemeOption

public void setThemeOption(String themeOption)

getFooter

public String getFooter()

setFooter

public void setFooter(String footer)

getAppear

public String getAppear()

setAppear

public void setAppear(String appear)

getJsonp

public Boolean getJsonp()

setJsonp

public void setJsonp(Boolean jsonp)

getLengthMenu

public String getLengthMenu()

setLengthMenu

public void setLengthMenu(String lengthMenu)

getCssStripes

public String getCssStripes()

setCssStripes

public void setCssStripes(String cssStripes)

getServerData

public String getServerData()

setServerData

public void setServerData(String serverData)

getServerParams

public String getServerParams()

setServerParams

public void setServerParams(String serverParams)

getServerMethod

public String getServerMethod()

setServerMethod

public void setServerMethod(String serverMethod)

getDisplayLength

public Integer getDisplayLength()

setDisplayLength

public void setDisplayLength(Integer displayLength)

getDom

public String getDom()

setDom

public void setDom(String dom)

setData

public void setData(Collection<Object> data)