to.etc.domui.component.tbl

Class ColumnDef<I,T>

java.lang.Object

to.etc.domui.component.tbl.ColumnDef<I,T>

public final class ColumnDef<I,T>
extends Object

Method Summary

Modifier and Type	Method and Description
ColumnDef<I,T>	align(TextAlign align) Set the text align for this column.
ColumnDef<I,T>	ascending() Set the default sort order to ascending first.
ColumnDef<I,T>	cellClicked(ICellClicked<?> ck) Set the cell click handler.
ColumnDef<I,T>	converter(IConverter<T> converter)
ColumnDef<I,T>	css(String css) Set the css class of this column's values.
ColumnDef<I,T>	cssHeader(String css) Set the css class of this column's header.
ColumnDef<I,T>	descending() Set the default sort order to descending first.
ColumnDef<I,T>	editable() Create an editable component bound to the column's value.
ColumnDef<I,T>	factory(IRowControlFactory<I> factory) Define the control factory to create the control to use to show the column's value.
Class<T>	getActualClass()
TextAlign	getAlign()
ICellClicked<?>	getCellClicked()
String	getColumnLabel()
Class<T>	getColumnType()
<R> T	getColumnValue(R instance)
INodeContentRenderer<T>	getContentRenderer()
IRowControlFactory<I>	getControlFactory() Return the control factory to create the control to use to show the column's value.
IConverter<T>	getConverter()
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()
PropertyMetaModel<T>	getPropertyMetaModel()
String	getPropertyName()
String	getRenderHint()
SortableType	getSortable()
ISortHelper<?>	getSortHelper()
String	getSortProperty()
String	getWidth()
ColumnDef<I,T>	hint(String hint) Set the hint for a column.
boolean	isEditable()
boolean	isNowrap()
ColumnDef<I,T>	label(String columnLabel) Set the column header's label.
ColumnDef<I,T>	nowrap() Set the column to nowrap.
ColumnDef<I,T>	numeric(NumericPresentation np) Set the numeric presentation for this column.
ColumnDef<I,T>	property(String name) Use to set the property name for a column that wraps the whole record (a column defined by RowRenderer.column().
ColumnDef<I,T>	renderer(INodeContentRenderer<T> cr) Set the node content renderer.
void	setPropertyName(String propertyName)
void	setSortable(SortableType sortable)
ColumnDef<I,T>	sort(ISortHelper<?> sh) Set a sort helper to be used for this column.
ColumnDef<I,T>	sort(String propertyName) For a column that represents the whole entity, this can specify which property of the entity is to be used to sort on.
ColumnDef<I,T>	sortdefault() Set this column as the default column to sort on.
String	toString()
ColumnDef<I,T>	width(String w)
ColumnDef<I,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

Method Detail

getActualClass

@Nonnull
public Class<T> getActualClass()

getPropertyMetaModel

@Nullable
public PropertyMetaModel<T> getPropertyMetaModel()

getColumnLabel

@Nullable
public String getColumnLabel()

getConverter

@Nullable
public IConverter<T> getConverter()

editable

@Nonnull
public ColumnDef<I,T> editable()

Create an editable component bound to the column's value.

Returns:

Since:

2013/1/2

property

@Nonnull
public ColumnDef<I,T> property(@Nonnull
                                        String name)

Use to set the property name for a column that wraps the whole record (a column defined by RowRenderer.column(). It should be set when a row has sort defined.

Parameters:

name -

Returns:

isEditable

public boolean isEditable()

getColumnValue

public <R> T getColumnValue(@Nonnull
                            R instance)
                     throws Exception

Throws:

Exception

getColumnType

@Nonnull
public Class<T> getColumnType()

getSortable

@Nonnull
public SortableType getSortable()

getWidth

@Nullable
public String getWidth()

getPropertyName

@Nullable
public String getPropertyName()

setPropertyName

public void setPropertyName(@Nullable
                            String propertyName)

getContentRenderer

@Nullable
public INodeContentRenderer<T> getContentRenderer()

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:

getHeaderCssClass

@Nullable
public String getHeaderCssClass()

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

Returns:

getDisplayLength

@Deprecated
public int getDisplayLength()

Deprecated.

Seems nonsense, use width instead.

Returns:

isNowrap

public boolean isNowrap()

getCellClicked

@Nullable
public ICellClicked<?> getCellClicked()

getNumericPresentation

@Nonnull
public NumericPresentation getNumericPresentation()

getAlign

@Nullable
public TextAlign getAlign()

getRenderHint

@Nullable
public String getRenderHint()

getSortHelper

@Nullable
public ISortHelper<?> getSortHelper()

getSortProperty

@Nullable
public String getSortProperty()

setSortable

public void setSortable(@Nonnull
                        SortableType sortable)

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

label

@Nonnull
public ColumnDef<I,T> label(@Nullable
                                     String columnLabel)

Set the column header's label.

Parameters:

columnLabel -

Returns:

align

@Nonnull
public ColumnDef<I,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 ColumnDef<I,T> cellClicked(@Nullable
                                           ICellClicked<?> ck)

Set the cell click handler.

Parameters:

ck -

Returns:

renderer

@Nonnull
public ColumnDef<I,T> renderer(@Nullable
                                        INodeContentRenderer<T> cr)

Set the node content renderer.

Parameters:

cr -

Returns:

css

@Nonnull
public ColumnDef<I,T> css(@Nonnull
                                   String css)

Set the css class of this column's values.

Parameters:

css -

Returns:

cssHeader

@Nonnull
public ColumnDef<I,T> cssHeader(@Nonnull
                                         String css)

Set the css class of this column's header.

Parameters:

css -

Returns:

wrap

@Nonnull
public ColumnDef<I,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 ColumnDef<I,T> nowrap()

Set the column to nowrap.

Returns:

numeric

@Nonnull
public ColumnDef<I,T> numeric(@Nonnull
                                       NumericPresentation np)

Set the numeric presentation for this column.

Parameters:

np -

Returns:

hint

@Nonnull
public ColumnDef<I,T> hint(@Nonnull
                                    String hint)

Set the hint for a column.

Parameters:

hint -

Returns:

ascending

@Nonnull
public ColumnDef<I,T> ascending()

Set the default sort order to ascending first.

Returns:

descending

@Nonnull
public ColumnDef<I,T> descending()

Set the default sort order to descending first.

Returns:

sortdefault

@Nonnull
public ColumnDef<I,T> sortdefault()

Set this column as the default column to sort on.

Returns:

sort

@Nonnull
public ColumnDef<I,T> sort(@Nonnull
                                    ISortHelper<?> sh)

Set a sort helper to be used for this column. Important: if you just need to sort on a property consider sort(String) instead.

Parameters:

sh -

Returns:

sort

@Nonnull
public ColumnDef<I,T> sort(@Nonnull
                                    String propertyName)

For a column that represents the whole entity, this can specify which property of the entity is to be used to sort on. It prevents having to use an ISortHelper for simple sorting.

Parameters:

propertyName -

Returns:

width

@Nonnull
public ColumnDef<I,T> width(@Nullable
                                     String w)

converter

@Nonnull
public ColumnDef<I,T> converter(@Nullable
                                         IConverter<T> converter)

factory

@Nonnull
public ColumnDef<I,T> factory(@Nonnull
                                       IRowControlFactory<I> factory)

Define the control factory to create the control to use to show the column's value.

Parameters:

factory -

Returns:

getControlFactory

@Nullable
public IRowControlFactory<I> getControlFactory()

Return the control factory to create the control to use to show the column's value.

Returns: