to.etc.domui.component.tbl

Class BasicRowRenderer<T>

java.lang.Object

to.etc.domui.component.tbl.AbstractRowRenderer<T>

to.etc.domui.component.tbl.BasicRowRenderer<T>

All Implemented Interfaces:

IClickableRowRenderer<T>, IRowRenderer<T>

public class BasicRowRenderer<T>
extends AbstractRowRenderer<T>
implements IClickableRowRenderer<T>

Highly customizable RowRenderer. This has many ways to customize the row output, often using metadata. The definition for this renderer can be set until it's first use; it's actual definition gets calculated at the time it's first used. The possible specifications used in property modifiers are:

• "%28": a String starting with % denotes a width in percents. %28 gets translated to setWidth("28%");
• "^Title": a String starting with ^ denotes the header caption to use. Use ^~key to internationalize.
• "$cssclass": a String denoting a CSS class.
• Class<? extends IConverter>: the converter to use to convert the value to a string
• IConverter: an instance of a converter
• Class<? extends INodeContentRenderer<T>>: the class to use to render the content of the column.
• INodeContentRenderer<T>: an instance of a node renderer to use to render the content of the column.
• BasicRowRenderer.NOWRAP: forces a 'nowrap' on the column

Author:

Frits Jalvingh Created on Jun 18, 2008

Nested Class Summary

Nested classes/interfaces inherited from class to.etc.domui.component.tbl.AbstractRowRenderer

AbstractRowRenderer.IRowRendered<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULTSORT
static String	NOWRAP
static String	NUMERIC
static String	WRAP

Constructor Summary

Constructors

Constructor and Description
BasicRowRenderer(Class<T> dataClass, ClassMetaModel cmm, Object... cols)
BasicRowRenderer(Class<T> dataClass, Object... cols) Create a renderer by handling the specified class and a list of properties off it.

Method Summary

Modifier and Type	Method and Description
<R> BasicRowRenderer<T>	addColumns(Object... cols) Add the specified list of property names and presentation options to the column definitions.
void	addDefaultColumns() Add all of the columns as defined by the metadata to the list.
protected void	complete(TableModelTableBase<T> tbl) Complete this object if it is not already complete.

Methods inherited from class to.etc.domui.component.tbl.AbstractRowRenderer

beforeQuery, check, getActualClass, getCellClicked, getColumn, getColumnByName, getColumnCount, getColumnList, getNodeRenderer, getOnRowRendered, getRowButtonFactory, getRowClicked, getSortColumn, getUnknownColumnCaption, isComplete, isSortDescending, model, renderColumn, renderHeader, renderRow, setCellClicked, setColumnWidth, setColumnWidths, setDefaultSort, setNodeRenderer, setOnRowRendered, setRowButtonFactory, setRowClicked, setSort, setSortColumn, setUnknownColumnCaption

Methods inherited from class java.lang.Object

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

Methods inherited from interface to.etc.domui.component.tbl.IClickableRowRenderer

setCellClicked, setRowClicked

Methods inherited from interface to.etc.domui.component.tbl.IRowRenderer

beforeQuery, getRowClicked, renderHeader, renderRow

Field Detail

NOWRAP

public static final String NOWRAP

See Also:

Constant Field Values

WRAP

public static final String WRAP

See Also:

Constant Field Values

DEFAULTSORT

public static final String DEFAULTSORT

See Also:

Constant Field Values

NUMERIC

public static final String NUMERIC

See Also:

Constant Field Values

Constructor Detail

BasicRowRenderer

public BasicRowRenderer(@Nonnull
                        Class<T> dataClass,
                        Object... cols)
                 throws Exception

Create a renderer by handling the specified class and a list of properties off it.

Parameters:

dataClass -

cols -

Throws:

Exception

BasicRowRenderer

public BasicRowRenderer(@Nonnull
                        Class<T> dataClass,
                        @Nonnull
                        ClassMetaModel cmm,
                        Object... cols)

Method Detail

addColumns

public <R> BasicRowRenderer<T> addColumns(@Nonnull
                                          Object... cols)

Add the specified list of property names and presentation options to the column definitions. The items passed in the columns object can be multiple property definitions followed by specifications. A property name is a string starting with a letter always. All other Strings and objects are treated as specifications for display. The possible specifications are:

• "%28": a String starting with % denotes a width in percents. %28 gets translated to setWidth("28%");
• "^Title": a String starting with ^ denotes the header caption to use. Use ^~key~ to internationalize.
• "$cssclass": a String denoting a CSS class.
• Class<? extends IConverter>: the converter to use to convert the value to a string
• IConverter: an instance of a converter
• Class<? extends INodeContentRenderer<T>>: the class to use to render the content of the column.
• INodeContentRenderer<T>: an instance of a node renderer to use to render the content of the column.
• BasicRowRenderer.NOWRAP: forces a 'nowrap' on the column

Parameters:

clz -

cols - , R extends INodeContentRenderer>

addDefaultColumns

public void addDefaultColumns()

Add all of the columns as defined by the metadata to the list.

complete

protected void complete(@Nonnull
                        TableModelTableBase<T> tbl)

Complete this object if it is not already complete.

Overrides:

complete in class AbstractRowRenderer<T>