to.etc.domui.component.tbl

Class ColumnDefList<T>

java.lang.Object

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

All Implemented Interfaces:

Iterable<SimpleColumnDef<?>>

public final class ColumnDefList<T>
extends Object
implements Iterable<SimpleColumnDef<?>>

A list of SimpleColumnDef columns used to define characteristics of columns in any tabular presentation. This class maintains the list, and has utility methods to manipulate that list.

Author:

Frits Jalvingh Created on May 11, 2012

Field Summary

Fields

Modifier and Type	Field and Description
static String	NUMERIC_CSS_CLASS

Constructor Summary

Constructors

Constructor and Description
ColumnDefList(Class<T> rootClass, ClassMetaModel cmm)

Method Summary

Modifier and Type	Method and Description
void	add(SimpleColumnDef<?> cd)
<R> void	addColumns(Object... cols) Deprecated.
void	addDefaultColumns() Add all of the columns as defined by the metadata to the list.
void	assignPercentages() Width calculations: this tries to assign widths to columns that have no explicit width assigned.
SimpleColumnDef<T>	column() Add a column which gets referred the row element instead of a column element.
<V> SimpleColumnDef<V>	column(Class<V> type, String property) Add and return the column definition for a column on the specified property.
SimpleColumnDef<?>	column(String property) This adds a column on the specified property, but has no idea about the real type.
<V> ExpandedColumnDef<V>	expand(Class<V> clz, String property)
ExpandedColumnDef<?>	expand(String property) This adds an expanded column on the specified property, but has no idea about the real type.
SimpleColumnDef<?>	findColumn(String propertyName)
SimpleColumnDef<?>	get(int ix)
SimpleColumnDef<?>	getSortColumn()
int	indexOf(SimpleColumnDef<?> scd)
Iterator<SimpleColumnDef<?>>	iterator() Return the iterator for all elements.
void	setDefaultSortColumn(String sort) Set the default sort column by property name.
void	setSortColumn(SimpleColumnDef<?> cd)
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

NUMERIC_CSS_CLASS

public static final String NUMERIC_CSS_CLASS

See Also:

Constant Field Values

Constructor Detail

ColumnDefList

public ColumnDefList(@Nonnull
                     Class<T> rootClass,
                     @Nonnull
                     ClassMetaModel cmm)

Method Detail

size

public int size()

add

public void add(@Nonnull
                SimpleColumnDef<?> cd)

get

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

findColumn

@Nullable
public SimpleColumnDef<?> findColumn(@Nonnull
                                               String propertyName)

setDefaultSortColumn

public void setDefaultSortColumn(@Nullable
                                 String sort)

Set the default sort column by property name. If it is null the default sort is undone.

Parameters:

sort -

setSortColumn

public void setSortColumn(@Nullable
                          SimpleColumnDef<?> cd)

addColumns

@Deprecated
public <R> void addColumns(@Nonnull
                                       Object... cols)

Deprecated.

STOP USING; Use RowRenderer instead or use the different "column(xx)" methods in this class. 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:

cols - , R extends INodeContentRenderer>

addDefaultColumns

public void addDefaultColumns()

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

assignPercentages

public void assignPercentages()

Width calculations: this tries to assign widths to columns that have no explicit width assigned. It starts by calculating all assigned widths in percents and in pixels. It then calculates widths for the columns that have no widths assigned.

iterator

@Nonnull
public Iterator<SimpleColumnDef<?>> iterator()

Return the iterator for all elements.

Specified by:

iterator in interface Iterable<SimpleColumnDef<?>>

See Also:

Iterable.iterator()

indexOf

public int indexOf(@Nonnull
                   SimpleColumnDef<?> scd)

getSortColumn

@Nullable
public SimpleColumnDef<?> getSortColumn()

column

@Nonnull
public <V> SimpleColumnDef<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 SimpleColumnDef<?> 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 SimpleColumnDef<T> column()

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

Returns:

expand

@Nonnull
public <V> ExpandedColumnDef<V> expand(@Nonnull
                                                Class<V> clz,
                                                @Nonnull
                                                String property)

Parameters:

clz -

property -

Returns:

expand

@Nonnull
public ExpandedColumnDef<?> expand(@Nonnull
                                            String property)

This adds an expanded 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: