Package com.webmethods.caf.faces.data
Interface ISelectableTableContentProvider
- All Superinterfaces:
IAddressableTableContentProvider
,IContentProvider
,ITableContentProvider
- All Known Subinterfaces:
ISelectableTreeContentProvider
- All Known Implementing Classes:
BaseIteratorTableContentProvider
,BaseTaskSearchContentProvider
,BoundChildrenTreeContentProvider
,ChildrenTableContentProvider
,CustomTaskSearchContentProvider
,DirectorySearchProvider
,FilterableListTreeContentProvider
,FilterableSelectableListTableContentProvider
,FilteredPortalContainerModel
,GMarkerGroupTableContentProvider
,LazyNodeTreeContentProvider
,ListTreeContentProvider
,NodeTreeContentProvider
,PageableTableContentProvider
,PeopleSearchProvider
,PortalContainerModel
,ProcessSearchProvider
,RowSetTableContentProvider
,SearchTableContentProvider
,SelectableListTableContentProvider
,TableTreeContentProvider
,TaskInboxHpstraSearchContentProvider
,TaskInboxIndexedSearchContentProvider
,TaskInboxSearchContentProvider
,TaskIndexedSearchContentProvider
,TaskSavedSearchContentProvider
,TaskSearchContentProvider
,VersionHistoryTableContentProvider
,XMLTableContentProvider
,XMLTreeContentProvider
Table content provider that supports selecting individual rows by leveraging ability of identifying and addressing rows by id from <@link com.webmethods.caf.faces.data.IAddressableTableContentProvider}
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns number of selected rows.Returns collection ofString
ids of the selected rows.Returns collection ofString
ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.boolean
Returns true if it's more effecient to use unselected model (iegetRowUnselectedIds()
rather thangetRowSelectedIds()
).boolean
Returnstrue
if current row is selected.void
setRowSelected
(boolean selected) Sets the selection status for the current row.void
Sets new selection using a collection ofString
ids of the rows to select.void
Unselects rows using a collection ofString
ids of the un-selected rows (all other rows are selected implicitly).Methods inherited from interface com.webmethods.caf.faces.data.IAddressableTableContentProvider
getRowId, isAddressable, setRowById
Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider
getPropertyKeys, getType, getValue, hasProperty, toString
Methods inherited from interface com.webmethods.caf.faces.data.ITableContentProvider
getCurrentRow, getRowCount, getRowIndex, getRowVariable, isRowAvailable, setRowIndex, setRowVariable
-
Method Details
-
isRowSelected
boolean isRowSelected()Returnstrue
if current row is selected.- Returns:
- true if current row is selection
-
setRowSelected
void setRowSelected(boolean selected) Sets the selection status for the current row.- Parameters:
selected
-true
to select current row;false
to unselect.
-
getRowSelectedCount
int getRowSelectedCount()Returns number of selected rows.- Returns:
- number of currently selection rows
-
getRowSelectedIds
Collection getRowSelectedIds()Returns collection ofString
ids of the selected rows. May be empty or contain non-existent ids; never null, never contains null.- Returns:
- collection of ids of selected rows
-
setRowSelectedIds
Sets new selection using a collection ofString
ids of the rows to select. May be empty or contain non-existent ids; never null, never contains null.- Parameters:
ids
- the collection ofString
row ids
-
getUseUnselectedModel
boolean getUseUnselectedModel()Returns true if it's more effecient to use unselected model (iegetRowUnselectedIds()
rather thangetRowSelectedIds()
).- Returns:
- true if it's more effecient to use unselected model
-
getRowUnselectedIds
Collection getRowUnselectedIds()Returns collection ofString
ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.- Returns:
- collection of ids of the un-selection rows
-
setRowUnselectedIds
Unselects rows using a collection ofString
ids of the un-selected rows (all other rows are selected implicitly). May be empty or contain non-existent ids; never null, never contains null.- Parameters:
ids
- collection ofString
row ids
-