RowStateMap (ICEfaces Java API Documentation)

java.lang.Object
- org.icefaces.ace.model.table.RowStateMap

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.Object,RowState>
```
public class RowStateMap
extends java.lang.Object
implements java.util.Map<java.lang.Object,RowState>, java.io.Serializable
```
A Map that defines the ace:dataTable feature state of the row objects of a given ace:dataTable. States can be added at initialization, or will be created as needed during row object rendering if no state exists.

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

RowStateMap()

Constructors
Constructor and Description
`RowStateMap()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(java.lang.Object o)` Put a empty state for a specific row object.
`void`	`clear()` Remove all row states from this map.
`boolean`	`containsKey(java.lang.Object key)` Get if this map contains a state for a particular row object
`boolean`	`containsValue(java.lang.Object value)` Get if this map contains a particular row state
`java.util.Set`	`entrySet()` Get the collection of all Map Entry objects, defining a key row object and value row state.
`void`	`filterStates(javax.faces.model.DataModel model)` This method will remove all entries from the map but those with keys in this data model.
`void`	`filterStates(java.util.List data)` This method will remove all entries from the map but those with keys in this list.
`RowState`	`get(java.lang.Object o)` Get the row state for a particular row object
`java.util.List`	`getEditable()` Get the row objects that are editable
`java.util.List`	`getEditing(javax.faces.component.UIComponent editor)` Get the row objects that have activated a particular CellEditor.
`java.util.List`	`getExpandable()` Get the row objects that are expandible
`java.util.List`	`getExpanded()` Get the row objects that are expanded
`java.util.List`	`getPanelExpanders()` Get the row objects that expand into panels
`java.util.List`	`getRowExpanders()` Get the row objects that expand into other rows
`java.util.List`	`getRowsWithSelectedCells()` Get the list of row objects with cells that are selected.
`java.util.List`	`getSelectable()` Get row objects that are selectable
`java.util.List`	`getSelected()` Get the list of selected row objects.
`java.util.List`	`getVisible()` Get the row objects that are not invisible
`boolean`	`isEmpty()` Get if this map is empty
`java.util.Set`	`keySet()` Get the set of all row objects with attached RowStates
`RowState`	`put(java.lang.Object o, RowState s)` Put a new state for a specific row object.
`void`	`putAll(java.util.Map m)` Add all entries from the input map to this map.
`RowState`	`remove(java.lang.Object o)` Remove the row state for a particular row object.
`void`	`removeStates(java.util.List data)` This method will remove all entries from the map with keys in this list.
`void`	`setAllEditable(boolean value)` Set the editable state of all the row objects
`void`	`setAllEditing(javax.faces.component.UIComponent editor, boolean add)` Set the editing state for the given CellEditor
`void`	`setAllExpandable(boolean value)` Set the expandable state of all the row objects
`void`	`setAllExpanded(boolean value)` Set the expanded state of all the row objects
`void`	`setAllPanelExpansion()` Set the expansion mode of all the row objects to panel
`void`	`setAllRowExpansion()` Set the expansion mode of all the row objects to row
`void`	`setAllSelectable(boolean value)` Set the selectable state of all the row objects
`void`	`setAllSelected(boolean value)` Set the selection state of all the row objects
`void`	`setAllVisible(boolean value)` Set the visible state of all the row objects
`void`	`setExpandableByTreeModel(TreeDataModel dataModel)` Synchronize the expanded row state with the expanded state stored in the node of the data model.
`int`	`size()` Get the number of states held in this map
`void`	`updateData(java.util.List data)` This method will look up state entries with keys in the input list, and update their key with the copy from the input list.
`void`	`updateData(java.lang.Object o)` Replace a row object with one that hashes identically but is a distinct copy.
`java.util.Collection`	`values()` Get the collection of all RowStates

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Constructor Detail
  - RowStateMap
```
public RowStateMap()
```
- Method Detail
  - put
```
public RowState put(java.lang.Object o,
           RowState s)
```
    Put a new state for a specific row object. Overwrites old states.
    
    Specified by:
    
    put in interface java.util.Map<java.lang.Object,RowState>
    
    Parameters:
    o - row object
    s - new state
    
    Returns:
    old state or null if none existed
  - add
```
public void add(java.lang.Object o)
```
    Put a empty state for a specific row object. Overwrites old states.
    
    Parameters:
    o - row object
  - size
```
public int size()
```
    Get the number of states held in this map
    
    Specified by:
    
    size in interface java.util.Map<java.lang.Object,RowState>
    
    Returns:
    map entry count
  - isEmpty
```
public boolean isEmpty()
```
    Get if this map is empty
    
    Specified by:
    
    isEmpty in interface java.util.Map<java.lang.Object,RowState>
    
    Returns:
    if this map empty
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Get if this map contains a state for a particular row object
    
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.Object,RowState>
    
    Parameters:
    key - row object
    
    Returns:
    if this map contains the row object param
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Get if this map contains a particular row state
    
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.Object,RowState>
    
    Parameters:
    value - row state
    
    Returns:
    if this map contains the row state param
  - get
```
public RowState get(java.lang.Object o)
```
    Get the row state for a particular row object
    
    Specified by:
    
    get in interface java.util.Map<java.lang.Object,RowState>
    
    Parameters:
    o - row object
    
    Returns:
    row state
  - remove
```
public RowState remove(java.lang.Object o)
```
    Remove the row state for a particular row object. A new empty state will be added for the row if it is rendered in a coming request.
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Object,RowState>
    
    Parameters:
    o -
    
    Returns:
  - putAll
```
public void putAll(java.util.Map m)
```
    Add all entries from the input map to this map.
    
    Specified by:
    
    putAll in interface java.util.Map<java.lang.Object,RowState>
    
    Parameters:
    m - input map
  - clear
```
public void clear()
```
    Remove all row states from this map.
    
    Specified by:
    
    clear in interface java.util.Map<java.lang.Object,RowState>
  - keySet
```
public java.util.Set keySet()
```
    Get the set of all row objects with attached RowStates
    
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Object,RowState>
    
    Returns:
    set of row objects that have state
  - values
```
public java.util.Collection values()
```
    Get the collection of all RowStates
    
    Specified by:
    
    values in interface java.util.Map<java.lang.Object,RowState>
    
    Returns:
    the state of every row in this map
  - entrySet
```
public java.util.Set entrySet()
```
    Get the collection of all Map Entry objects, defining a key row object and value row state.
    
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.Object,RowState>
    
    Returns:
    row object state entry collection
  - updateData
```
public void updateData(java.lang.Object o)
```
    Replace a row object with one that hashes identically but is a distinct copy. Useful for updating the row state map when replacing the data set with a copy.
    
    Parameters:
    o -
  - updateData
```
public void updateData(java.util.List data)
```
    This method will look up state entries with keys in the input list, and update their key with the copy from the input list. This method is useful in applications where row data is updated by replacing a row with an object copy that is equal() but contains differences that must be reflected in methods that return row data from the rowStateMap. Without updating, in this circumstance, the key is still a reference to the old copy of the data, and though the state will be correctly correlated to the new key, methods returning the key, will return the old key.
    
    Parameters:
    data - - A list of row data equal() to some key already in the rowStateMap, but with changes that require the current key to be replaced.
  - removeStates
```
public void removeStates(java.util.List data)
```
    This method will remove all entries from the map with keys in this list.
    
    Parameters:
    data - the row data to remove states for
  - filterStates
```
public void filterStates(java.util.List data)
```
    This method will remove all entries from the map but those with keys in this list.
    
    Parameters:
    data - the row data list to keep states for
  - filterStates
```
public void filterStates(javax.faces.model.DataModel model)
```
    This method will remove all entries from the map but those with keys in this data model.
    
    Parameters:
    model - The data model to keep states for
  - setExpandableByTreeModel
```
public void setExpandableByTreeModel(TreeDataModel dataModel)
```
    Synchronize the expanded row state with the expanded state stored in the node of the data model. Data model expansion state overwrites pre-existing state.
    
    Parameters:
    dataModel - tree data model
  - getSelected
```
public java.util.List getSelected()
```
    Get the list of selected row objects.
    
    Returns:
    list of selected row objects
  - getRowsWithSelectedCells
```
public java.util.List getRowsWithSelectedCells()
```
    Get the list of row objects with cells that are selected.
    
    Returns:
    list of row objects with selected cells
  - getSelectable
```
public java.util.List getSelectable()
```
    Get row objects that are selectable
    
    Returns:
    the list of selectable row objects
  - getEditable
```
public java.util.List getEditable()
```
    Get the row objects that are editable
    
    Returns:
    list of editable row objects
  - getExpanded
```
public java.util.List getExpanded()
```
    Get the row objects that are expanded
    
    Returns:
    list of expanded row objects
  - getExpandable
```
public java.util.List getExpandable()
```
    Get the row objects that are expandible
    
    Returns:
    list of expandible row objects
  - getVisible
```
public java.util.List getVisible()
```
    Get the row objects that are not invisible
    
    Returns:
    list of visible row objects
  - getEditing
```
public java.util.List getEditing(javax.faces.component.UIComponent editor)
```
    Get the row objects that have activated a particular CellEditor.
    
    Parameters:
    editor - active CellEditor target
    
    Returns:
    list of row objects with active editors
  - getRowExpanders
```
public java.util.List getRowExpanders()
```
    Get the row objects that expand into other rows
    
    Returns:
    list of row expanding row objects
  - getPanelExpanders
```
public java.util.List getPanelExpanders()
```
    Get the row objects that expand into panels
    
    Returns:
    list of panel expanding row objects
  - setAllSelected
```
public void setAllSelected(boolean value)
```
    Set the selection state of all the row objects
    
    Parameters:
    value - selected
  - setAllSelectable
```
public void setAllSelectable(boolean value)
```
    Set the selectable state of all the row objects
    
    Parameters:
    value - selectable
  - setAllEditable
```
public void setAllEditable(boolean value)
```
    Set the editable state of all the row objects
    
    Parameters:
    value - editable
  - setAllExpanded
```
public void setAllExpanded(boolean value)
```
    Set the expanded state of all the row objects
    
    Parameters:
    value - expanded
  - setAllExpandable
```
public void setAllExpandable(boolean value)
```
    Set the expandable state of all the row objects
    
    Parameters:
    value - expandable
  - setAllVisible
```
public void setAllVisible(boolean value)
```
    Set the visible state of all the row objects
    
    Parameters:
    value - visible
  - setAllRowExpansion
```
public void setAllRowExpansion()
```
    Set the expansion mode of all the row objects to row
  - setAllPanelExpansion
```
public void setAllPanelExpansion()
```
    Set the expansion mode of all the row objects to panel
  - setAllEditing
```
public void setAllEditing(javax.faces.component.UIComponent editor,
                 boolean add)
```
    Set the editing state for the given CellEditor
    
    Parameters:
    editor - the CellEditor
    add - activate or remove

Class RowStateMap

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

RowStateMap

Method Detail

put

add

size

isEmpty

containsKey

containsValue

get

remove

putAll

clear

keySet

values

entrySet

updateData

updateData

removeStates

filterStates

filterStates

setExpandableByTreeModel

getSelected

getRowsWithSelectedCells

getSelectable

getEditable

getExpanded

getExpandable

getVisible

getEditing

getRowExpanders

getPanelExpanders

setAllSelected

setAllSelectable

setAllEditable

setAllExpanded

setAllExpandable

setAllVisible

setAllRowExpansion

setAllPanelExpansion

setAllEditing