org.icefaces.ace.model.table

Class RowState

java.lang.Object

org.icefaces.ace.model.table.RowState

All Implemented Interfaces:

java.io.Serializable

public class RowState
extends java.lang.Object
implements java.io.Serializable

Defines the view state of an individual row object within an ace:dataTable. Associated with row objects by entries in a RowStateMap where the keys are row objects and the values are instances of this class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RowState.ExpansionType

Constructor Summary

Constructors

Constructor and Description
RowState()

Method Summary

Methods

Modifier and Type	Method and Description
void	addActiveCellEditor(javax.faces.component.UIComponent editor) Convenience method to take the id of the CellEditor component and add it to the list of active editors in the row state for a given row object.
void	addSelectedColumn(javax.faces.component.UIComponent column) Convenience method to take the id of the Column component and add it to the list of selected columns in the RowState for the given row object.
java.util.List<java.lang.String>	getActiveCellEditorIds() Get the backing List of Strings containing the Ids of the CellEditor components active in this row.
RowState.ExpansionType	getExpansionType() Get the expansion mode defined for this row.
java.util.List<java.lang.String>	getSelectedColumnIds() Get the backing List of Strings containing the Ids of the Column components selected in this row.
java.lang.String	getType() Get the String defining the set of columns rendered by this row.
boolean	isEditable() Get the editibility of the row.
boolean	isExpandable() Get the expandibility of the row.
boolean	isExpanded() Get the expanded state of the row.
boolean	isSelectable() Get the selectable state of the row.
boolean	isSelected() Get the selected state of the row.
boolean	isVisible() Get if the row is visible.
void	removeActiveCellEditor(javax.faces.component.UIComponent editor) Convenience method to take the id of the CellEditor component and remove it from the list of active editors in the row state for a given row object.
void	removeSelectedColumn(javax.faces.component.UIComponent column) Convenience method to take the id of the Column component and remove it from the list of selected columns in the RowState for the given row object.
void	setActiveCellEditorIds(java.util.List<java.lang.String> activeCellEditorIds) Set a List of Strings containing the Ids of the CellEditor components active in this row.
void	setEditable(boolean editable) Set the editibility of the row.
void	setExpandable(boolean expandable) Set the expandibility of the row.
void	setExpanded(boolean expanded) Set the expanded state of the row.
void	setExpansionType(RowState.ExpansionType expansionType) Set the expansion mode (row, panel or none) for this row.
void	setSelectable(boolean selectable) Set the selectable state of the row.
void	setSelected(boolean selected) Set the selected state of the row.
void	setSelectedColumnIds(java.util.List<java.lang.String> selectedColumnIds) Set a List of Strings containing the Ids of the Column components selected in this row.
void	setType(java.lang.String type) Set the String defining the set of columns rendered by this row.
void	setVisible(boolean visible) Set if the row is visible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RowState

public RowState()

Method Detail

getExpansionType

public RowState.ExpansionType getExpansionType()

Get the expansion mode defined for this row.

Returns:

ExpansionType enum

setExpansionType

public void setExpansionType(RowState.ExpansionType expansionType)

Set the expansion mode (row, panel or none) for this row.

Parameters:

expansionType - expansion mode enum

getType

public java.lang.String getType()

Get the String defining the set of columns rendered by this row. Column sets are defined by ColumnGroup components, whose type attributes are matched to this field to determine which column set is rendered. The String "default" matches all Columns outside of ColumnGroups. Not currently implemented, all values behave like "default".

Returns:

column set name

setType

public void setType(java.lang.String type)

Set the String defining the set of columns rendered by this row. Column sets are defined by ColumnGroup components, whose type attributes are matched to this field to determine which column set is rendered. The String "default" matches all Columns outside of ColumnGroups. Not currently implemented, all values behave like "default".

Parameters:

type - column set name

isSelected

public boolean isSelected()

Get the selected state of the row.

Returns:

if the row is selected

setSelected

public void setSelected(boolean selected)

Set the selected state of the row.

Parameters:

selected - is the row selected

isSelectable

public boolean isSelectable()

Get the selectable state of the row.

Returns:

if the row or child columns can be selected

setSelectable

public void setSelectable(boolean selectable)

Set the selectable state of the row.

Parameters:

selectable - if the row or child columns can be selected

isExpanded

public boolean isExpanded()

Get the expanded state of the row.

Returns:

is the row expanded

setExpanded

public void setExpanded(boolean expanded)

Set the expanded state of the row.

Parameters:

expanded - is the row expanded

isExpandable

public boolean isExpandable()

Get the expandibility of the row.

Returns:

is the row expandible

setExpandable

public void setExpandable(boolean expandable)

Set the expandibility of the row.

Parameters:

expandable - is the row expandible

isEditable

public boolean isEditable()

Get the editibility of the row.

Returns:

is the row editable

setEditable

public void setEditable(boolean editable)

Set the editibility of the row.

Parameters:

editable - is the row editable

isVisible

public boolean isVisible()

Get if the row is visible.

Returns:

is the row visible

setVisible

public void setVisible(boolean visible)

Set if the row is visible.

Parameters:

visible - is the row visible

getActiveCellEditorIds

public java.util.List<java.lang.String> getActiveCellEditorIds()

Get the backing List of Strings containing the Ids of the CellEditor components active in this row. The reference returned is not to a List copy but to the actual list defining the selection state.

Returns:

the List of UIComponent Ids defining the active CellEditor components

getSelectedColumnIds

public java.util.List<java.lang.String> getSelectedColumnIds()

Get the backing List of Strings containing the Ids of the Column components selected in this row. The reference returned is not to a List copy but to the actual list defining the selection state.

Returns:

the List of UIComponent Ids defining the selected Column components

setSelectedColumnIds

public void setSelectedColumnIds(java.util.List<java.lang.String> selectedColumnIds)

Set a List of Strings containing the Ids of the Column components selected in this row.

Parameters:

selectedColumnIds -

addSelectedColumn

public void addSelectedColumn(javax.faces.component.UIComponent column)

Convenience method to take the id of the Column component and add it to the list of selected columns in the RowState for the given row object.

Parameters:

column -

removeSelectedColumn

public void removeSelectedColumn(javax.faces.component.UIComponent column)

Convenience method to take the id of the Column component and remove it from the list of selected columns in the RowState for the given row object.

Parameters:

column -

setActiveCellEditorIds

public void setActiveCellEditorIds(java.util.List<java.lang.String> activeCellEditorIds)

Set a List of Strings containing the Ids of the CellEditor components active in this row.

Parameters:

activeCellEditorIds -

addActiveCellEditor

public void addActiveCellEditor(javax.faces.component.UIComponent editor)

Convenience method to take the id of the CellEditor component and add it to the list of active editors in the row state for a given row object.

Parameters:

editor -

removeActiveCellEditor

public void removeActiveCellEditor(javax.faces.component.UIComponent editor)

Convenience method to take the id of the CellEditor component and remove it from the list of active editors in the row state for a given row object.

Parameters:

editor -