to.etc.domui.component.tbl

Class SimpleColumnDef<T>

java.lang.Object

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

public final class SimpleColumnDef<T>
extends Object

Contains data for rendering a column in a data table.

Author:

Frits Jalvingh Created on Jun 18, 2008

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SimpleColumnDef(ColumnDefList<?> cdl, Class<T> valueClass)
SimpleColumnDef(ColumnDefList<?> cdl, ExpandedDisplayProperty<T> m)
SimpleColumnDef(ColumnDefList<?> cdl, PropertyMetaModel<T> pmm) Create a column definition using metadata for the column.

Method Summary

Modifier and Type	Method and Description
SimpleColumnDef<T>	align(TextAlign align) Set the text align for this column.
SimpleColumnDef<T>	ascending() Set the default sort order to ascending first.
SimpleColumnDef<T>	cellClicked(ICellClicked<T> ck) Set the cell click handler.
SimpleColumnDef<T>	converter(IObjectToStringConverter<T> c) Set a column value-to-string converter to be used.
SimpleColumnDef<T>	css(String css) Set the css class of this column's values.
SimpleColumnDef<T>	cssHeader(String css) Set the css class of this column's header.
SimpleColumnDef<T>	descending() Set the default sort order to descending first.
TextAlign	getAlign()
ICellClicked<T>	getCellClicked()
String	getColumnLabel()
Class<T>	getColumnType()
INodeContentRenderer<T>	getContentRenderer()
String	getCssClass() When set this defines the css class to set on each value cell for this column.
int	getDisplayLength() Deprecated.
String	getHeaderCssClass() When set this defines the css class to set on the header of this column.
NumericPresentation	getNumericPresentation()
IObjectToStringConverter<T>	getPresentationConverter() Returns the optional converter to use to convert raw object values to some presentation string value.
String	getPropertyName()
String	getRenderHint()
SortableType	getSortable()
ISortHelper<?>	getSortHelper() If this column is sortable with help from outside code: this defines that helper which will sort the main model for the table for this column.
IValueTransformer<T>	getValueTransformer()
String	getWidth()
SimpleColumnDef<T>	hint(String hint) Set the hint for a column.
Boolean	isNowrap()
SimpleColumnDef<T>	label(String columnLabel) Set the column header's label.
SimpleColumnDef<T>	nowrap() Set the column to nowrap.
SimpleColumnDef<T>	numeric(NumericPresentation np) Set the numeric presentation for this column.
SimpleColumnDef<T>	renderer(INodeContentRenderer<T> cr) Set the node content renderer.
void	setAlign(TextAlign align)
void	setCellClicked(ICellClicked<T> cellClicked)
void	setColumnLabel(String columnLabel)
void	setContentRenderer(INodeContentRenderer<T> contentRenderer)
void	setCssClass(String cssClass) When set this defines the css class to set on each value cell for this column.
void	setDisplayLength(int displayLength) Deprecated.
void	setHeaderCssClass(String headerCssClass) When set this defines the css class to set on the header of this column.
void	setNowrap(Boolean nowrap)
void	setNumericPresentation(NumericPresentation numericPresentation)
void	setPresentationConverter(IConverter<T> valueConverter)
void	setPropertyName(String propertyName)
void	setRenderHint(String renderHint)
void	setSortable(SortableType sortable)
void	setSortHelper(ISortHelper<?> sortHelper)
void	setValueTransformer(IValueTransformer<T> valueTransformer)
void	setWidth(String width)
SimpleColumnDef<T>	sort(ISortHelper<T> sh) Set a sort helper to be used for this column.
SimpleColumnDef<T>	sortdefault() Set this column as the default column to sort on.
String	toString()
SimpleColumnDef<T>	transform(IValueTransformer<T> vt) Set a value transformer to convert this column value into something else.
SimpleColumnDef<T>	width(String w)
SimpleColumnDef<T>	wrap() Make sure this column's contents are wrapped (by default columns added by RowRenderer are marked as not wrappable.

Methods inherited from class java.lang.Object

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

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

Constructor Detail

SimpleColumnDef

public SimpleColumnDef(@Nonnull
                       ColumnDefList<?> cdl,
                       @Nonnull
                       Class<T> valueClass)

SimpleColumnDef

public SimpleColumnDef(@Nonnull
                       ColumnDefList<?> cdl,
                       @Nonnull
                       PropertyMetaModel<T> pmm)

Create a column definition using metadata for the column.

Parameters:

pmm -

SimpleColumnDef

public SimpleColumnDef(@Nonnull
                       ColumnDefList<?> cdl,
                       @Nonnull
                       ExpandedDisplayProperty<T> m)

Method Detail

getColumnLabel

@Nullable
public String getColumnLabel()

setColumnLabel

public void setColumnLabel(@Nullable
                           String columnLabel)

getColumnType

@Nonnull
public Class<T> getColumnType()

getSortable

@Nonnull
public SortableType getSortable()

setSortable

public void setSortable(@Nonnull
                        SortableType sortable)

getWidth

@Nullable
public String getWidth()

setWidth

public void setWidth(@Nullable
                     String width)

getValueTransformer

@Nullable
public IValueTransformer<T> getValueTransformer()

setValueTransformer

public void setValueTransformer(@Nullable
                                IValueTransformer<T> valueTransformer)

getPresentationConverter

@Nullable
public IObjectToStringConverter<T> getPresentationConverter()

Returns the optional converter to use to convert raw object values to some presentation string value.

Returns:

setPresentationConverter

public void setPresentationConverter(@Nullable
                                     IConverter<T> valueConverter)

getPropertyName

@Nullable
public String getPropertyName()

setPropertyName

public void setPropertyName(@Nullable
                            String propertyName)

getContentRenderer

@Nullable
public INodeContentRenderer<T> getContentRenderer()

setContentRenderer

public void setContentRenderer(@Nullable
                               INodeContentRenderer<T> contentRenderer)

getCssClass

@Nullable
public String getCssClass()

When set this defines the css class to set on each value cell for this column. Setting this does NOT set a css class for the header!!

Returns:

setCssClass

public void setCssClass(@Nullable
                        String cssClass)

When set this defines the css class to set on each value cell for this column. Setting this does NOT set a css class for the header!!

Parameters:

cssClass -

getHeaderCssClass

@Nullable
public String getHeaderCssClass()

When set this defines the css class to set on the header of this column.

Returns:

setHeaderCssClass

public void setHeaderCssClass(@Nullable
                              String headerCssClass)

When set this defines the css class to set on the header of this column.

Parameters:

headerCssClass -

getDisplayLength

@Deprecated
public int getDisplayLength()

Deprecated.

Seems nonsense, use width instead.

Returns:

setDisplayLength

@Deprecated
public void setDisplayLength(int displayLength)

Deprecated.

Seems nonsense, use width instead.

Parameters:

displayLength -

isNowrap

@Nullable
public Boolean isNowrap()

setNowrap

public void setNowrap(@Nullable
                      Boolean nowrap)

getCellClicked

@Nullable
public ICellClicked<T> getCellClicked()

setCellClicked

public void setCellClicked(@Nullable
                           ICellClicked<T> cellClicked)

getNumericPresentation

@Nonnull
public NumericPresentation getNumericPresentation()

setNumericPresentation

public void setNumericPresentation(@Nonnull
                                   NumericPresentation numericPresentation)

getAlign

@Nullable
public TextAlign getAlign()

setAlign

public void setAlign(@Nullable
                     TextAlign align)

getRenderHint

@Nullable
public String getRenderHint()

setRenderHint

public void setRenderHint(@Nullable
                          String renderHint)

getSortHelper

@Nullable
public ISortHelper<?> getSortHelper()

If this column is sortable with help from outside code: this defines that helper which will sort the main model for the table for this column. Watch out: the type passed to the sort helper is the ROW TYPE, not this-column's type!

Returns:

setSortHelper

public void setSortHelper(@Nullable
                          ISortHelper<?> sortHelper)

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

label

@Nonnull
public SimpleColumnDef<T> label(@Nullable
                                         String columnLabel)

Set the column header's label.

Parameters:

columnLabel -

Returns:

align

@Nonnull
public SimpleColumnDef<T> align(@Nonnull
                                         TextAlign align)

Set the text align for this column. Defaults depend on the numeric type of the column, if known.

Parameters:

align -

Returns:

cellClicked

@Nonnull
public SimpleColumnDef<T> cellClicked(@Nonnull
                                               ICellClicked<T> ck)

Set the cell click handler.

Parameters:

ck -

Returns:

renderer

@Nonnull
public SimpleColumnDef<T> renderer(@Nonnull
                                            INodeContentRenderer<T> cr)

Set the node content renderer.

Parameters:

cr -

Returns:

css

@Nonnull
public SimpleColumnDef<T> css(@Nonnull
                                       String css)

Set the css class of this column's values.

Parameters:

css -

Returns:

cssHeader

@Nonnull
public SimpleColumnDef<T> cssHeader(@Nonnull
                                             String css)

Set the css class of this column's header.

Parameters:

css -

Returns:

wrap

@Nonnull
public SimpleColumnDef<T> wrap()

Make sure this column's contents are wrapped (by default columns added by RowRenderer are marked as not wrappable.

Returns:

nowrap

@Nonnull
public SimpleColumnDef<T> nowrap()

Set the column to nowrap.

Returns:

numeric

@Nonnull
public SimpleColumnDef<T> numeric(@Nonnull
                                           NumericPresentation np)

Set the numeric presentation for this column.

Parameters:

np -

Returns:

converter

@Nonnull
public SimpleColumnDef<T> converter(@Nonnull
                                             IObjectToStringConverter<T> c)

Set a column value-to-string converter to be used.

Parameters:

c -

Returns:

hint

@Nonnull
public SimpleColumnDef<T> hint(@Nonnull
                                        String hint)

Set the hint for a column.

Parameters:

hint -

Returns:

ascending

@Nonnull
public SimpleColumnDef<T> ascending()

Set the default sort order to ascending first.

Returns:

descending

@Nonnull
public SimpleColumnDef<T> descending()

Set the default sort order to descending first.

Returns:

sortdefault

@Nonnull
public SimpleColumnDef<T> sortdefault()

Set this column as the default column to sort on.

Returns:

sort

@Nonnull
public SimpleColumnDef<T> sort(@Nonnull
                                        ISortHelper<T> sh)

Set a sort helper to be used for this column.

Parameters:

sh -

Returns:

transform

@Nonnull
public SimpleColumnDef<T> transform(@Nonnull
                                             IValueTransformer<T> vt)

Set a value transformer to convert this column value into something else.

Parameters:

vt -

Returns:

width

@Nonnull
public SimpleColumnDef<T> width(@Nullable
                                         String w)