org.apache.wicket.extensions.markup.html.tree.table
Class PropertyTreeColumn

java.lang.Object
  extended by org.apache.wicket.extensions.markup.html.tree.table.AbstractColumn
      extended by org.apache.wicket.extensions.markup.html.tree.table.AbstractTreeColumn
          extended by org.apache.wicket.extensions.markup.html.tree.table.PropertyTreeColumn
All Implemented Interfaces:
Serializable, IColumn, IClusterable

public class PropertyTreeColumn
extends AbstractTreeColumn

TreeColumn class that uses a property expression to get the value from the node.

Author:
Matej Knopp
See Also:
Serialized Form

Constructor Summary
PropertyTreeColumn(ColumnLocation location, String header, String propertyExpression)
          Creates the columns.
 
Method Summary
 IConverter getConverter()
          Returns the converter or null if no converter is specified.
 Locale getLocale()
          Returns the locale or null if no locale is specified.
 String renderNode(TreeNode node)
          Returns the string representation of the node.
 void setConverter(IConverter converter)
          By default the property is converted to string using toString method.
 void setLocale(Locale locale)
          Sets the locale to be used as parameter for custom converter (if one is specified).
 
Methods inherited from class org.apache.wicket.extensions.markup.html.tree.table.AbstractTreeColumn
newCell, newCell
 
Methods inherited from class org.apache.wicket.extensions.markup.html.tree.table.AbstractColumn
getLocation, getSpan, getTreeTable, isVisible, newHeader, setTreeTable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyTreeColumn

public PropertyTreeColumn(ColumnLocation location,
                          String header,
                          String propertyExpression)
Creates the columns.

Parameters:
location - Specifies how the column should be aligned and what his size should be
header - Header caption
propertyExpression - Expression for property access
Method Detail

getConverter

public IConverter getConverter()
Returns the converter or null if no converter is specified.

Returns:
Any converter

getLocale

public Locale getLocale()
Returns the locale or null if no locale is specified.

Returns:
Any locale

renderNode

public String renderNode(TreeNode node)
Description copied from class: AbstractTreeColumn
Returns the string representation of the node.

Specified by:
renderNode in class AbstractTreeColumn
Parameters:
node - The node
Returns:
The string representation of the node
See Also:
AbstractTreeColumn.renderNode(TreeNode)

setConverter

public void setConverter(IConverter converter)
By default the property is converted to string using toString method. If you want to alter this behavior, you can specify a custom converter.

Parameters:
converter - Any converter

setLocale

public void setLocale(Locale locale)
Sets the locale to be used as parameter for custom converter (if one is specified). If no locale is set, session locale is used.

Parameters:
locale - The locale


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.