|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.icefaces.ace.component.datatable.DataTableBase
public class DataTableBase
Renders an HTML table element. This table and its associated components offers support for features like: scrolling, sorting, filtering, row selection, row editing, lazy loading and expandable subrows and subpanels.
For more information, see the DataTable Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
DataTableBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIData |
---|
COMPONENT_FAMILY |
Fields inherited from class javax.faces.component.UIComponent |
---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
DataTableBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
java.lang.Object |
getCachedGlobalFilter()
Return the value of the cachedGlobalFilter property. |
java.util.List |
getColumnOrdering()
Return the value of the columnOrdering property. |
java.lang.String |
getCurrentPageReportTemplate()
Return the value of the currentPageReportTemplate property. |
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
java.lang.String |
getEmptyMessage()
Return the value of the emptyMessage property. |
java.util.Collection<java.lang.String> |
getEventNames()
|
java.lang.String |
getFamily()
|
java.util.List |
getFilteredData()
Return the value of the filteredData property. |
java.lang.String |
getFilterEvent()
Return the value of the filterEvent property. |
javax.el.MethodExpression |
getFilterListener()
Return the value of the filterListener property. |
java.lang.String |
getFilterValue()
Return the value of the filterValue property. |
java.lang.Integer |
getForcedUpdateCounter()
Return the value of the forcedUpdateCounter property. |
java.lang.Integer |
getHeight()
Return the value of the height property. |
int |
getPage()
Return the value of the page property. |
java.lang.Integer |
getPageCount()
Return the value of the pageCount property. |
java.lang.String |
getPaginatorPosition()
Return the value of the paginatorPosition property. |
java.lang.String |
getPaginatorTemplate()
Return the value of the paginatorTemplate property. |
java.lang.String |
getRowIndexVar()
Return the value of the rowIndexVar property. |
int |
getRows()
Return the value of the rows property. |
javax.el.MethodExpression |
getRowSelectListener()
Return the value of the rowSelectListener property. |
java.lang.String |
getRowsPerPageTemplate()
Return the value of the rowsPerPageTemplate property. |
java.lang.String |
getRowStateVar()
Return the value of the rowStateVar property. |
java.lang.String |
getRowStyleClass()
Return the value of the rowStyleClass property. |
java.util.Map |
getRowToSelectedFieldsMap()
Return the value of the rowToSelectedFieldsMap property. |
javax.el.MethodExpression |
getRowUnselectListener()
Return the value of the rowUnselectListener property. |
java.lang.Integer |
getScrollHeight()
Return the value of the scrollHeight property. |
java.lang.String |
getScrollWidthIE7()
Return the value of the scrollWidthIE7 property. |
CellSelections[] |
getSelectedCells()
Return the value of the selectedCells property. |
java.lang.String |
getSelectionMode()
Return the value of the selectionMode property. |
RowStateMap |
getStateMap()
Return the value of the stateMap property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
java.lang.Integer |
getTabIndex()
Return the value of the tabIndex property. |
java.lang.String |
getTableConfigPanel()
Return the value of the tableConfigPanel property. |
java.lang.Integer |
getValueHashCode()
Return the value of the valueHashCode property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
java.lang.Boolean |
isAlwaysExecuteContents()
Return the value of the alwaysExecuteContents property. |
java.lang.Boolean |
isApplyingFilters()
Return the value of the applyingFilters property. |
java.lang.Boolean |
isApplyingSorts()
Return the value of the applyingSorts property. |
boolean |
isClickableHeaderSorting()
Return the value of the clickableHeaderSorting property. |
boolean |
isColumnPinning()
Return the value of the columnPinning property. |
boolean |
isColumnPinningControlsInHeader()
Return the value of the columnPinningControlsInHeader property. |
boolean |
isConstantRefilter()
Return the value of the constantRefilter property. |
boolean |
isDisabled()
Return the value of the disabled property. |
boolean |
isDoubleClickSelect()
Return the value of the doubleClickSelect property. |
boolean |
isGroupedFilterResults()
Return the value of the groupedFilterResults property. |
java.lang.Boolean |
isHiddenScrollableSizing()
Return the value of the hiddenScrollableSizing property. |
boolean |
isLazy()
Return the value of the lazy property. |
boolean |
isLiveScroll()
Return the value of the liveScroll property. |
boolean |
isPaginator()
Return the value of the paginator property. |
boolean |
isPaginatorAlwaysVisible()
Return the value of the paginatorAlwaysVisible property. |
boolean |
isReorderableColumns()
Return the value of the reorderableColumns property. |
boolean |
isResizableColumns()
Return the value of the resizableColumns property. |
boolean |
isScrollable()
Return the value of the scrollable property. |
boolean |
isSingleSort()
Return the value of the singleSort property. |
java.lang.Boolean |
isStaticHeaders()
Return the value of the staticHeaders property. |
java.lang.Boolean |
isToggleOnInvalidEdit()
Return the value of the toggleOnInvalidEdit property. |
void |
setAlwaysExecuteContents(java.lang.Boolean alwaysExecuteContents)
Set the value of the alwaysExecuteContents property. |
void |
setApplyingFilters(java.lang.Boolean applyingFilters)
Set the value of the applyingFilters property. |
void |
setApplyingSorts(java.lang.Boolean applyingSorts)
Set the value of the applyingSorts property. |
void |
setCachedGlobalFilter(java.lang.Object cachedGlobalFilter)
Set the value of the cachedGlobalFilter property. |
void |
setClickableHeaderSorting(boolean clickableHeaderSorting)
Set the value of the clickableHeaderSorting property. |
void |
setColumnOrdering(java.util.List columnOrdering)
Set the value of the columnOrdering property. |
void |
setColumnPinning(boolean columnPinning)
Set the value of the columnPinning property. |
void |
setColumnPinningControlsInHeader(boolean columnPinningControlsInHeader)
Set the value of the columnPinningControlsInHeader property. |
void |
setConstantRefilter(boolean constantRefilter)
Set the value of the constantRefilter property. |
void |
setCurrentPageReportTemplate(java.lang.String currentPageReportTemplate)
Set the value of the currentPageReportTemplate property. |
void |
setDisabled(boolean disabled)
Set the value of the disabled property. |
void |
setDoubleClickSelect(boolean doubleClickSelect)
Set the value of the doubleClickSelect property. |
void |
setEmptyMessage(java.lang.String emptyMessage)
Set the value of the emptyMessage property. |
void |
setFilteredData(java.util.List filteredData)
Set the value of the filteredData property. |
void |
setFilterEvent(java.lang.String filterEvent)
Set the value of the filterEvent property. |
void |
setFilterListener(javax.el.MethodExpression filterListener)
Set the value of the filterListener property. |
void |
setFilterValue(java.lang.String filterValue)
Set the value of the filterValue property. |
void |
setForcedUpdateCounter(java.lang.Integer forcedUpdateCounter)
Set the value of the forcedUpdateCounter property. |
void |
setGroupedFilterResults(boolean groupedFilterResults)
Set the value of the groupedFilterResults property. |
void |
setHeight(java.lang.Integer height)
Set the value of the height property. |
void |
setHiddenScrollableSizing(java.lang.Boolean hiddenScrollableSizing)
Set the value of the hiddenScrollableSizing property. |
void |
setLazy(boolean lazy)
Set the value of the lazy property. |
void |
setLiveScroll(boolean liveScroll)
Set the value of the liveScroll property. |
void |
setPage(int page)
Set the value of the page property. |
void |
setPageCount(java.lang.Integer pageCount)
Set the value of the pageCount property. |
void |
setPaginator(boolean paginator)
Set the value of the paginator property. |
void |
setPaginatorAlwaysVisible(boolean paginatorAlwaysVisible)
Set the value of the paginatorAlwaysVisible property. |
void |
setPaginatorPosition(java.lang.String paginatorPosition)
Set the value of the paginatorPosition property. |
void |
setPaginatorTemplate(java.lang.String paginatorTemplate)
Set the value of the paginatorTemplate property. |
void |
setReorderableColumns(boolean reorderableColumns)
Set the value of the reorderableColumns property. |
void |
setResizableColumns(boolean resizableColumns)
Set the value of the resizableColumns property. |
void |
setRowIndexVar(java.lang.String rowIndexVar)
Set the value of the rowIndexVar property. |
void |
setRows(int rows)
Set the value of the rows property. |
void |
setRowSelectListener(javax.el.MethodExpression rowSelectListener)
Set the value of the rowSelectListener property. |
void |
setRowsPerPageTemplate(java.lang.String rowsPerPageTemplate)
Set the value of the rowsPerPageTemplate property. |
void |
setRowStateVar(java.lang.String rowStateVar)
Set the value of the rowStateVar property. |
void |
setRowStyleClass(java.lang.String rowStyleClass)
Set the value of the rowStyleClass property. |
void |
setRowToSelectedFieldsMap(java.util.Map rowToSelectedFieldsMap)
Set the value of the rowToSelectedFieldsMap property. |
void |
setRowUnselectListener(javax.el.MethodExpression rowUnselectListener)
Set the value of the rowUnselectListener property. |
void |
setScrollable(boolean scrollable)
Set the value of the scrollable property. |
void |
setScrollHeight(java.lang.Integer scrollHeight)
Set the value of the scrollHeight property. |
void |
setScrollWidthIE7(java.lang.String scrollWidthIE7)
Set the value of the scrollWidthIE7 property. |
void |
setSelectedCells(CellSelections[] selectedCells)
Set the value of the selectedCells property. |
void |
setSelectionMode(java.lang.String selectionMode)
Set the value of the selectionMode property. |
void |
setSingleSort(boolean singleSort)
Set the value of the singleSort property. |
void |
setStateMap(RowStateMap stateMap)
Set the value of the stateMap property. |
void |
setStaticHeaders(java.lang.Boolean staticHeaders)
Set the value of the staticHeaders property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setTabIndex(java.lang.Integer tabIndex)
Set the value of the tabIndex property. |
void |
setTableConfigPanel(java.lang.String tableConfigPanel)
Set the value of the tableConfigPanel property. |
void |
setToggleOnInvalidEdit(java.lang.Boolean toggleOnInvalidEdit)
Set the value of the toggleOnInvalidEdit property. |
void |
setValueHashCode(java.lang.Integer valueHashCode)
Set the value of the valueHashCode property. |
void |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
Methods inherited from class javax.faces.component.UIData |
---|
broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar, visitTree |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView |
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 |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public DataTableBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIData
public void setAlwaysExecuteContents(java.lang.Boolean alwaysExecuteContents)
Set the value of the alwaysExecuteContents
property.
Contents: Enable the decoding of child components during table feature requests. The table attempts to decode children whenever it is executed, meaning whenever a parent region is submitted, or the table submits itself to paginate, make a selection, reorder columns, or any other feature. Decoding children during feature requests can result in unwanted input submission (during pagination for example), so by default this component suppresses child decoding whenever submitting itself. To cause decoding in the children of the table, use the row editing feature for row-scoped input decoding, ajax submit the form (or other table parent) for broad decodingor enable this option to submit during all table operations.
setAlwaysExecuteContents
in interface IDataTable
public java.lang.Boolean isAlwaysExecuteContents()
Return the value of the alwaysExecuteContents
property.
Contents: Enable the decoding of child components during table feature requests. The table attempts to decode children whenever it is executed, meaning whenever a parent region is submitted, or the table submits itself to paginate, make a selection, reorder columns, or any other feature. Decoding children during feature requests can result in unwanted input submission (during pagination for example), so by default this component suppresses child decoding whenever submitting itself. To cause decoding in the children of the table, use the row editing feature for row-scoped input decoding, ajax submit the form (or other table parent) for broad decodingor enable this option to submit during all table operations. Default = 'false'.
isAlwaysExecuteContents
in interface IDataTable
public void setClickableHeaderSorting(boolean clickableHeaderSorting)
Set the value of the clickableHeaderSorting
property.
Contents: Enabling makes the entire header container the clickable region for sort events.
setClickableHeaderSorting
in interface IDataTable
public boolean isClickableHeaderSorting()
Return the value of the clickableHeaderSorting
property.
Contents: Enabling makes the entire header container the clickable region for sort events. Default = 'true'.
isClickableHeaderSorting
in interface IDataTable
public void setColumnOrdering(java.util.List columnOrdering)
Set the value of the columnOrdering
property.
Contents: Defines a list of integers representing a rendering order for the Column children of the table.
setColumnOrdering
in interface IDataTable
public java.util.List getColumnOrdering()
Return the value of the columnOrdering
property.
Contents: Defines a list of integers representing a rendering order for the Column children of the table.
getColumnOrdering
in interface IDataTable
public void setColumnPinning(boolean columnPinning)
Set the value of the columnPinning
property.
Contents: Enable statically positioned columns along the left hand side of a scrollable table.
setColumnPinning
in interface IDataTable
public boolean isColumnPinning()
Return the value of the columnPinning
property.
Contents: Enable statically positioned columns along the left hand side of a scrollable table.
isColumnPinning
in interface IDataTable
public void setColumnPinningControlsInHeader(boolean columnPinningControlsInHeader)
Set the value of the columnPinningControlsInHeader
property.
Contents: Enable client controls to add column to the list of statically positioned columns.
setColumnPinningControlsInHeader
in interface IDataTable
public boolean isColumnPinningControlsInHeader()
Return the value of the columnPinningControlsInHeader
property.
Contents: Enable client controls to add column to the list of statically positioned columns.
isColumnPinningControlsInHeader
in interface IDataTable
public void setConstantRefilter(boolean constantRefilter)
Set the value of the constantRefilter
property.
Contents: Enable to force creation of the filtered data set from the bound value every render. Alternately attempt to use hashCodes of the value property to detect changes and prompt refiltering.
setConstantRefilter
in interface IDataTable
public boolean isConstantRefilter()
Return the value of the constantRefilter
property.
Contents: Enable to force creation of the filtered data set from the bound value every render. Alternately attempt to use hashCodes of the value property to detect changes and prompt refiltering. Default = 'false'.
isConstantRefilter
in interface IDataTable
public void setCurrentPageReportTemplate(java.lang.String currentPageReportTemplate)
Set the value of the currentPageReportTemplate
property.
Contents: Defines a coded string representing the layout of the text displaying the current page. Default is: "{currentPage} of {totalPages}".
setCurrentPageReportTemplate
in interface IDataTable
public java.lang.String getCurrentPageReportTemplate()
Return the value of the currentPageReportTemplate
property.
Contents: Defines a coded string representing the layout of the text displaying the current page. Default is: "{currentPage} of {totalPages}".
getCurrentPageReportTemplate
in interface IDataTable
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
Contents: Disable all features of the data table.
setDisabled
in interface IDataTable
public boolean isDisabled()
Return the value of the disabled
property.
Contents: Disable all features of the data table. Default = 'false'.
isDisabled
in interface IDataTable
public void setDoubleClickSelect(boolean doubleClickSelect)
Set the value of the doubleClickSelect
property.
Contents: Enable to require a double-click to fire row/cell selection events.
setDoubleClickSelect
in interface IDataTable
public boolean isDoubleClickSelect()
Return the value of the doubleClickSelect
property.
Contents: Enable to require a double-click to fire row/cell selection events.
isDoubleClickSelect
in interface IDataTable
public void setEmptyMessage(java.lang.String emptyMessage)
Set the value of the emptyMessage
property.
Contents: Define a string to render when there are no records to display.
setEmptyMessage
in interface IDataTable
public java.lang.String getEmptyMessage()
Return the value of the emptyMessage
property.
Contents: Define a string to render when there are no records to display.
getEmptyMessage
in interface IDataTable
public void setFilterEvent(java.lang.String filterEvent)
Set the value of the filterEvent
property.
Contents: Defines the Javascript event on which to trigger filter event, ex. 'keyup', 'blur', 'change' and 'enter'.
setFilterEvent
in interface IDataTable
public java.lang.String getFilterEvent()
Return the value of the filterEvent
property.
Contents: Defines the Javascript event on which to trigger filter event, ex. 'keyup', 'blur', 'change' and 'enter'. Default = 'change'.
getFilterEvent
in interface IDataTable
public void setFilterListener(javax.el.MethodExpression filterListener)
Set the value of the filterListener
property.
Contents: MethodExpression reference called whenever the table row is filtered. The method receives a single argument, TableFilterEvent.
setFilterListener
in interface IDataTable
public javax.el.MethodExpression getFilterListener()
Return the value of the filterListener
property.
Contents: MethodExpression reference called whenever the table row is filtered. The method receives a single argument, TableFilterEvent.
getFilterListener
in interface IDataTable
public void setFilterValue(java.lang.String filterValue)
Set the value of the filterValue
property.
Contents: Defines the input to the column non-specific filter, coming from the client, or from the app via a value binding.
setFilterValue
in interface IDataTable
public java.lang.String getFilterValue()
Return the value of the filterValue
property.
Contents: Defines the input to the column non-specific filter, coming from the client, or from the app via a value binding.
getFilterValue
in interface IDataTable
public void setGroupedFilterResults(boolean groupedFilterResults)
Set the value of the groupedFilterResults
property.
Contents: Enable to display all members of groups (as defined by ace:column groupBy) that contain a matching row during filtering.
setGroupedFilterResults
in interface IDataTable
public boolean isGroupedFilterResults()
Return the value of the groupedFilterResults
property.
Contents: Enable to display all members of groups (as defined by ace:column groupBy) that contain a matching row during filtering.
isGroupedFilterResults
in interface IDataTable
public void setHeight(java.lang.Integer height)
Set the value of the height
property.
Contents: Defines a fixed height for the scrollable table in pixels. Deprecated; superseded by scrollHeight.
setHeight
in interface IDataTable
public java.lang.Integer getHeight()
Return the value of the height
property.
Contents: Defines a fixed height for the scrollable table in pixels. Deprecated; superseded by scrollHeight.
getHeight
in interface IDataTable
public void setHiddenScrollableSizing(java.lang.Boolean hiddenScrollableSizing)
Set the value of the hiddenScrollableSizing
property.
Contents: Enable the default handling of the scrollable table when rendered into a hidden page region. The table attempts to poll its hidden status, looking for when it is shown and then call the scrollable table sizing JavaScript. This can be expensive in environments of reduced JavaScript performance with many tables and a complex DOM. When this is disabled, upon revealing a hidden scrollable table, to ensure it is sized correctly the JS 'tableWidgetVar.resizeScrolling()' function must be called.
setHiddenScrollableSizing
in interface IDataTable
public java.lang.Boolean isHiddenScrollableSizing()
Return the value of the hiddenScrollableSizing
property.
Contents: Enable the default handling of the scrollable table when rendered into a hidden page region. The table attempts to poll its hidden status, looking for when it is shown and then call the scrollable table sizing JavaScript. This can be expensive in environments of reduced JavaScript performance with many tables and a complex DOM. When this is disabled, upon revealing a hidden scrollable table, to ensure it is sized correctly the JS 'tableWidgetVar.resizeScrolling()' function must be called. Default = 'true'.
isHiddenScrollableSizing
in interface IDataTable
public void setLazy(boolean lazy)
Set the value of the lazy
property.
Contents: Enables lazy loading. Lazy loading expects the 'value' property to reference an instance of LazyDataModel, an interface to support incremental fetching of table entities.
setLazy
in interface IDataTable
public boolean isLazy()
Return the value of the lazy
property.
Contents: Enables lazy loading. Lazy loading expects the 'value' property to reference an instance of LazyDataModel, an interface to support incremental fetching of table entities.
isLazy
in interface IDataTable
public void setLiveScroll(boolean liveScroll)
Set the value of the liveScroll
property.
Contents: Enables the table to insert additional rows as scrolling reaches the bottom of the table. The 'rows' property configures the number of new rows to be loaded. Note: This feature is deprecated as of version 3.1 and is not supported. This property will be removed in a future release.
setLiveScroll
in interface IDataTable
public boolean isLiveScroll()
Return the value of the liveScroll
property.
Contents: Enables the table to insert additional rows as scrolling reaches the bottom of the table. The 'rows' property configures the number of new rows to be loaded. Note: This feature is deprecated as of version 3.1 and is not supported. This property will be removed in a future release.
isLiveScroll
in interface IDataTable
public void setPage(int page)
Set the value of the page
property.
Contents: Defines the index of the current page, beginning at 1.
setPage
in interface IDataTable
public int getPage()
Return the value of the page
property.
Contents: Defines the index of the current page, beginning at 1.
getPage
in interface IDataTable
public void setPageCount(java.lang.Integer pageCount)
Set the value of the pageCount
property.
Contents: Defines the maximum number of individual page links to display in paginator.
setPageCount
in interface IDataTable
public java.lang.Integer getPageCount()
Return the value of the pageCount
property.
Contents: Defines the maximum number of individual page links to display in paginator. Default = '10'.
getPageCount
in interface IDataTable
public void setPaginator(boolean paginator)
Set the value of the paginator
property.
Contents: Enables pagination on the table. Note that the paginator works by adjusting the 'first' and 'page' properties and that disabling the paginator will not return these properties to their defaults; instead leaving the table at the position that was paginated to. To return the table to the first page, 'first' must be set to 0, or 'page' must be set to 1.Alternately the table has a convenience method for this, DataTable.resetSorting().
setPaginator
in interface IDataTable
public boolean isPaginator()
Return the value of the paginator
property.
Contents: Enables pagination on the table. Note that the paginator works by adjusting the 'first' and 'page' properties and that disabling the paginator will not return these properties to their defaults; instead leaving the table at the position that was paginated to. To return the table to the first page, 'first' must be set to 0, or 'page' must be set to 1.Alternately the table has a convenience method for this, DataTable.resetSorting().
isPaginator
in interface IDataTable
public void setPaginatorAlwaysVisible(boolean paginatorAlwaysVisible)
Set the value of the paginatorAlwaysVisible
property.
Contents: Defines whether the paginator always displays, even when fewer then 1 page full of items are displayed.
setPaginatorAlwaysVisible
in interface IDataTable
public boolean isPaginatorAlwaysVisible()
Return the value of the paginatorAlwaysVisible
property.
Contents: Defines whether the paginator always displays, even when fewer then 1 page full of items are displayed.
isPaginatorAlwaysVisible
in interface IDataTable
public void setPaginatorPosition(java.lang.String paginatorPosition)
Set the value of the paginatorPosition
property.
Contents: Defines the location of the paginator if enabled. Available options are top, bottom, or the default, both.
setPaginatorPosition
in interface IDataTable
public java.lang.String getPaginatorPosition()
Return the value of the paginatorPosition
property.
Contents: Defines the location of the paginator if enabled. Available options are top, bottom, or the default, both. Default = 'both'.
getPaginatorPosition
in interface IDataTable
public void setPaginatorTemplate(java.lang.String paginatorTemplate)
Set the value of the paginatorTemplate
property.
Contents: Defines a coded string representing the controls available as part of the paginator. Default is: "{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}".
setPaginatorTemplate
in interface IDataTable
public java.lang.String getPaginatorTemplate()
Return the value of the paginatorTemplate
property.
Contents: Defines a coded string representing the controls available as part of the paginator. Default is: "{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}".
getPaginatorTemplate
in interface IDataTable
public void setReorderableColumns(boolean reorderableColumns)
Set the value of the reorderableColumns
property.
Contents: Enable reordering of the table columns via header dragging.
setReorderableColumns
in interface IDataTable
public boolean isReorderableColumns()
Return the value of the reorderableColumns
property.
Contents: Enable reordering of the table columns via header dragging.
isReorderableColumns
in interface IDataTable
public void setResizableColumns(boolean resizableColumns)
Set the value of the resizableColumns
property.
Contents: Enable resizing of the table columns via handles on the column headers.
setResizableColumns
in interface IDataTable
public boolean isResizableColumns()
Return the value of the resizableColumns
property.
Contents: Enable resizing of the table columns via handles on the column headers.
isResizableColumns
in interface IDataTable
public void setRowIndexVar(java.lang.String rowIndexVar)
Set the value of the rowIndexVar
property.
Contents: The request-scope attribute (if any) under which the data object index for the current row will be exposed when iterating.
setRowIndexVar
in interface IDataTable
public java.lang.String getRowIndexVar()
Return the value of the rowIndexVar
property.
Contents: The request-scope attribute (if any) under which the data object index for the current row will be exposed when iterating.
getRowIndexVar
in interface IDataTable
public void setRowSelectListener(javax.el.MethodExpression rowSelectListener)
Set the value of the rowSelectListener
property.
Contents: MethodExpression reference called whenever a table element is selected. The method receives a single argument, RowSelectEvent.
setRowSelectListener
in interface IDataTable
public javax.el.MethodExpression getRowSelectListener()
Return the value of the rowSelectListener
property.
Contents: MethodExpression reference called whenever a table element is selected. The method receives a single argument, RowSelectEvent.
getRowSelectListener
in interface IDataTable
public void setRowStateVar(java.lang.String rowStateVar)
Set the value of the rowStateVar
property.
Contents: The request-scope attribute (if any) under which the table state object for the current row will be exposed when iterating.
setRowStateVar
in interface IDataTable
public java.lang.String getRowStateVar()
Return the value of the rowStateVar
property.
Contents: The request-scope attribute (if any) under which the table state object for the current row will be exposed when iterating. Default = 'rowState'.
getRowStateVar
in interface IDataTable
public void setRowStyleClass(java.lang.String rowStyleClass)
Set the value of the rowStyleClass
property.
Contents: Define css classes for each row of the dataTable. EL can be used in this attribute to produce conditional row styling.
setRowStyleClass
in interface IDataTable
public java.lang.String getRowStyleClass()
Return the value of the rowStyleClass
property.
Contents: Define css classes for each row of the dataTable. EL can be used in this attribute to produce conditional row styling.
getRowStyleClass
in interface IDataTable
public void setRowUnselectListener(javax.el.MethodExpression rowUnselectListener)
Set the value of the rowUnselectListener
property.
Contents: MethodExpression reference called whenever a table element is deselected. The method receives a single argument, RowUnselectEvent.
setRowUnselectListener
in interface IDataTable
public javax.el.MethodExpression getRowUnselectListener()
Return the value of the rowUnselectListener
property.
Contents: MethodExpression reference called whenever a table element is deselected. The method receives a single argument, RowUnselectEvent.
getRowUnselectListener
in interface IDataTable
public void setRows(int rows)
Set the value of the rows
property.
Contents: The number of rows to be displayed, or zero to display the entire set of available rows.
setRows
in interface IDataTable
setRows
in class javax.faces.component.UIData
public int getRows()
Return the value of the rows
property.
Contents: The number of rows to be displayed, or zero to display the entire set of available rows. Default = '0'.
getRows
in interface IDataTable
getRows
in class javax.faces.component.UIData
public void setRowsPerPageTemplate(java.lang.String rowsPerPageTemplate)
Set the value of the rowsPerPageTemplate
property.
Contents: Defines a list of comma separated integer values that represent the options of "number of items per page" presented to the user. "all" is a special keyword that allowsa user to reset the pagination offset show all rows. The "all" option label is defined by the message key "org.icefaces.ace.component.datatable.ALL_LABEL". Any non-numerical value other than "all" will cause a NumberFormatException.
setRowsPerPageTemplate
in interface IDataTable
public java.lang.String getRowsPerPageTemplate()
Return the value of the rowsPerPageTemplate
property.
Contents: Defines a list of comma separated integer values that represent the options of "number of items per page" presented to the user. "all" is a special keyword that allowsa user to reset the pagination offset show all rows. The "all" option label is defined by the message key "org.icefaces.ace.component.datatable.ALL_LABEL". Any non-numerical value other than "all" will cause a NumberFormatException.
getRowsPerPageTemplate
in interface IDataTable
public void setScrollHeight(java.lang.Integer scrollHeight)
Set the value of the scrollHeight
property.
Contents: Defines a fixed height for the scrollable table in pixels.
setScrollHeight
in interface IDataTable
public java.lang.Integer getScrollHeight()
Return the value of the scrollHeight
property.
Contents: Defines a fixed height for the scrollable table in pixels. Default = '100'.
getScrollHeight
in interface IDataTable
public void setScrollWidthIE7(java.lang.String scrollWidthIE7)
Set the value of the scrollWidthIE7
property.
Contents: When using the DataTable scrollable mode, the IE7 configuration gives an equal width to evey column, and defaults to 100% width. This implies there is never a horizontal scrollbar for the table, unless a fixed width is used on the table or the container of the table. Ratherthan doing this via CSS, this property will apply (via JS) the given width and necessary overflow rules to the ancestors of the DataTable elements to produce a scrollbar.Other browsers will produce a horizontal scrollbar automatically when required and this property is ignored.
setScrollWidthIE7
in interface IDataTable
public java.lang.String getScrollWidthIE7()
Return the value of the scrollWidthIE7
property.
Contents: When using the DataTable scrollable mode, the IE7 configuration gives an equal width to evey column, and defaults to 100% width. This implies there is never a horizontal scrollbar for the table, unless a fixed width is used on the table or the container of the table. Ratherthan doing this via CSS, this property will apply (via JS) the given width and necessary overflow rules to the ancestors of the DataTable elements to produce a scrollbar.Other browsers will produce a horizontal scrollbar automatically when required and this property is ignored.
getScrollWidthIE7
in interface IDataTable
public void setScrollable(boolean scrollable)
Set the value of the scrollable
property.
Contents: Enabling renders a table that overflows the fixed height and adds a scrollbar. Note, used in combination with multi-row headers defined by a ColumnGroupcomponent, it is assumed that every body column of the table will have a associated single column spanning header column on the bottom row of the multi-row header. This is to allow for appropriate sizing of the scrollable column and the associated header td. Note,in IE7, the CSS/DOM engine doesn't suport the dynamic adjustments required for this feature andinstead the feature uses a fixed, equal size for each column of the table.
setScrollable
in interface IDataTable
public boolean isScrollable()
Return the value of the scrollable
property.
Contents: Enabling renders a table that overflows the fixed height and adds a scrollbar. Note, used in combination with multi-row headers defined by a ColumnGroupcomponent, it is assumed that every body column of the table will have a associated single column spanning header column on the bottom row of the multi-row header. This is to allow for appropriate sizing of the scrollable column and the associated header td. Note,in IE7, the CSS/DOM engine doesn't suport the dynamic adjustments required for this feature andinstead the feature uses a fixed, equal size for each column of the table.
isScrollable
in interface IDataTable
public void setSelectedCells(CellSelections[] selectedCells)
Set the value of the selectedCells
property.
Contents: Defines an array to be populated with objects referencing selected table cells and the rows they originate from.
setSelectedCells
in interface IDataTable
public CellSelections[] getSelectedCells()
Return the value of the selectedCells
property.
Contents: Defines an array to be populated with objects referencing selected table cells and the rows they originate from.
getSelectedCells
in interface IDataTable
public void setSelectionMode(java.lang.String selectionMode)
Set the value of the selectionMode
property.
Contents: Defines a code word indicating method of table element selection. Available values include: "multiple", "single", "cellblock", "cellrange" and "singlecell".
setSelectionMode
in interface IDataTable
public java.lang.String getSelectionMode()
Return the value of the selectionMode
property.
Contents: Defines a code word indicating method of table element selection. Available values include: "multiple", "single", "cellblock", "cellrange" and "singlecell".
getSelectionMode
in interface IDataTable
public void setSingleSort(boolean singleSort)
Set the value of the singleSort
property.
Contents: Disables sorting for multiple columns at once. Sorting is enabled by the use of sortBy on ace:column components.
setSingleSort
in interface IDataTable
public boolean isSingleSort()
Return the value of the singleSort
property.
Contents: Disables sorting for multiple columns at once. Sorting is enabled by the use of sortBy on ace:column components. Default = 'false'.
isSingleSort
in interface IDataTable
public void setStateMap(RowStateMap stateMap)
Set the value of the stateMap
property.
Contents: Defines a map of your row data objects to UI states. Row-level features (selection, expansion, etc.) are manipulable through this repository.
setStateMap
in interface IDataTable
public RowStateMap getStateMap()
Return the value of the stateMap
property.
Contents: Defines a map of your row data objects to UI states. Row-level features (selection, expansion, etc.) are manipulable through this repository.
getStateMap
in interface IDataTable
public void setStaticHeaders(java.lang.Boolean staticHeaders)
Set the value of the staticHeaders
property.
Contents: Enable the default scrollable table behaviour of using JavaScript to size a table header and footer that are in a fixed position regardless of table body scrolling.
setStaticHeaders
in interface IDataTable
public java.lang.Boolean isStaticHeaders()
Return the value of the staticHeaders
property.
Contents: Enable the default scrollable table behaviour of using JavaScript to size a table header and footer that are in a fixed position regardless of table body scrolling. Default = 'true'.
isStaticHeaders
in interface IDataTable
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.
setStyle
in interface IDataTable
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.
getStyle
in interface IDataTable
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
setStyleClass
in interface IDataTable
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
getStyleClass
in interface IDataTable
public void setTabIndex(java.lang.Integer tabIndex)
Set the value of the tabIndex
property.
Contents: Defines a tabindex to be shared by all keyboard navigable elements of the table. This includes sort controls, filter fields and individual rows themselves.
setTabIndex
in interface IDataTable
public java.lang.Integer getTabIndex()
Return the value of the tabIndex
property.
Contents: Defines a tabindex to be shared by all keyboard navigable elements of the table. This includes sort controls, filter fields and individual rows themselves. Default = '0'.
getTabIndex
in interface IDataTable
public void setToggleOnInvalidEdit(java.lang.Boolean toggleOnInvalidEdit)
Set the value of the toggleOnInvalidEdit
property.
Contents: Enable the the client to revert the edited row with the default state following a failed edit. By default when validation fails during a row editing request the row remains in editing mode.
setToggleOnInvalidEdit
in interface IDataTable
public java.lang.Boolean isToggleOnInvalidEdit()
Return the value of the toggleOnInvalidEdit
property.
Contents: Enable the the client to revert the edited row with the default state following a failed edit. By default when validation fails during a row editing request the row remains in editing mode. Default = 'false'.
isToggleOnInvalidEdit
in interface IDataTable
public void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar
property.
Contents: The JavaScript global component instance name. Must be unique among components on a page.
setWidgetVar
in interface IDataTable
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: The JavaScript global component instance name. Must be unique among components on a page.
getWidgetVar
in interface IDataTable
public void setApplyingFilters(java.lang.Boolean applyingFilters)
Set the value of the applyingFilters
property.
setApplyingFilters
in interface IDataTable
public java.lang.Boolean isApplyingFilters()
Return the value of the applyingFilters
property.
isApplyingFilters
in interface IDataTable
public void setApplyingSorts(java.lang.Boolean applyingSorts)
Set the value of the applyingSorts
property.
setApplyingSorts
in interface IDataTable
public java.lang.Boolean isApplyingSorts()
Return the value of the applyingSorts
property.
isApplyingSorts
in interface IDataTable
public void setCachedGlobalFilter(java.lang.Object cachedGlobalFilter)
Set the value of the cachedGlobalFilter
property.
setCachedGlobalFilter
in interface IDataTable
public java.lang.Object getCachedGlobalFilter()
Return the value of the cachedGlobalFilter
property.
getCachedGlobalFilter
in interface IDataTable
public void setFilteredData(java.util.List filteredData)
Set the value of the filteredData
property.
setFilteredData
in interface IDataTable
public java.util.List getFilteredData()
Return the value of the filteredData
property.
getFilteredData
in interface IDataTable
public void setForcedUpdateCounter(java.lang.Integer forcedUpdateCounter)
Set the value of the forcedUpdateCounter
property.
setForcedUpdateCounter
in interface IDataTable
public java.lang.Integer getForcedUpdateCounter()
Return the value of the forcedUpdateCounter
property.
getForcedUpdateCounter
in interface IDataTable
public void setRowToSelectedFieldsMap(java.util.Map rowToSelectedFieldsMap)
Set the value of the rowToSelectedFieldsMap
property.
setRowToSelectedFieldsMap
in interface IDataTable
public java.util.Map getRowToSelectedFieldsMap()
Return the value of the rowToSelectedFieldsMap
property.
getRowToSelectedFieldsMap
in interface IDataTable
public void setTableConfigPanel(java.lang.String tableConfigPanel)
Set the value of the tableConfigPanel
property.
setTableConfigPanel
in interface IDataTable
public java.lang.String getTableConfigPanel()
Return the value of the tableConfigPanel
property.
getTableConfigPanel
in interface IDataTable
public void setValueHashCode(java.lang.Integer valueHashCode)
Set the value of the valueHashCode
property.
setValueHashCode
in interface IDataTable
public java.lang.Integer getValueHashCode()
Return the value of the valueHashCode
property.
getValueHashCode
in interface IDataTable
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |