|
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
org.icefaces.ace.component.datatable.DataTable
public class DataTable
Nested Class Summary | |
---|---|
static class |
DataTable.SearchEffect
|
static class |
DataTable.SearchType
|
Nested classes/interfaces inherited from class org.icefaces.ace.component.datatable.DataTableBase |
---|
DataTableBase.PropertyKeys |
Field Summary | |
---|---|
protected boolean |
decoded
|
protected FilterState |
savedFilterState
|
protected PageState |
savedPageState
|
protected SortState |
savedSortState
|
Fields inherited from class org.icefaces.ace.component.datatable.DataTableBase |
---|
COMPONENT_TYPE, 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 | |
---|---|
DataTable()
|
Method Summary | |
---|---|
void |
addSelectedCell(java.lang.String selection)
|
void |
addSelectedCells(java.lang.String[] selections)
|
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)
|
protected void |
calculatePage()
|
protected void |
clearCachedStateMap()
|
void |
clearCellSelection()
|
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)
|
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.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()
|
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. |
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. |
java.lang.Integer |
getScrollHeight()
Return the value of the scrollHeight property. |
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)
|
protected boolean |
isPaginationRequest(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 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)
|
protected void |
refreshSelectedCells()
|
void |
removeSelectedCell(java.lang.String deselection)
|
void |
removeSelectedCells(java.lang.String[] deselections)
|
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 |
setSelectedCells(CellSelections[] cellSelection)
Set the value of the selectedCells property. |
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)
|
Methods inherited from class javax.faces.component.UIData |
---|
createUniqueId, encodeBegin, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, restoreState, saveState, setFirst, setFooter, setHeader, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar |
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, 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 |
---|
protected transient SortState savedSortState
protected transient FilterState savedFilterState
protected transient PageState savedPageState
protected transient boolean decoded
Constructor Detail |
---|
public DataTable()
Method Detail |
---|
protected void refreshSelectedCells()
public java.lang.Integer getScrollHeight()
DataTableBase
Return the value of the scrollHeight
property.
Contents: Defines a fixed height for the scrollable table in pixels. Default = '100'.
getScrollHeight
in interface IDataTable
getScrollHeight
in class DataTableBase
public void setSelectedCells(CellSelections[] cellSelection)
DataTableBase
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
setSelectedCells
in class DataTableBase
public RowStateMap getStateMap()
DataTableBase
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
getStateMap
in class DataTableBase
protected void clearCachedStateMap()
public java.lang.Object getValue()
getValue
in class javax.faces.component.UIData
protected javax.faces.model.DataModel getDataModel()
getDataModel
in class javax.faces.component.UIData
protected void setDataModel(javax.faces.model.DataModel dataModel)
setDataModel
in class javax.faces.component.UIData
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIData
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIData
javax.faces.event.AbortProcessingException
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class javax.faces.component.UIData
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIData
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class javax.faces.component.UIData
public void setRowIndex(int index)
setRowIndex
in class javax.faces.component.UIData
public 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 order
public java.util.List<Column> getColumns()
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()
DataTableBase
Return the value of the filteredData
property.
getFilteredData
in interface IDataTable
getFilteredData
in class DataTableBase
public void setFilteredData(java.util.List filteredData)
DataTableBase
Set the value of the filteredData
property.
setFilteredData
in interface IDataTable
setFilteredData
in class DataTableBase
public void applySorting()
public void applyFilters()
public java.lang.Boolean isApplyingFilters()
DataTableBase
Return the value of the applyingFilters
property.
isApplyingFilters
in interface IDataTable
isApplyingFilters
in class DataTableBase
public void removeSelectedCell(java.lang.String deselection)
public void removeSelectedCells(java.lang.String[] deselections)
public void addSelectedCells(java.lang.String[] selections)
public void addSelectedCell(java.lang.String selection)
public void clearCellSelection()
public 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 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 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 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()
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.UIData
public 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.UIComponent
public java.lang.String getClientId(javax.faces.context.FacesContext context)
getClientId
in class javax.faces.component.UIData
protected java.lang.String UIComponentBase_getClientId(javax.faces.context.FacesContext context)
protected java.lang.String UIData_getContainerClientId(javax.faces.context.FacesContext facesContext)
|
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 |