org.eclipse.nebula.widgets.nattable.extension.builder.model
Class TableColumn

java.lang.Object
  org.eclipse.nebula.widgets.nattable.extension.builder.model.TableColumn

public class TableColumn
extends Object

Encapsulation of the properties of a column in the table

Field Summary

String	categoryName The column will be added to a category of the following name
Comparator<?>	comparator
String	dataTypeClassName Name of the class of the underlying row object property, Example "Double", "String" etc.
IDisplayConverter	displayConverter Formatter used to covert the underlying data to a display string and vice versa
String	displayName Name of the column as it appears in the column header
IEditor	editor The type of editor
IDisplayConverter	filterRowDisplayConverter Display converter to translate the strings typed by the user in the filter row.
IEditor	filterRowEditor Editor to be used in the filter row cell
String	groupName The column will be added to a group of the following name
int	index
boolean	isEditable Is the user allowed to edit this column
boolean	isSortable Column sorting
String	rowObjectPropertyName
ColumnStyle	style If a column specific style is set here, it will override the overall table style
Integer	width If a column specific width is set here, it will override the default column width from the table style

Constructor Summary

TableColumn(int index, String rowObjectPropertyName)

TableColumn(int index, String rowObjectPropertyName, String displayName)

Method Summary

TableColumn	setCategory(String categoryName)
TableColumn	setComparator(Comparator<?> comparator)
TableColumn	setDisplayConverter(IDisplayConverter displayConverter)
TableColumn	setEditor(IEditor editor)
TableColumn	setFilterRowDisplayConverter(IDisplayConverter displayConverter)
TableColumn	setFilterRowEditor(IEditor editor)
TableColumn	setGroupName(String groupName)
TableColumn	setStyle(ColumnStyle columnStyle)
TableColumn	setWidth(int width)

Methods inherited from class java.lang.Object

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

Field Detail

index

public int index

rowObjectPropertyName

public String rowObjectPropertyName

groupName

public String groupName

The column will be added to a group of the following name

categoryName

public String categoryName

The column will be added to a category of the following name

displayName

public String displayName

Name of the column as it appears in the column header

dataTypeClassName

public String dataTypeClassName

Name of the class of the underlying row object property, Example "Double", "String" etc.

isEditable

public boolean isEditable

Is the user allowed to edit this column

editor

public IEditor editor

The type of editor

style

public ColumnStyle style

If a column specific style is set here, it will override the overall table style

width

public Integer width

If a column specific width is set here, it will override the default column width from the table style

displayConverter

public IDisplayConverter displayConverter

Formatter used to covert the underlying data to a display string and vice versa

isSortable

public boolean isSortable

Column sorting

comparator

public Comparator<?> comparator

filterRowDisplayConverter

public IDisplayConverter filterRowDisplayConverter

Display converter to translate the strings typed by the user in the filter row. Defaults to the display converter used by the column

filterRowEditor

public IEditor filterRowEditor

Editor to be used in the filter row cell

Constructor Detail

TableColumn

public TableColumn(int index,
                   String rowObjectPropertyName)

TableColumn

public TableColumn(int index,
                   String rowObjectPropertyName,
                   String displayName)

Method Detail

setStyle

public TableColumn setStyle(ColumnStyle columnStyle)

setWidth

public TableColumn setWidth(int width)

setComparator

public TableColumn setComparator(Comparator<?> comparator)

setEditor

public TableColumn setEditor(IEditor editor)

setDisplayConverter

public TableColumn setDisplayConverter(IDisplayConverter displayConverter)

setGroupName

public TableColumn setGroupName(String groupName)

setCategory

public TableColumn setCategory(String categoryName)

setFilterRowEditor

public TableColumn setFilterRowEditor(IEditor editor)

setFilterRowDisplayConverter

public TableColumn setFilterRowDisplayConverter(IDisplayConverter displayConverter)