to.etc.domui.component.tbl

Class AbstractRowRenderer<T>

java.lang.Object

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

All Implemented Interfaces:

IClickableRowRenderer<T>, IRowRenderer<T>

Direct Known Subclasses:

BasicRowRenderer, SimpleRowRenderer

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

Base class for the old and new row renderers, handling most presentation. The configuration is mostly handled by the subclasses.

Author:

Frits Jalvingh Created on Feb 15, 2009

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractRowRenderer.IRowRendered<T>

Constructor Summary

Constructors

Constructor and Description
AbstractRowRenderer(Class<T> data)
AbstractRowRenderer(Class<T> data, ClassMetaModel cmm)

Method Summary

Modifier and Type	Method and Description
void	beforeQuery(TableModelTableBase<T> tbl) This gets called by the data table component just before it starts to render a new page.
protected void	check() Throws an exception if this renderer has been completed and is unmutable.
protected void	complete(TableModelTableBase<T> tbl) Complete this object if it is not already complete (internal).
protected Class<?>	getActualClass() Returns the record type being rendered.
ICellClicked<?>	getCellClicked(int col) Get the cell clicked handler for the specified column.
SimpleColumnDef<?>	getColumn(int ix) Return the definition for the nth column.
SimpleColumnDef<?>	getColumnByName(String propertyName) Find a column by the property it is displaying.
int	getColumnCount() Return the #of columns in this renderer.
protected ColumnDefList<T>	getColumnList()
INodeContentRenderer<?>	getNodeRenderer(int index) Convenience method to get the column's cell renderer; replacement for getColumn(index).getRenderer().
AbstractRowRenderer.IRowRendered<T>	getOnRowRendered() Sets a handler that gets called every time a row is rendered.
IRowButtonFactory<T>	getRowButtonFactory()
ICellClicked<?>	getRowClicked() When set each row will be selectable (will react when the mouse hovers over it), and when clicked will call this handler.
protected SimpleColumnDef<?>	getSortColumn()
String	getUnknownColumnCaption()
protected boolean	isComplete() Check if this object is used (completed) and thereby unmodifyable (internal).
protected boolean	isSortDescending() The current sorting state of the sort column, as defined by the user's clicking the header.
protected ClassMetaModel	model() Returns the metamodel used.
protected <X> void	renderColumn(TableModelTableBase<T> tbl, ColumnContainer<T> cc, int index, T instance, SimpleColumnDef<X> cd) Render a single column fully.
void	renderHeader(TableModelTableBase<T> tbl, HeaderContainer<T> cc) Render the header for a table, using the simple column metadata provided.
void	renderRow(TableModelTableBase<T> tbl, ColumnContainer<T> cc, int index, T instance)
<V> void	setCellClicked(int col, ICellClicked<V> cellClicked) Set the cell clicked handler for the specified column.
void	setColumnWidth(int index, String width) Convenience method to set the column width; replacement for getColumn(index).setWidth().
void	setColumnWidths(String... widths) Quickly set the widths of all columns in the same order as defined.
void	setDefaultSort(SimpleColumnDef<?> cd, SortableType type) Sets default sort column on row renderer.
<T> void	setNodeRenderer(int index, INodeContentRenderer<T> renderer) Convenience method to set the column's cell renderer; replacement for getColumn(index).setRenderer().
void	setOnRowRendered(AbstractRowRenderer.IRowRendered<T> onRowRendered)
void	setRowButtonFactory(IRowButtonFactory<T> rowButtonFactory)
<V> void	setRowClicked(ICellClicked<V> rowClicked) When set each row will be selectable (will react when the mouse hovers over it), and when clicked will call this handler.
void	setSort(String column, SortableType type)
protected void	setSortColumn(SimpleColumnDef<?> cd, SortableType type)
void	setUnknownColumnCaption(String unknownColumnCaption)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRowRenderer

public AbstractRowRenderer(@Nonnull
                           Class<T> data)

AbstractRowRenderer

public AbstractRowRenderer(@Nonnull
                           Class<T> data,
                           @Nonnull
                           ClassMetaModel cmm)

Method Detail

getColumnList

@Nonnull
protected ColumnDefList<T> getColumnList()

setDefaultSort

public void setDefaultSort(@Nonnull
                           SimpleColumnDef<?> cd,
                           @Nonnull
                           SortableType type)

Sets default sort column on row renderer. Overrides property meta model setting if such defines default sort.

Parameters:

cd -

type -

setSort

public void setSort(@Nonnull
                    String column,
                    @Nonnull
                    SortableType type)

model

@Nonnull
protected ClassMetaModel model()

Returns the metamodel used.

Returns:

getActualClass

@Nonnull
protected Class<?> getActualClass()

Returns the record type being rendered.

Returns:

check

protected void check()

Throws an exception if this renderer has been completed and is unmutable.

complete

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

Complete this object if it is not already complete (internal).

isComplete

protected boolean isComplete()

Check if this object is used (completed) and thereby unmodifyable (internal).

Returns:

setSortColumn

protected void setSortColumn(@Nullable
                             SimpleColumnDef<?> cd,
                             @Nullable
                             SortableType type)

getSortColumn

@Nullable
protected SimpleColumnDef<?> getSortColumn()

isSortDescending

protected boolean isSortDescending()

The current sorting state of the sort column, as defined by the user's clicking the header.

Returns:

getColumn

@Nonnull
public SimpleColumnDef<?> getColumn(int ix)

Return the definition for the nth column. You can change the column's definition there.

Parameters:

ix -

Returns:

getColumnCount

public int getColumnCount()

Return the #of columns in this renderer.

Returns:

getColumnByName

@Nonnull
public SimpleColumnDef<?> getColumnByName(String propertyName)

Find a column by the property it is displaying. This only works for that kind of columns, and will not work for any joined columns defined from metadata. If no column exists for the specified property this will throw an exception.

Parameters:

propertyName -

Returns:

setColumnWidths

public void setColumnWidths(String... widths)

Quickly set the widths of all columns in the same order as defined.

Parameters:

widths -

setColumnWidth

public void setColumnWidth(int index,
                           String width)

Convenience method to set the column width; replacement for getColumn(index).setWidth().

Parameters:

index -

width -

setNodeRenderer

public <T> void setNodeRenderer(int index,
                                @Nullable
                                INodeContentRenderer<T> renderer)

Convenience method to set the column's cell renderer; replacement for getColumn(index).setRenderer().

Parameters:

index -

renderer -

getNodeRenderer

public INodeContentRenderer<?> getNodeRenderer(int index)

Convenience method to get the column's cell renderer; replacement for getColumn(index).getRenderer().

Parameters:

index -

Returns:

getRowClicked

@Nullable
public ICellClicked<?> getRowClicked()

When set each row will be selectable (will react when the mouse hovers over it), and when clicked will call this handler.

Specified by:

getRowClicked in interface IRowRenderer<T>

Returns:

setRowClicked

public <V> void setRowClicked(@Nullable
                              ICellClicked<V> rowClicked)

When set each row will be selectable (will react when the mouse hovers over it), and when clicked will call this handler.

Specified by:

setRowClicked in interface IClickableRowRenderer<T>

Parameters:

rowClicked -

getCellClicked

@Nullable
public ICellClicked<?> getCellClicked(int col)

Get the cell clicked handler for the specified column. Convenience method for getColumn(col).getCellClicked().

Parameters:

col -

Returns:

setCellClicked

public <V> void setCellClicked(int col,
                               @Nullable
                               ICellClicked<V> cellClicked)

Set the cell clicked handler for the specified column. Convenience method for getColumn(col).setCellClicked().

Specified by:

setCellClicked in interface IClickableRowRenderer<T>

Parameters:

col -

cellClicked -

renderHeader

public void renderHeader(@Nonnull
                         TableModelTableBase<T> tbl,
                         @Nonnull
                         HeaderContainer<T> cc)
                  throws Exception

Render the header for a table, using the simple column metadata provided. This renders a rich header, containing column labels, sort boxes and the like.

Specified by:

renderHeader in interface IRowRenderer<T>

Throws:

Exception

beforeQuery

public void beforeQuery(@Nonnull
                        TableModelTableBase<T> tbl)
                 throws Exception

This gets called by the data table component just before it starts to render a new page. When called the query has not yet been done and nothing is rendered for this object. This exposes the actual model that will be used during the rendering process and allows this component to define sorting, if needed.

Specified by:

beforeQuery in interface IRowRenderer<T>

Throws:

Exception

renderRow

public void renderRow(@Nonnull
                      TableModelTableBase<T> tbl,
                      @Nonnull
                      ColumnContainer<T> cc,
                      int index,
                      @Nonnull
                      T instance)
               throws Exception

Specified by:

renderRow in interface IRowRenderer<T>

Throws:

Exception

renderColumn

protected <X> void renderColumn(@Nonnull
                                TableModelTableBase<T> tbl,
                                @Nonnull
                                ColumnContainer<T> cc,
                                int index,
                                @Nonnull
                                T instance,
                                @Nonnull
                                SimpleColumnDef<X> cd)
                         throws Exception

Render a single column fully.

Parameters:

tbl -

cc -

index -

instance -

cd -

Throws:

Exception

getRowButtonFactory

@Nullable
public IRowButtonFactory<T> getRowButtonFactory()

Returns:

setRowButtonFactory

public void setRowButtonFactory(@Nullable
                                IRowButtonFactory<T> rowButtonFactory)

setUnknownColumnCaption

public void setUnknownColumnCaption(@Nullable
                                    String unknownColumnCaption)

getUnknownColumnCaption

@Nonnull
public String getUnknownColumnCaption()

getOnRowRendered

@Nullable
public AbstractRowRenderer.IRowRendered<T> getOnRowRendered()

Sets a handler that gets called every time a row is rendered.

Returns:

setOnRowRendered

public void setOnRowRendered(@Nullable
                             AbstractRowRenderer.IRowRendered<T> onRowRendered)