com.whitestein.lsps.vaadin.forms

Class WAbstractTable.Column

java.lang.Object

com.whitestein.lsps.vaadin.forms.WAbstractTable.Column

All Implemented Interfaces:

Serializable

Enclosing class:

WAbstractTable

protected final class WAbstractTable.Column
extends Object
implements Serializable

A table column representation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Variant.RecordVariant	def forms::GridColumn, not null, present.
com.vaadin.ui.CustomTable.ColumnGenerator	generator The column generator to render this column, may be null if the value should simply be shown as String.

Constructor Summary

Constructors

Constructor and Description
Column(Variant.RecordVariant def)

Method Summary

Modifier and Type	Method and Description
FilterConfig	getFilterConfig() Gets the filter configuration defined for this table column.
ValueProvider	getFilterValueProvider() Returns the value provider for this column filter.
Variant.RecordVariant	getFilterValueProviderDef() Returns the filter value provider for this column.
String	getHeader() Gets the column header text.
com.vaadin.ui.CustomTable.Align	getHeaderAlignment() Gets the current setting of the header alignment or CustomTable.Align.LEFT if no explicit alignment of the header is set.
String	getHeaderStyleName() Gets style name applied to this column header.
Serializable	getPropertyId() The Grid property ID, equals to def.
ValueProvider	getSortValueProvider() Returns the value provider for this column sort.
Variant.RecordVariant	getSortValueProviderDef() Returns the sort value provider for this column.
ValueProvider	getValueProvider() Returns the value provider for this column.
Variant.RecordVariant	getValueProviderDef() Returns the value provider for this column.
boolean	isFiltrable() Checks whether the column is filterable.
boolean	isSortable()
void	setHeader(String header) Sets the column header text.
void	setHeaderAlignment(com.vaadin.ui.CustomTable.Align alignment) Sets the explicit header alignment settings.
void	setHeaderStyleName(String styleName) Sets the header style name.

Methods inherited from class java.lang.Object

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

Field Detail

def

public final Variant.RecordVariant def

forms::GridColumn, not null, present.

generator

public final com.vaadin.ui.CustomTable.ColumnGenerator generator

The column generator to render this column, may be null if the value should simply be shown as String.

Constructor Detail

Column

public Column(Variant.RecordVariant def)

Method Detail

getPropertyId

public Serializable getPropertyId()

The Grid property ID, equals to def.

Returns:

Grid property ID, not null.

getValueProviderDef

public Variant.RecordVariant getValueProviderDef()

Returns the value provider for this column.

Returns:

the value provider, not null.

getFilterValueProviderDef

public Variant.RecordVariant getFilterValueProviderDef()

Returns the filter value provider for this column.

Returns:

the filter value provider, not null.

getSortValueProviderDef

public Variant.RecordVariant getSortValueProviderDef()

Returns the sort value provider for this column.

Returns:

the sort value provider, not null.

getValueProvider

public ValueProvider getValueProvider()

Returns the value provider for this column.

Returns:

the value provider, not null.

getFilterValueProvider

public ValueProvider getFilterValueProvider()

Returns the value provider for this column filter. It defaults to the {getValueProvider()}.

Returns:

the value provider, not null.

getSortValueProvider

public ValueProvider getSortValueProvider()

Returns the value provider for this column sort. It defaults to the {getValueProvider()}.

Returns:

the value provider, not null.

isSortable

public boolean isSortable()

isFiltrable

public boolean isFiltrable()

Checks whether the column is filterable.

Returns:

if the column is filterable

getFilterConfig

public FilterConfig getFilterConfig()

Gets the filter configuration defined for this table column.

Returns:

filter configuration or null if no filter configuration is defined

getHeaderAlignment

public com.vaadin.ui.CustomTable.Align getHeaderAlignment()

Gets the current setting of the header alignment or CustomTable.Align.LEFT if no explicit alignment of the header is set.

Returns:

the header alignment setting.

setHeaderAlignment

public void setHeaderAlignment(com.vaadin.ui.CustomTable.Align alignment)

Sets the explicit header alignment settings. null means to use the default alignment which is left.

Parameters:

alignment - the alignment to set.

setHeader

public void setHeader(String header)

Sets the column header text.

Parameters:

header - the header to set

getHeader

public String getHeader()

Gets the column header text.

Returns:

the header

setHeaderStyleName

public void setHeaderStyleName(String styleName)

Sets the header style name. If it's needed to set more than a single style name this can be achieved by passing several style names separated by a space.

Parameters:

styleName - the style name to set.

getHeaderStyleName

public String getHeaderStyleName()

Gets style name applied to this column header.

Returns:

the style name