to.etc.domui.component.experimental

Class MultiRowRenderer<T>

java.lang.Object

to.etc.domui.component.experimental.MultiRowRenderer<T>

All Implemented Interfaces:

IClickableRowRenderer<T>, IRowRenderer<T>

public final class MultiRowRenderer<T>
extends Object
implements IClickableRowRenderer<T>

This is the type-safe replacement for the other row renderers which are now deprecated.

Author:

Frits Jalvingh Created on Feb 11, 2013

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addDefaultColumns() Add all of the columns as defined by the metadata to the list.
void	addHeaderAfter(TableHeader header)
void	addHeaderBefore(TableHeader header)
void	beforeQuery(TableModelTableBase<T> tbl) This gets called by the data table component just before it starts to render a new page.
ColumnDef<T,T>	column() Add a column which gets referred the row element instead of a column element.
<V> ColumnDef<T,V>	column(Class<V> type, String property) Add and return the column definition for a column on the specified property.
ColumnDef<T,?>	column(String property) This adds a column on the specified property, but has no idea about the real type.
protected Class<?>	getActualClass() Returns the record type being rendered.
ICellClicked<?>	getCellClicked(int col) Get the cell clicked handler for the specified column.
ColumnDef<T,?>	getColumn(int ix) Return the definition for the nth column.
ColumnDef<T,?>	getColumnByName(String propertyName) Find a column by the property it is displaying.
int	getColumnCount() Return the #of columns in this renderer.
INodeContentRenderer<?>	getNodeRenderer(int index) Convenience method to get the column's cell renderer; replacement for getColumn(index).getRenderer().
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 ColumnDef<T,?>	getSortColumn()
MultiRowRenderer<T>	helper(IRowRenderHelper<T> helper)
protected boolean	isComplete() Check if this object is used (completed) and thereby unmodifyable (internal).
protected boolean	isSortDescending()
protected ClassMetaModel	model() Returns the metamodel used.
protected <X> void	renderColumn(TableModelTableBase<T> tbl, ColumnContainer<T> cc, int index, T instance, ColumnDef<T,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(ColumnDef<T,?> cd, SortableType type) Sets default sort column on row renderer.
<C> void	setNodeRenderer(int index, INodeContentRenderer<C> renderer) Convenience method to set the column's cell renderer; replacement for getColumn(index).setRenderer().
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.
protected void	setSortColumn(ColumnDef<T,?> cd, SortableType type)
protected void	setSortDescending(boolean desc)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiRowRenderer

public MultiRowRenderer(@Nonnull
                        Class<T> data)

MultiRowRenderer

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

Method Detail

helper

public MultiRowRenderer<T> helper(IRowRenderHelper<T> helper)

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
                                ColumnDef<T,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)

addDefaultColumns

public void addDefaultColumns()

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

setDefaultSort

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

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

Parameters:

cd -

type -

model

@Nonnull
protected ClassMetaModel model()

Returns the metamodel used.

Returns:

getActualClass

@Nonnull
protected Class<?> getActualClass()

Returns the record type being rendered.

Returns:

isComplete

protected boolean isComplete()

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

Returns:

setSortColumn

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

getSortColumn

@Nullable
protected ColumnDef<T,?> getSortColumn()

isSortDescending

protected boolean isSortDescending()

setSortDescending

protected void setSortDescending(boolean desc)

getColumn

@Nonnull
public ColumnDef<T,?> 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 ColumnDef<T,?> 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 <C> void setNodeRenderer(int index,
                                @Nullable
                                INodeContentRenderer<C> 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 -

column

@Nonnull
public <V> ColumnDef<T,V> column(@Nonnull
                                          Class<V> type,
                                          @Nonnull
                                          String property)

Add and return the column definition for a column on the specified property. Because Java still has no first-class properties (sigh) you need to pass in the property's type to get a typeful column. If you do not need a typeful column use column(String).

Parameters:

type -

property -

Returns:

column

@Nonnull
public ColumnDef<T,?> column(@Nonnull
                                      String property)

This adds a column on the specified property, but has no idea about the real type. It can be used as long as that type is not needed.

Parameters:

property -

Returns:

column

@Nonnull
public ColumnDef<T,T> column()

Add a column which gets referred the row element instead of a column element. This is normally used together with

Returns:

addHeaderBefore

public void addHeaderBefore(@Nonnull
                            TableHeader header)

addHeaderAfter

public void addHeaderAfter(@Nonnull
                           TableHeader header)