public class Table extends StylableTag
<base:page>
tag.
Syntax:
<tbl:table id=... clazz=.... style=... title=... sortby=... direction=ASC|DESC columns=... sc=... item=... subcontext=... action=... >
Attribute | Default value | Required | Description |
id | - | yes |
The ID of the table. The value of this attribute
goes directly into the standard HTML id attribute.
This means that if you need a reference to the table object in your own
JavaScript code, you may for example use the following code:
table = document.getElementById('<id>'); |
clazz | - | no |
The value if this attribute goes directly into the standard HTML
class attribute. This allows you to apply different styles
to different tables.
|
style | - | no |
The value if this attribute goes directly into the standard HTML
style attribute. This allows you to apply different styles
to different tables.
|
title | - | no |
An optional title that will be displayed in <h3>
format directly above the table.
|
sortby | - | no |
Matches the property attribute on a <tbl:columdef> tag.
This column will then be marked with an upwards or downward pointer
according to the |
direction | asc | no |
The value should be either asc or desc to
indicate if the rows are sorted in ascending or descending order.
Other values are interpreted as asc .
|
columns | - | no |
A comma-separatd list of column ID:s. Only columns with an ID in the list
will be shown in the table. The special value all shows all
columns. Individual columns may override this setting by
specifying always or never instead of the default
auto value in their show attribute.
|
action | name of current page | no | The action property of the <form> tag. |
sc | - | no | The current SessionControl object. Used by some child taglibs for generating context sensitive information. |
item | - | no | The current Item object. Used by some child taglibs for generating context sensitive information (ie. PresetSelector). |
subcontext | "" (empty string) | no | The name of the current subcontext. Used by some child taglibs for generating context sensitive information (ie. PresetSelector). |
The <tbl:table>
may contain the following subtags:
<tbl:toolbar>
: Creates a toolbar with buttons
<tbl:navigator>
: Creates the page navigator
<tbl:data>
: Begins the data section
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
action |
private boolean |
allVisible
"all" was specified for the columns attribute.
|
private java.util.Map<java.lang.String,java.lang.String> |
columnContent |
private java.util.Map<java.lang.String,java.lang.String> |
columnFilter |
private java.util.Map<java.lang.String,Formatter<?>> |
columnFormatter |
private java.lang.String |
columns
Which columns that should be visible and their order
|
private java.util.Set<java.lang.String> |
definedColumns
The ID of all defined columns
|
private int |
evenodd
Keep track of which class to use for the next row.
|
private java.util.List<ListColumnAction> |
extensionColumns |
private java.util.List<java.lang.String> |
hiddenFilteredColumns |
private java.lang.StringBuilder |
hiddenForm |
private Item |
itemType |
private org.json.simple.JSONArray |
jsonColumnDefs |
private int |
numFilteredColumns |
private int |
numHeaderColumns |
private Page |
page
The parent <base:page> tag.
|
private static java.lang.String[] |
rowclass
The class names for even and odd row respectively.
|
private SessionControl |
sc |
private static long |
serialVersionUID |
private java.lang.String |
sortby
The column to sort by.
|
private java.util.Map<java.lang.String,ItemContext.SortDirection> |
sortColumns |
private ItemContext.SortDirection |
sortDirection
ASC or DESC
|
private java.lang.String |
subcontext |
private java.lang.String |
title
An optional title of the table.
|
private java.util.Set<java.lang.String> |
visibleColumns
The ID of all visible columns, sorted by the order they should appear.
|
id, pageContext
EVAL_BODY_AGAIN
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
Constructor and Description |
---|
Table() |
Modifier and Type | Method and Description |
---|---|
(package private) void |
addColumnDef(ColumnDef cd,
ListColumnAction extensionColumn) |
(package private) void |
addFilteredColumn(java.lang.String columnId,
boolean visible) |
(package private) void |
addHidden(java.lang.String name,
java.lang.String value) |
int |
doEndTag() |
int |
doStartTag() |
(package private) void |
endColumnDefinitions() |
java.lang.String |
getAction() |
(package private) java.util.Map<java.lang.String,java.lang.String> |
getColumnContent() |
java.lang.String |
getColumns() |
ItemContext.SortDirection |
getDirection() |
(package private) java.lang.String |
getDirectionImage(ItemContext.SortDirection direction)
Get sort direction
|
(package private) java.util.List<ListColumnAction> |
getExtensionColumns() |
(package private) Formatter<?> |
getFormatter(java.lang.String columnId) |
(package private) java.util.List<java.lang.String> |
getHiddenFilteredColumns() |
Item |
getItem() |
(package private) java.lang.String |
getNextRowClass() |
(package private) int |
getNumFilteredColumns() |
(package private) Page |
getPage() |
SessionControl |
getSc() |
java.lang.String |
getSortby() |
(package private) ItemContext.SortDirection |
getSortDirection(java.lang.String colum)
Get the sort direction on the given column.
|
java.lang.String |
getSubcontext() |
java.lang.String |
getTitle() |
(package private) java.util.Set<java.lang.String> |
getVisibleColumns() |
(package private) boolean |
isColumnVisible(java.lang.String columnId) |
(package private) int |
numHeaderColumns() |
(package private) int |
numVisibleColumns() |
void |
setAction(java.lang.String action) |
(package private) void |
setColumnContent(java.lang.String columnId,
java.lang.String content) |
(package private) void |
setColumnFilter(java.lang.String columnId,
java.lang.String filterHtml) |
void |
setColumns(java.lang.String columns) |
void |
setDirection(ItemContext.SortDirection direction) |
void |
setDirection(java.lang.String direction) |
void |
setItem(Item itemType) |
(package private) void |
setNumColumns(int numColumns) |
void |
setSc(SessionControl sc) |
void |
setSortby(java.lang.String sortby) |
void |
setSubcontext(java.lang.String subcontext) |
void |
setTitle(java.lang.String title) |
(package private) int |
writeColumnFilters() |
(package private) int |
writeColumns() |
addDynamicAttributes, addIdAndStyles, getClazz, getDynamicActionAttributes, getDynamicAttribute, getFullClass, getIdPrefix, getStyle, getSubclass, initDefaultAttributes, setClazz, setDynamicAttribute, setMoreDynamicAttributes, setPageContext, setStyle, setSubclass
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue
private static final long serialVersionUID
private Page page
private java.lang.String title
private java.lang.String sortby
private java.util.Map<java.lang.String,ItemContext.SortDirection> sortColumns
private java.lang.String action
private transient SessionControl sc
private Item itemType
private java.lang.String subcontext
private ItemContext.SortDirection sortDirection
private java.lang.String columns
private java.lang.StringBuilder hiddenForm
private int evenodd
private static final java.lang.String[] rowclass
private boolean allVisible
private java.util.Set<java.lang.String> visibleColumns
private java.util.Set<java.lang.String> definedColumns
private java.util.Map<java.lang.String,java.lang.String> columnContent
private java.util.Map<java.lang.String,java.lang.String> columnFilter
private transient java.util.Map<java.lang.String,Formatter<?>> columnFormatter
private java.util.List<java.lang.String> hiddenFilteredColumns
private java.util.List<ListColumnAction> extensionColumns
private org.json.simple.JSONArray jsonColumnDefs
private int numHeaderColumns
private int numFilteredColumns
public void setTitle(java.lang.String title)
public java.lang.String getTitle()
public void setColumns(java.lang.String columns)
public java.lang.String getColumns()
public void setSortby(java.lang.String sortby)
public java.lang.String getSortby()
public void setAction(java.lang.String action)
public java.lang.String getAction()
public void setSc(SessionControl sc)
public SessionControl getSc()
public void setItem(Item itemType)
public Item getItem()
public void setSubcontext(java.lang.String subcontext)
public java.lang.String getSubcontext()
public void setDirection(java.lang.String direction)
public void setDirection(ItemContext.SortDirection direction)
public ItemContext.SortDirection getDirection()
Page getPage()
void addColumnDef(ColumnDef cd, ListColumnAction extensionColumn)
void endColumnDefinitions()
boolean isColumnVisible(java.lang.String columnId)
java.util.Set<java.lang.String> getVisibleColumns()
Formatter<?> getFormatter(java.lang.String columnId)
void setColumnContent(java.lang.String columnId, java.lang.String content)
java.util.Map<java.lang.String,java.lang.String> getColumnContent()
void setColumnFilter(java.lang.String columnId, java.lang.String filterHtml)
void addFilteredColumn(java.lang.String columnId, boolean visible)
java.util.List<java.lang.String> getHiddenFilteredColumns()
int writeColumns() throws java.lang.Exception
java.lang.Exception
int writeColumnFilters() throws java.lang.Exception
java.lang.Exception
ItemContext.SortDirection getSortDirection(java.lang.String colum)
java.lang.String getDirectionImage(ItemContext.SortDirection direction)
java.lang.String getNextRowClass()
void addHidden(java.lang.String name, java.lang.String value)
int numVisibleColumns()
int getNumFilteredColumns()
void setNumColumns(int numColumns)
int numHeaderColumns()
java.util.List<ListColumnAction> getExtensionColumns()
public int doStartTag() throws JspException
doStartTag
in interface Tag
doStartTag
in class TagSupport
JspException
public int doEndTag() throws JspException
doEndTag
in interface Tag
doEndTag
in class TagSupport
JspException