com.inmethod.grid.column.tree
Class PropertyTreeColumn<T extends TreeModel & Serializable,I extends TreeNode & Serializable,P,S>

java.lang.Object
  com.inmethod.grid.column.AbstractColumn<T,I,S>
      com.inmethod.grid.treegrid.BaseTreeColumn<T,I,S>
          com.inmethod.grid.column.tree.AbstractTreeColumn<T,I,S>
              com.inmethod.grid.column.tree.PropertyTreeColumn<T,I,P,S>

Type Parameters:

T - tree model object type

I - node model object type

P - type of the property

All Implemented Interfaces:

IGridColumn<T,I,S>, Serializable, IDetachable, IClusterable

Direct Known Subclasses:

EditablePropertyTreeColumn

public class PropertyTreeColumn<T extends TreeModel & Serializable,I extends TreeNode & Serializable,P,S>
extends AbstractTreeColumn<T,I,S>

Simple tree column that displays a property of TreeNode instance specified by the property expression.

Author:

Matej Knopp

See Also:

AbstractTreeColumn, Serialized Form

PropertyTreeColumn

public PropertyTreeColumn(String columnId,
                          IModel<String> headerModel,
                          String propertyExpression,
                          S sortProperty)

Constructor.

Parameters:

columnId - column identified (must be unique within the grid)

headerModel - model for column header

propertyExpression - property expression used to get the displayed value for row object

sortProperty - optional string that will be returned by ISortState to indicate that the column is being sorted

PropertyTreeColumn

public PropertyTreeColumn(String columnId,
                          IModel<String> headerModel,
                          String propertyExpression)

Constructor.

Parameters:

columnId - column identified (must be unique within the grid)

headerModel - model for column header

propertyExpression - property expression used to get the displayed value for row object

PropertyTreeColumn

public PropertyTreeColumn(IModel<String> headerModel,
                          String propertyExpression,
                          S sortProperty)

Constructor. The column id is omitted in this constructor, because the property expression is used as column id.

Parameters:

headerModel - model for column header

propertyExpression - property expression used to get the displayed value for row object

sortProperty - optional string that will be returned by ISortState to indicate that the column is being sorted

PropertyTreeColumn

public PropertyTreeColumn(IModel<String> headerModel,
                          String propertyExpression)

Constructor. The column id is omitted in this constructor, because the property expression is used as column id.

Parameters:

headerModel - model for column header

propertyExpression - property expression used to get the displayed value for row object

newNodeComponent

protected Component newNodeComponent(String id,
                                     IModel<I> model)

Creates the node component.

Specified by:

newNodeComponent in class AbstractTreeColumn<T extends TreeModel & Serializable,I extends TreeNode & Serializable,S>

Parameters:

id - component id

model - model used to access the TreeNode

Returns:

newly created component instance

getPropertyExpression

protected String getPropertyExpression()

Returns the property expression.

Returns:

property expression.