public class DataTable extends DataTableBase implements java.io.Serializable
| Modifier and Type | Class and Description |
|---|---|
static class |
DataTable.SearchEffect |
static class |
DataTable.SearchType |
DataTableBase.PropertyKeys| Modifier and Type | Field and Description |
|---|---|
protected boolean |
decoded |
protected java.lang.String |
editSubmit |
protected FilterState |
savedFilterState |
protected PageState |
savedPageState |
protected java.util.Map<java.lang.String,SelectionDeltaState> |
savedSelectionChanges |
protected SortState |
savedSortState |
COMPONENT_TYPE, RENDERER_TYPE| Constructor and Description |
|---|
DataTable() |
| Modifier and Type | Method and Description |
|---|---|
void |
applyFilters()
Processes any changes to the filterInput property of the Columns to the data model;
refiltering the data model to meet the new criteria.
|
void |
applySorting()
Processes any changes to sortPriority or sortAscending properties of Columns
to the data model; resorting the table according to the new settings.
|
void |
broadcast(javax.faces.event.FacesEvent event) |
void |
broadcast(javax.faces.event.FacesEvent event,
boolean skipRegen) |
protected void |
calculatePage() |
protected void |
clearCachedStateMap() |
int |
findRow(java.lang.String query,
java.lang.String[] fields,
int startRow)
Find the index of a row object in the current DataModel.
|
int |
findRow(java.lang.String query,
java.lang.String[] fields,
int startRow,
DataTable.SearchType searchType)
Find the index of a row object in the current DataModel.
|
int |
findRow(java.lang.String query,
java.lang.String[] fields,
int startRow,
DataTable.SearchType searchType,
boolean caseSensitive)
Find the index of a row object in the current DataModel.
|
protected TableConfigPanel |
findTableConfigPanel(javax.faces.context.FacesContext context) |
java.lang.String |
getBaseClientId(javax.faces.context.FacesContext context) |
java.lang.String |
getClientId(javax.faces.context.FacesContext context) |
protected ColumnGroup |
getColumnGroup(java.lang.String target) |
ColumnModel |
getColumnModel() |
java.util.List<Column> |
getColumns()
Generates the list of DataTable Column children, reordered according to the
column ordering property.
|
java.util.List<Column> |
getColumns(boolean headColumns)
Generates the list of DataTable Column children, reordered according to the
column ordering property, or the header ColumnGroup columns in page order.
|
java.util.List<Row> |
getConditionalRows(int rowIndex,
boolean before) |
java.lang.String |
getContainerClientId(javax.faces.context.FacesContext context) |
protected javax.faces.model.DataModel |
getDataModel() |
java.lang.String |
getEditSubmitParameter() |
java.util.List |
getFilteredData()
Return the value of the
filteredData property. |
protected java.util.Map<java.lang.String,Column> |
getFilterMap() |
protected java.util.Map<java.lang.String,java.lang.String> |
getFilters() |
int |
getFirst() |
int |
getFirst(boolean includeBufferRows) |
java.util.List<Column> |
getHeaderColumns()
Generates a list of DataTable Column children intended to render the header, either from the header segement, or
from the normal grouping of columns.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getMaxFilters() |
protected java.util.Map<java.lang.String,java.lang.Object> |
getMinFilters() |
javax.faces.model.DataModel |
getModel()
A public proxy to the getDataModel() method, intended for use in situations
where a sub-component needs access to a custom DataModel object.
|
PanelExpansion |
getPanelExpansion()
If a PanelExpansion component is a child of this table, return it.
|
RowExpansion |
getRowExpansion()
If a RowExpansion component is a child of this table, return it.
|
int |
getRows()
Return the value of the
rows property. |
int |
getRows(boolean includeBufferRows) |
protected SortCriteria[] |
getSortCriteria() |
RowStateMap |
getStateMap()
Return the value of the
stateMap property. |
java.lang.Object |
getValue() |
protected boolean |
hasFooterColumn(java.util.List<Column> columns) |
protected boolean |
hasHeaders() |
protected boolean |
hasSelectionClientBehaviour() |
java.lang.Boolean |
hasTreeDataModel()
Determine if this DataTable is using a custom ICEFaces TreeDataModel.
|
java.lang.Boolean |
isApplyingFilters()
Return the value of the
applyingFilters property. |
protected boolean |
isCellSelection() |
protected boolean |
isColumnReorderRequest(javax.faces.context.FacesContext x) |
boolean |
isFilteringEnabled() |
protected boolean |
isFilterRequest(javax.faces.context.FacesContext x) |
protected java.lang.Boolean |
isInConditionalRow() |
protected java.lang.Boolean |
isInDuplicateSegment() |
protected boolean |
isInstantSelectionRequest(javax.faces.context.FacesContext x) |
protected boolean |
isInstantUnselectionRequest(javax.faces.context.FacesContext x) |
boolean |
isNestedTable() |
protected boolean |
isPaginationRequest(javax.faces.context.FacesContext x) |
protected boolean |
isRowExpansionRequest(javax.faces.context.FacesContext x) |
protected boolean |
isScrollingRequest(javax.faces.context.FacesContext x) |
protected boolean |
isSelectionEnabled() |
protected boolean |
isSingleSelectionMode() |
boolean |
isSortingEnabled() |
protected boolean |
isSortRequest(javax.faces.context.FacesContext x) |
protected boolean |
isTableConfigurationRequest(javax.faces.context.FacesContext x) |
protected boolean |
isTableFeatureRequest(javax.faces.context.FacesContext x) |
protected boolean |
isTrashConfigurationRequest(javax.faces.context.FacesContext x) |
protected void |
loadLazyData() |
void |
navigateToRow(int row)
Navigate the client to a row in the table, indicate the target row with a default highlight effect.
|
void |
navigateToRow(int row,
DataTable.SearchEffect effect)
Navigate the client to a row in the table, indicate the target row with the indicated effect, either pulsate or highlight.
|
void |
navigateToRow(int row,
java.lang.String effect,
java.lang.Integer durationMillis)
Navigate the client to a row in the table indicating the target row with css tween to a given class and back.
|
void |
processDecodes(javax.faces.context.FacesContext context) |
protected java.util.List |
processFilters(javax.faces.context.FacesContext context) |
protected void |
processSorting() |
void |
processUpdates(javax.faces.context.FacesContext context) |
void |
processValidators(javax.faces.context.FacesContext context) |
void |
queueEvent(javax.faces.event.FacesEvent event) |
void |
reset()
Sets the properties of this table to null, clears all filters and resets pagination.
|
void |
resetFilters()
Blanks the filterValue property of each Column component and removes the
presently filtered set of data.
|
void |
resetPagination()
Sets the position of pagination in the table to the first page.
|
void |
resetSorting()
Blanks the sortPriority and set to false the sortAscending property of each Column
component.
|
void |
resetValue()
Sets the value property of this dataTable to null.
|
protected void |
setColumnOrdering(java.lang.String[] indexes) |
protected void |
setDataModel(javax.faces.model.DataModel dataModel) |
void |
setFilteredData(java.util.List filteredData)
Set the value of the
filteredData property. |
protected void |
setInConditionalRow(java.lang.Boolean inConditionalRow,
java.util.List<Column> rowColumns) |
protected void |
setInDuplicateSegment(java.lang.Boolean inFakeHeader) |
void |
setModel(javax.faces.model.DataModel m)
A public proxy to the getDataModel() method, intended for use in situations
where a sub-component needs to null a cached DataModel to force regeneration.
|
void |
setRowIndex(int index) |
void |
setTableConfigPanel(TableConfigPanel panel)
Associates this table with a particular TableConfigPanel component.
|
protected java.lang.String |
UIComponentBase_getClientId(javax.faces.context.FacesContext context) |
protected java.lang.String |
UIData_getContainerClientId(javax.faces.context.FacesContext facesContext) |
boolean |
visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback) |
addClientBehavior, getAccesskey, getCachedGlobalFilter, getCaption, getColumnOrdering, getCurrentPageReportTemplate, getDefaultEventName, getDefaultExecute, getDefaultRender, getEmptyMessage, getEventNames, getFamily, getFilterEvent, getFilterListener, getFilterValue, getForcedUpdateCounter, getHeaderColumnOrdering, getLastReordering, getListenerArgument, getLiveScrollBufferPages, getPage, getPageCount, getPagesToSkip, getPaginatorAccesskey, getPaginatorPosition, getPaginatorTemplate, getRowIndexVar, getRowSelectListener, getRowsPerPageTemplate, getRowStateVar, getRowStyleClass, getRowUnselectListener, getScrollHeight, getScrollWidthIE7, getSelectionMode, getStyle, getStyleClass, getTabIndex, getTableConfigPanel, getValueHashCode, isAllColumnClicks, isAlwaysExecuteContents, isApplyingSorts, isClickableHeaderSorting, isColumnPinning, isColumnPinningControlsInHeader, isColumnsInheritProperties, isConstantRefilter, isDisabled, isDoubleClickSelect, isGroupedFilterResults, isHiddenScrollableSizing, isLazy, isLiveScroll, isPaginator, isPaginatorAlwaysVisible, isPropertySet, isRenderRowTabindex, isReorderableColumns, isResizableColumns, isScrollable, isSingleSort, isStaticHeaders, isToggleOnInvalidEdit, setAccesskey, setAllColumnClicks, setAlwaysExecuteContents, setApplyingFilters, setApplyingSorts, setCachedGlobalFilter, setCaption, setClickableHeaderSorting, setColumnOrdering, setColumnPinning, setColumnPinningControlsInHeader, setColumnsInheritProperties, setConstantRefilter, setCurrentPageReportTemplate, setDisabled, setDoubleClickSelect, setEmptyMessage, setFilterEvent, setFilterListener, setFilterValue, setForcedUpdateCounter, setGroupedFilterResults, setHeaderColumnOrdering, setHiddenScrollableSizing, setLastReordering, setLazy, setLiveScroll, setLiveScrollBufferPages, setPage, setPageCount, setPagesToSkip, setPaginator, setPaginatorAccesskey, setPaginatorAlwaysVisible, setPaginatorPosition, setPaginatorTemplate, setRenderRowTabindex, setReorderableColumns, setResizableColumns, setRowIndexVar, setRows, setRowSelectListener, setRowsPerPageTemplate, setRowStateVar, setRowStyleClass, setRowUnselectListener, setScrollable, setScrollHeight, setScrollWidthIE7, setSelectionMode, setSingleSort, setStateMap, setStaticHeaders, setStyle, setStyleClass, setTabIndex, setTableConfigPanel, setToggleOnInvalidEdit, setValueExpression, setValueHashCodecreateUniqueId, encodeBegin, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, restoreState, saveState, setFirst, setFooter, setHeader, setRowStatePreserved, setValue, setValueBinding, setVaraddFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInViewprotected transient SortState savedSortState
protected transient FilterState savedFilterState
protected transient PageState savedPageState
protected transient java.util.Map<java.lang.String,SelectionDeltaState> savedSelectionChanges
protected transient boolean decoded
protected transient java.lang.String editSubmit
public java.lang.String getEditSubmitParameter()
public RowStateMap getStateMap()
DataTableBaseReturn 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. Note that it is necessary that the data object implement custom hashCode() and equals() methods for advanced features to work correctly. see wiki for more information.
getStateMap in interface IDataTablegetStateMap in class DataTableBaseprotected void clearCachedStateMap()
public java.lang.Object getValue()
getValue in class javax.faces.component.UIDataprotected javax.faces.model.DataModel getDataModel()
getDataModel in class javax.faces.component.UIDataprotected void setDataModel(javax.faces.model.DataModel dataModel)
setDataModel in class javax.faces.component.UIDatapublic void queueEvent(javax.faces.event.FacesEvent event)
queueEvent in class javax.faces.component.UIDatapublic void broadcast(javax.faces.event.FacesEvent event)
throws javax.faces.event.AbortProcessingException
broadcast in class javax.faces.component.UIDatajavax.faces.event.AbortProcessingExceptionpublic void broadcast(javax.faces.event.FacesEvent event,
boolean skipRegen)
throws javax.faces.event.AbortProcessingException
javax.faces.event.AbortProcessingExceptionpublic void processUpdates(javax.faces.context.FacesContext context)
processUpdates in class javax.faces.component.UIDatapublic void processDecodes(javax.faces.context.FacesContext context)
processDecodes in class javax.faces.component.UIDatapublic void processValidators(javax.faces.context.FacesContext context)
processValidators in class javax.faces.component.UIDatapublic void setRowIndex(int index)
setRowIndex in class javax.faces.component.UIDatapublic boolean isSortingEnabled()
public boolean isFilteringEnabled()
public javax.faces.model.DataModel getModel()
public void setModel(javax.faces.model.DataModel m)
public java.lang.Boolean hasTreeDataModel()
public PanelExpansion getPanelExpansion()
public RowExpansion getRowExpansion()
public java.util.List<Column> getColumns(boolean headColumns)
headColumns - Enable to return the header columns in page orderpublic java.util.List<Column> getColumns()
public ColumnModel getColumnModel()
public java.util.List<Column> getHeaderColumns()
public void setTableConfigPanel(TableConfigPanel panel)
panel - TableConfigPanel component that will configure this table.public void resetValue()
public void resetPagination()
public void reset()
public void resetSorting()
public void resetFilters()
public java.util.List getFilteredData()
DataTableBaseReturn the value of the filteredData property.
getFilteredData in interface IDataTablegetFilteredData in class DataTableBasepublic void setFilteredData(java.util.List filteredData)
DataTableBaseSet the value of the filteredData property.
setFilteredData in interface IDataTablesetFilteredData in class DataTableBasepublic void applySorting()
public void applyFilters()
public java.lang.Boolean isApplyingFilters()
DataTableBaseReturn the value of the applyingFilters property.
isApplyingFilters in interface IDataTableisApplyingFilters in class DataTableBasepublic int findRow(java.lang.String query,
java.lang.String[] fields,
int startRow,
DataTable.SearchType searchType,
boolean caseSensitive)
query - The string to be searched for in the row object fields.fields - The fields of the row object to search the String representations of.startRow - The index to begin searching, inclusive.searchType - A enumeration representing where to search for a match.caseSensitive - A boolean representing the case sensitive.public int findRow(java.lang.String query,
java.lang.String[] fields,
int startRow,
DataTable.SearchType searchType)
query - The string to be searched for in the row object fields.fields - The fields of the row object to search the String representations of.startRow - The index to begin searching, inclusive.searchType - A enumeration representing where to search for a match.public int findRow(java.lang.String query,
java.lang.String[] fields,
int startRow)
query - The string to be searched for in the row object fields.fields - The fields of the row object to search the String representations of.startRow - The index to begin searching, inclusive.public void navigateToRow(int row,
java.lang.String effect,
java.lang.Integer durationMillis)
row - Index of the row to be navigated to.effect - Name of css class to add to the target and than remove.durationMillis - Duration of wax and wane of css animation.public void navigateToRow(int row,
DataTable.SearchEffect effect)
row - Index of the row to be navigated to.effect - SearchEffect enum indicating pulsate or highlight.public void navigateToRow(int row)
row - Index of the row to be navigated to.protected boolean isPaginationRequest(javax.faces.context.FacesContext x)
protected boolean isTableConfigurationRequest(javax.faces.context.FacesContext x)
protected boolean isTrashConfigurationRequest(javax.faces.context.FacesContext x)
protected boolean isColumnReorderRequest(javax.faces.context.FacesContext x)
protected boolean isSortRequest(javax.faces.context.FacesContext x)
protected boolean isFilterRequest(javax.faces.context.FacesContext x)
protected boolean isInstantSelectionRequest(javax.faces.context.FacesContext x)
protected boolean isInstantUnselectionRequest(javax.faces.context.FacesContext x)
protected boolean isScrollingRequest(javax.faces.context.FacesContext x)
protected boolean isTableFeatureRequest(javax.faces.context.FacesContext x)
protected boolean isRowExpansionRequest(javax.faces.context.FacesContext x)
protected java.lang.Boolean isInDuplicateSegment()
protected void setInDuplicateSegment(java.lang.Boolean inFakeHeader)
protected java.lang.Boolean isInConditionalRow()
protected void setInConditionalRow(java.lang.Boolean inConditionalRow,
java.util.List<Column> rowColumns)
protected java.util.Map<java.lang.String,Column> getFilterMap()
protected ColumnGroup getColumnGroup(java.lang.String target)
protected SortCriteria[] getSortCriteria()
protected java.util.Map<java.lang.String,java.lang.String> getFilters()
protected java.util.Map<java.lang.String,java.lang.Object> getMinFilters()
protected java.util.Map<java.lang.String,java.lang.Object> getMaxFilters()
protected boolean hasHeaders()
public java.util.List<Row> getConditionalRows(int rowIndex, boolean before)
protected boolean hasSelectionClientBehaviour()
protected boolean hasFooterColumn(java.util.List<Column> columns)
protected boolean isSelectionEnabled()
protected boolean isCellSelection()
protected boolean isSingleSelectionMode()
protected TableConfigPanel findTableConfigPanel(javax.faces.context.FacesContext context)
protected void setColumnOrdering(java.lang.String[] indexes)
protected void calculatePage()
public int getRows()
DataTableBaseReturn 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 IDataTablegetRows in class DataTableBasepublic int getRows(boolean includeBufferRows)
public int getFirst()
getFirst in class javax.faces.component.UIDatapublic int getFirst(boolean includeBufferRows)
public boolean isNestedTable()
protected void processSorting()
protected java.util.List processFilters(javax.faces.context.FacesContext context)
protected void loadLazyData()
public boolean visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback)
visitTree in class javax.faces.component.UIDatapublic java.lang.String getBaseClientId(javax.faces.context.FacesContext context)
public java.lang.String getContainerClientId(javax.faces.context.FacesContext context)
getContainerClientId in class javax.faces.component.UIComponentpublic java.lang.String getClientId(javax.faces.context.FacesContext context)
getClientId in class javax.faces.component.UIDataprotected java.lang.String UIComponentBase_getClientId(javax.faces.context.FacesContext context)
protected java.lang.String UIData_getContainerClientId(javax.faces.context.FacesContext facesContext)
Copyright 2017 ICEsoft Technologies Canada Corp., All Rights Reserved.