org.apache.myfaces.component.html.ext
Class HtmlDataTable

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIData
              extended by javax.faces.component.html.HtmlDataTable
                  extended by org.apache.myfaces.component.html.ext.HtmlDataTableHack
                      extended by org.apache.myfaces.component.html.ext.AbstractHtmlDataTable
                          extended by org.apache.myfaces.component.html.ext.HtmlDataTable
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, DetailTogglerModel, NewspaperTable, UserRoleAware, ExtendedComponentBase

public class HtmlDataTable
extends AbstractHtmlDataTable


Nested Class Summary
protected static class HtmlDataTable.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlDataTable
DETAIL_STAMP_FACET_NAME, DETAIL_STAMP_ROW_FACET_NAME, NEWSPAPER_COLUMNS_PROPERTY, NEWSPAPER_ORIENTATION_PROPERTY, SPACER_FACET_NAME, TABLE_BODY_FACET_NAME, TABLE_ROW_FACET_NAME
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Fields inherited from interface org.apache.myfaces.component.NewspaperTable
NEWSPAPER_HORIZONTAL_ORIENTATION
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
HtmlDataTable()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAlign()
          HTML: Specifies the horizontal alignment of this element.
 String getBodyStyle()
          Corresponds to the HTML style attribute for the table body tag
 String getBodyStyleClass()
          Corresponds to the HTML class attribute for the table body tag.
 String getDatafld()
          Reserved for future use.
 String getDataformatas()
          Reserved for future use.
 String getDatasrc()
          Reserved for future use.
 String getDetailStampLocation()
          before|after - where to render the detailStamp, before the actual row or after it.
 String getDir()
           
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 Collection<String> getEventNames()
           
 String getFamily()
           
 String getLang()
           
 int getNewspaperColumns()
          The number of columns to wrap the table over.
 String getNewspaperOrientation()
          The orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical".
 String getOnclick()
           
 String getOndblclick()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 String getPreviousRowDataVar()
          A parameter name, under which the previous RowData Object is set in request scope similar to the rowIndexVar and rowCountVar parameters.
 String getRowCountVar()
          A parameter name, under which the rowCount is set in request scope similar to the var parameter.
 String getRowGroupStyle()
          Corresponds to the HTML style attribute for grouped rows.
 String getRowGroupStyleClass()
          StyleClass for grouped rows.
 String getRowId()
          The id to use for
 String getRowIndexVar()
          A parameter name, under which the current rowIndex is set in request scope similar to the var parameter.
 String getRowOnClick()
          Defines a JavaScript onclick event handler for each table row
 String getRowOnDblClick()
          Defines a JavaScript ondblclick event handler for each table row
 String getRowOnKeyDown()
          Defines a JavaScript onkeydown event handler for each table row
 String getRowOnKeyPress()
          Defines a JavaScript onkeypress event handler for each table row
 String getRowOnKeyUp()
          Defines a JavaScript onkeyup event handler for each table row
 String getRowOnMouseDown()
          Defines a JavaScript onmpusedown event handler for each table row
 String getRowOnMouseMove()
          Defines a JavaScript onmousemove event handler for each table row
 String getRowOnMouseOut()
          Defines a JavaScript onmouseout event handler for each table row
 String getRowOnMouseOver()
          Defines a JavaScript onmouseover event handler for each table row
 String getRowOnMouseUp()
          Defines a JavaScript onmouseup event handler for each table row
 String getRowStyle()
          Corresponds to the HTML style attribute for the row tr tag.
 String getRowStyleClass()
          Corresponds to the HTML class attribute for the row tr tag.
 String getSortedColumnVar()
          A parameter name, under which the a boolean is set in request scope similar to the var parameter.
 String getSortProperty()
          The name of a javabean property on which the table is sorted.
 String getStyle()
           
 String getStyleClass()
           
 String getTitle()
           
 String getValueType()
          Indicate the expected type of the EL expression pointed by value property.
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isAjaxBodyRender()
          Indicate if the "body" can be a target for an ajax render operation.
 boolean isAjaxRowRender()
          Indicate if "row" can be a target for an ajax render operation.
 boolean isDetailStampExpandedDefault()
          true|false - true if the detailStamp should be expanded by default.
 boolean isEmbedded()
          Avoids rendering the html table tags, thus, giving you a table rendering just rows.
 boolean isPreserveDataModel()
          Indicates whether the state of the whole DataModel should be saved and restored.
 boolean isPreserveSort()
          Indicates whether the state of the sortColumn and sortAscending attribute should be saved and restored and written back to the model during the update model phase.
 boolean isRenderedIfEmpty()
          Indicates whether this table should be rendered if the underlying DataModel is empty.
protected  boolean isSetPreserveSort()
           
 boolean isSortable()
          Define if the table is sortable or not
 void setAjaxBodyRender(boolean ajaxBodyRender)
           
 void setAjaxRowRender(boolean ajaxRowRender)
           
 void setAlign(String align)
           
 void setBodyStyle(String bodyStyle)
           
 void setBodyStyleClass(String bodyStyleClass)
           
 void setDatafld(String datafld)
           
 void setDataformatas(String dataformatas)
           
 void setDatasrc(String datasrc)
           
 void setDetailStampExpandedDefault(boolean detailStampExpandedDefault)
           
 void setDetailStampLocation(String detailStampLocation)
           
 void setDir(String dir)
           
 void setEmbedded(boolean embedded)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setLang(String lang)
           
 void setNewspaperColumns(int newspaperColumns)
           
 void setNewspaperOrientation(String newspaperOrientation)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setPreserveDataModel(boolean preserveDataModel)
           
 void setPreserveSort(boolean preserveSort)
           
 void setPreviousRowDataVar(String previousRowDataVar)
           
 void setRenderedIfEmpty(boolean renderedIfEmpty)
           
 void setRowCountVar(String rowCountVar)
           
 void setRowGroupStyle(String rowGroupStyle)
           
 void setRowGroupStyleClass(String rowGroupStyleClass)
           
 void setRowId(String rowId)
           
 void setRowIndexVar(String rowIndexVar)
           
 void setRowOnClick(String rowOnClick)
           
 void setRowOnDblClick(String rowOnDblClick)
           
 void setRowOnKeyDown(String rowOnKeyDown)
           
 void setRowOnKeyPress(String rowOnKeyPress)
           
 void setRowOnKeyUp(String rowOnKeyUp)
           
 void setRowOnMouseDown(String rowOnMouseDown)
           
 void setRowOnMouseMove(String rowOnMouseMove)
           
 void setRowOnMouseOut(String rowOnMouseOut)
           
 void setRowOnMouseOver(String rowOnMouseOver)
           
 void setRowOnMouseUp(String rowOnMouseUp)
           
 void setRowStyle(String rowStyle)
           
 void setRowStyleClass(String rowStyleClass)
           
 void setSortable(boolean sortable)
           
 void setSortedColumnVar(String sortedColumnVar)
           
 void setSortProperty(String sortProperty)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTitle(String title)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 void setValueType(String valueType)
           
 void setVisibleOnUserRole(String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlDataTable
clearExpandedNodes, collapseAllDetails, collapseAllPageDetails, columnNameToIndex, createDataModel, createSortHeaderComponent, encodeBegin, encodeEnd, expandAllDetails, expandAllPageDetails, findComponent, getContainerClientId, getDataModel, getDetailStamp, getExpandedNode, getExpandedNodes, getFirst, getForceIdIndexFormula, getPreservedDataModel, getRows, getSerializableDataModel, getSortColumn, getSortColumnIndex, getSortPropertyFromEL, getSpacer, getTableContext, getVarDetailToggler, invokeOnComponent, isCurrentDetailExpanded, isDetailExpanded, isExpandedEmpty, isRendered, isSetSortAscending, isSetSortColumn, isSortAscending, isSortHeaderNeeded, isValidChildren, markInitialState, processDecodes, processUpdates, processValidators, removeExpandedNode, restoreDescendantComponentStates, restoreFullDescendantComponentDeltaStates, restoreFullDescendantComponentStates, restoreState, saveDescendantComponentStates, saveDescendantInitialComponentStates, saveFullDescendantComponentStates, saveState, setDetailStamp, setExpandedEmpty, setExpandedNode, setFirst, setForceIdIndexFormula, setIsValidChildren, setPreservedDataModel, setRowIndex, setRows, setSortAscending, setSortColumn, setSortColumnIndex, setSpacer, setVarDetailToggler, toggleDetail, visitTree
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlDataTableHack
checkUpdateModelError, clearRowStates, deleteRowStateForRow, getClientId, getDerivedRowKeyPrefix, getDerivedSubClientId, getRowCount, getRowData, getRowIndex, getRowKey, hasErrorMessages, isForceId, isForceIdIndex, isPreserveRowComponentState, isPreserveRowStates, isRowAvailable, isRowStatePreserved, restoreDescendantComponentStates, restoreFullDescendantComponentDeltaStates, restoreFullDescendantComponentStates, saveDescendantComponentStates, saveDescendantInitialComponentStates, saveFullDescendantComponentStates, setDataModel, setDerivedRowKeyPrefix, setForceId, setForceIdIndex, setPreserveRowComponentState, setPreserveRowStates, setRowKey, setRowStatePreserved, setValue
 
Methods inherited from class javax.faces.component.html.HtmlDataTable
getBgcolor, getBodyrows, getBorder, getCaptionClass, getCaptionStyle, getCellpadding, getCellspacing, getColumnClasses, getFooterClass, getFrame, getHeaderClass, getRowClasses, getRules, getSummary, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, setCellpadding, setCellspacing, setColumnClasses, setFooterClass, setFrame, setHeaderClass, setRowClasses, setRules, setSummary, setWidth
 
Methods inherited from class javax.faces.component.UIData
broadcast, createUniqueId, getFooter, getHeader, getValue, getVar, queueEvent, setFooter, setHeader, setVar
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors, getDefaultEventName
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlDataTable

public HtmlDataTable()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.html.HtmlDataTable

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getEventNames in class javax.faces.component.html.HtmlDataTable

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class javax.faces.component.html.HtmlDataTable

getSortProperty

public String getSortProperty()
Description copied from class: AbstractHtmlDataTable
The name of a javabean property on which the table is sorted.

The datamodel should contain objects that have this property; reflection will be used to sort the datamodel on that property using the default comparator for that type.

This value is part of the component state. However it is not directly settable by users; instead it is set by other components such as a CommandSortHeader.

Specified by:
getSortProperty in class AbstractHtmlDataTable

setSortProperty

public void setSortProperty(String sortProperty)
Specified by:
setSortProperty in class AbstractHtmlDataTable

isSortable

public boolean isSortable()
Description copied from class: AbstractHtmlDataTable
Define if the table is sortable or not

Specified by:
isSortable in class AbstractHtmlDataTable

setSortable

public void setSortable(boolean sortable)

isEmbedded

public boolean isEmbedded()
Description copied from class: AbstractHtmlDataTable
Avoids rendering the html table tags, thus, giving you a table rendering just rows. You can use this together with the detailStamp faces of the parent datatable to render child-tables using the same layout as the parent. Notice: You have to ensure both tables do have the same number of columns. Using the colspan attribute of the column tag might help alot.

Specified by:
isEmbedded in class AbstractHtmlDataTable

setEmbedded

public void setEmbedded(boolean embedded)

isDetailStampExpandedDefault

public boolean isDetailStampExpandedDefault()
Description copied from class: AbstractHtmlDataTable
true|false - true if the detailStamp should be expanded by default. default: false

Specified by:
isDetailStampExpandedDefault in interface DetailTogglerModel
Specified by:
isDetailStampExpandedDefault in class AbstractHtmlDataTable

setDetailStampExpandedDefault

public void setDetailStampExpandedDefault(boolean detailStampExpandedDefault)
Specified by:
setDetailStampExpandedDefault in class AbstractHtmlDataTable

getDetailStampLocation

public String getDetailStampLocation()
Description copied from class: AbstractHtmlDataTable
before|after - where to render the detailStamp, before the actual row or after it. default: after

Specified by:
getDetailStampLocation in class AbstractHtmlDataTable

setDetailStampLocation

public void setDetailStampLocation(String detailStampLocation)

getRowOnMouseOver

public String getRowOnMouseOver()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onmouseover event handler for each table row

Specified by:
getRowOnMouseOver in class AbstractHtmlDataTable

setRowOnMouseOver

public void setRowOnMouseOver(String rowOnMouseOver)

getRowOnMouseOut

public String getRowOnMouseOut()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onmouseout event handler for each table row

Specified by:
getRowOnMouseOut in class AbstractHtmlDataTable

setRowOnMouseOut

public void setRowOnMouseOut(String rowOnMouseOut)

getRowOnClick

public String getRowOnClick()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onclick event handler for each table row

Specified by:
getRowOnClick in class AbstractHtmlDataTable

setRowOnClick

public void setRowOnClick(String rowOnClick)

getRowOnDblClick

public String getRowOnDblClick()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript ondblclick event handler for each table row

Specified by:
getRowOnDblClick in class AbstractHtmlDataTable

setRowOnDblClick

public void setRowOnDblClick(String rowOnDblClick)

getRowOnKeyDown

public String getRowOnKeyDown()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onkeydown event handler for each table row

Specified by:
getRowOnKeyDown in class AbstractHtmlDataTable

setRowOnKeyDown

public void setRowOnKeyDown(String rowOnKeyDown)

getRowOnKeyPress

public String getRowOnKeyPress()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onkeypress event handler for each table row

Specified by:
getRowOnKeyPress in class AbstractHtmlDataTable

setRowOnKeyPress

public void setRowOnKeyPress(String rowOnKeyPress)

getRowOnKeyUp

public String getRowOnKeyUp()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onkeyup event handler for each table row

Specified by:
getRowOnKeyUp in class AbstractHtmlDataTable

setRowOnKeyUp

public void setRowOnKeyUp(String rowOnKeyUp)

getRowStyleClass

public String getRowStyleClass()
Description copied from class: AbstractHtmlDataTable
Corresponds to the HTML class attribute for the row tr tag.

Specified by:
getRowStyleClass in class AbstractHtmlDataTable

setRowStyleClass

public void setRowStyleClass(String rowStyleClass)

getRowStyle

public String getRowStyle()
Description copied from class: AbstractHtmlDataTable
Corresponds to the HTML style attribute for the row tr tag.

Specified by:
getRowStyle in class AbstractHtmlDataTable

setRowStyle

public void setRowStyle(String rowStyle)

getRowOnMouseDown

public String getRowOnMouseDown()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onmpusedown event handler for each table row

Specified by:
getRowOnMouseDown in class AbstractHtmlDataTable

setRowOnMouseDown

public void setRowOnMouseDown(String rowOnMouseDown)

getRowOnMouseMove

public String getRowOnMouseMove()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onmousemove event handler for each table row

Specified by:
getRowOnMouseMove in class AbstractHtmlDataTable

setRowOnMouseMove

public void setRowOnMouseMove(String rowOnMouseMove)

getRowOnMouseUp

public String getRowOnMouseUp()
Description copied from class: AbstractHtmlDataTable
Defines a JavaScript onmouseup event handler for each table row

Specified by:
getRowOnMouseUp in class AbstractHtmlDataTable

setRowOnMouseUp

public void setRowOnMouseUp(String rowOnMouseUp)

getRowGroupStyle

public String getRowGroupStyle()
Description copied from class: AbstractHtmlDataTable
Corresponds to the HTML style attribute for grouped rows.

Specified by:
getRowGroupStyle in class AbstractHtmlDataTable

setRowGroupStyle

public void setRowGroupStyle(String rowGroupStyle)

getRowGroupStyleClass

public String getRowGroupStyleClass()
Description copied from class: AbstractHtmlDataTable
StyleClass for grouped rows.

Specified by:
getRowGroupStyleClass in class AbstractHtmlDataTable

setRowGroupStyleClass

public void setRowGroupStyleClass(String rowGroupStyleClass)

getBodyStyle

public String getBodyStyle()
Description copied from class: AbstractHtmlDataTable
Corresponds to the HTML style attribute for the table body tag

Specified by:
getBodyStyle in class AbstractHtmlDataTable

setBodyStyle

public void setBodyStyle(String bodyStyle)

getBodyStyleClass

public String getBodyStyleClass()
Description copied from class: AbstractHtmlDataTable
Corresponds to the HTML class attribute for the table body tag.

Specified by:
getBodyStyleClass in class AbstractHtmlDataTable

setBodyStyleClass

public void setBodyStyleClass(String bodyStyleClass)

getNewspaperColumns

public int getNewspaperColumns()
Description copied from class: AbstractHtmlDataTable
The number of columns to wrap the table over. Default: 1 Set the number of columns the table will be divided over.

Specified by:
getNewspaperColumns in interface NewspaperTable
Specified by:
getNewspaperColumns in class AbstractHtmlDataTable

setNewspaperColumns

public void setNewspaperColumns(int newspaperColumns)

getNewspaperOrientation

public String getNewspaperOrientation()
Description copied from class: AbstractHtmlDataTable
The orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical". Default: vertical

Specified by:
getNewspaperOrientation in interface NewspaperTable
Specified by:
getNewspaperOrientation in class AbstractHtmlDataTable

setNewspaperOrientation

public void setNewspaperOrientation(String newspaperOrientation)

isPreserveDataModel

public boolean isPreserveDataModel()
Description copied from class: AbstractHtmlDataTable
Indicates whether the state of the whole DataModel should be saved and restored. When set to false, the value-binding for the "value" attribute of this table is executed each time the page is rendered. When set to true, that value-binding is only executed when the component is first created, and the DataModel state is thereafter saved/restored automatically by the component. When column sorting is used for a table this property needs to be false so that the DataModel can be updated to reflect any changes in the sort criteria. Default: false

Specified by:
isPreserveDataModel in class AbstractHtmlDataTable

setPreserveDataModel

public void setPreserveDataModel(boolean preserveDataModel)

isSetPreserveSort

protected boolean isSetPreserveSort()
Specified by:
isSetPreserveSort in class AbstractHtmlDataTable

isPreserveSort

public boolean isPreserveSort()
Description copied from class: AbstractHtmlDataTable
Indicates whether the state of the sortColumn and sortAscending attribute should be saved and restored and written back to the model during the update model phase. Default: true

Specified by:
isPreserveSort in class AbstractHtmlDataTable

setPreserveSort

public void setPreserveSort(boolean preserveSort)

isRenderedIfEmpty

public boolean isRenderedIfEmpty()
Description copied from class: AbstractHtmlDataTable
Indicates whether this table should be rendered if the underlying DataModel is empty. You could as well use rendered="#{not empty bean.list}", but this one causes the getList method of your model bean beeing called up to five times per request, which is not optimal when the list is backed by a DB table. Using renderedIfEmpty="false" solves this problem, because the MyFaces extended HtmlDataTable automatically caches the DataModel and calles the model getter only once per request. Default: true

Specified by:
isRenderedIfEmpty in class AbstractHtmlDataTable

setRenderedIfEmpty

public void setRenderedIfEmpty(boolean renderedIfEmpty)

getRowIndexVar

public String getRowIndexVar()
Description copied from class: AbstractHtmlDataTable
A parameter name, under which the current rowIndex is set in request scope similar to the var parameter.

Specified by:
getRowIndexVar in class AbstractHtmlDataTable

setRowIndexVar

public void setRowIndexVar(String rowIndexVar)

getRowCountVar

public String getRowCountVar()
Description copied from class: AbstractHtmlDataTable
A parameter name, under which the rowCount is set in request scope similar to the var parameter.

Specified by:
getRowCountVar in class AbstractHtmlDataTable

setRowCountVar

public void setRowCountVar(String rowCountVar)

getPreviousRowDataVar

public String getPreviousRowDataVar()
Description copied from class: AbstractHtmlDataTable
A parameter name, under which the previous RowData Object is set in request scope similar to the rowIndexVar and rowCountVar parameters. Mind that the value of this request scope attribute is null in the first row or when isRowAvailable returns false for the previous row.

Specified by:
getPreviousRowDataVar in class AbstractHtmlDataTable

setPreviousRowDataVar

public void setPreviousRowDataVar(String previousRowDataVar)

getSortedColumnVar

public String getSortedColumnVar()
Description copied from class: AbstractHtmlDataTable
A parameter name, under which the a boolean is set in request scope similar to the var parameter. TRUE for the column that is currently sorted, FALSE otherwise.

Specified by:
getSortedColumnVar in class AbstractHtmlDataTable

setSortedColumnVar

public void setSortedColumnVar(String sortedColumnVar)

getAlign

public String getAlign()
Description copied from class: AbstractHtmlDataTable
HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.

Specified by:
getAlign in class AbstractHtmlDataTable

setAlign

public void setAlign(String align)

getRowId

public String getRowId()
Description copied from class: AbstractHtmlDataTable
The id to use for

Specified by:
getRowId in class AbstractHtmlDataTable

setRowId

public void setRowId(String rowId)

getDatafld

public String getDatafld()
Description copied from class: AbstractHtmlDataTable
Reserved for future use.

Specified by:
getDatafld in class AbstractHtmlDataTable

setDatafld

public void setDatafld(String datafld)

getDatasrc

public String getDatasrc()
Description copied from class: AbstractHtmlDataTable
Reserved for future use.

Specified by:
getDatasrc in class AbstractHtmlDataTable

setDatasrc

public void setDatasrc(String datasrc)

getDataformatas

public String getDataformatas()
Description copied from class: AbstractHtmlDataTable
Reserved for future use.

Specified by:
getDataformatas in class AbstractHtmlDataTable

setDataformatas

public void setDataformatas(String dataformatas)

getValueType

public String getValueType()
Description copied from class: AbstractHtmlDataTable
Indicate the expected type of the EL expression pointed by value property. It is useful when vb.getType() cannot found the type, like when a map value is resolved on the expression.

Specified by:
getValueType in class AbstractHtmlDataTable

setValueType

public void setValueType(String valueType)

isAjaxRowRender

public boolean isAjaxRowRender()
Description copied from class: AbstractHtmlDataTable
Indicate if "row" can be a target for an ajax render operation. In other words, if it is set to true, a special component is added on a facet with name "row" and with id="row" that can be used as a target for f:ajax or similar components to render the row. By default is set to false.

Specified by:
isAjaxRowRender in class AbstractHtmlDataTable
Returns:

setAjaxRowRender

public void setAjaxRowRender(boolean ajaxRowRender)

isAjaxBodyRender

public boolean isAjaxBodyRender()
Description copied from class: AbstractHtmlDataTable
Indicate if the "body" can be a target for an ajax render operation. In other words, if it is set to true, a special component is added on a facet with name "tbody_element" and with id="tbody_element" that can be used as a target for f:ajax or similar components to render the body. By default is set to false.

Specified by:
isAjaxBodyRender in class AbstractHtmlDataTable
Returns:

setAjaxBodyRender

public void setAjaxBodyRender(boolean ajaxBodyRender)

getEnabledOnUserRole

public String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

getStyle

public String getStyle()
Overrides:
getStyle in class javax.faces.component.html.HtmlDataTable

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlDataTable

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class javax.faces.component.html.HtmlDataTable

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlDataTable

getOnclick

public String getOnclick()
Overrides:
getOnclick in class javax.faces.component.html.HtmlDataTable

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class javax.faces.component.html.HtmlDataTable

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class javax.faces.component.html.HtmlDataTable

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class javax.faces.component.html.HtmlDataTable

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class javax.faces.component.html.HtmlDataTable

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class javax.faces.component.html.HtmlDataTable

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class javax.faces.component.html.HtmlDataTable

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class javax.faces.component.html.HtmlDataTable

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class javax.faces.component.html.HtmlDataTable

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class javax.faces.component.html.HtmlDataTable

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class javax.faces.component.html.HtmlDataTable

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class javax.faces.component.html.HtmlDataTable

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class javax.faces.component.html.HtmlDataTable

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class javax.faces.component.html.HtmlDataTable

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class javax.faces.component.html.HtmlDataTable

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class javax.faces.component.html.HtmlDataTable

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class javax.faces.component.html.HtmlDataTable

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class javax.faces.component.html.HtmlDataTable

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class javax.faces.component.html.HtmlDataTable

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class javax.faces.component.html.HtmlDataTable

getDir

public String getDir()
Overrides:
getDir in class javax.faces.component.html.HtmlDataTable

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlDataTable

getLang

public String getLang()
Overrides:
getLang in class javax.faces.component.html.HtmlDataTable

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlDataTable

getTitle

public String getTitle()
Overrides:
getTitle in class javax.faces.component.html.HtmlDataTable

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlDataTable

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class HtmlDataTableHack

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class HtmlDataTableHack


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.