org.opencms.ui.util.table

Annotation Type Column

@Retention(value=RUNTIME)
public @interface Column

Annotation used to mark up bean properties with metadata for table columns.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	header The message key for the column header (if no given message is found, will be used as a literal header).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
float	expandRatio Expand ratio for the column (use negative values for no expand ratio).
boolean	filterable Flag indicating whether column should be filterable by default.
int	order The order key.
java.lang.String	styleName The style which should be used for a cell in this column.
java.lang.String	view The view in which the column should be displayed.
int	width The width (use -1 to not set the width).

Element Detail

header

public abstract java.lang.String header

The message key for the column header (if no given message is found, will be used as a literal header).

Returns:

the message key for the column header

expandRatio

public abstract float expandRatio

Expand ratio for the column (use negative values for no expand ratio).

Returns:

the expand ratoio

Default:

-1.0f

filterable

public abstract boolean filterable

Flag indicating whether column should be filterable by default.

Returns:

true if the column should be filterable

Default:

true

order

public abstract int order

The order key.

The ordering of columns is determined by the relative sizes of their order keys.

Returns:

the order key

Default:

-1

styleName

public abstract java.lang.String styleName

The style which should be used for a cell in this column.

Returns:

the style

Default:

""

view

public abstract java.lang.String view

The view in which the column should be displayed.

Returns:

the view

Default:

""

width

public abstract int width

The width (use -1 to not set the width).

Returns:

the width

Default:

-1