Package com.jbstrap.ui.components.listgrid.enums

Enum Class ListGridColumnType

java.lang.Object

java.lang.Enum<ListGridColumnType>

com.jbstrap.ui.components.listgrid.enums.ListGridColumnType

All Implemented Interfaces:

Serializable, Comparable<ListGridColumnType>, Constable

public enum ListGridColumnType
extends Enum<ListGridColumnType>

List grid column types.

Since:

4.0

Author:

JBStrap

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOOLEAN	Boolean column
CUSTOM	Custom column
DATE	Date column
DATETIME	Column with date and time
NUMBER	Numeric column
TEXT	Text column

Method Summary

Modifier and Type	Method	Description
static ListGridColumnType	fromDsDataType(DataDescriptorColumnDatatype dataType)
ListGridColumnAlignment	getDefaultAlignment()
ListGridCellFormatter	getDefaultColumnFormatter()
String	getStyleClass()
static ListGridColumnType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ListGridColumnType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DATE

public static final ListGridColumnType DATE

Date column

The column displays dates. The date is displayed using the framework’s default date format. The framework’s default date format can be set using the JBStrap parameter JBStrapParamType.DATE_FORMAT. If we want to use a different format, a formatter implementation must be used by calling the method ListGridColumn.setFormatter(ListGridCellFormatter). If you want to modify only the displayed format, use the ListGridDateFormatter class.

The default alignment setting for the displayed date is center-aligned. If you want a different alignment, it must be specified for the column using the method ListGridColumn.setAlignment(ListGridColumnAlignment).

All DataDescriptor columns with the data type DataDescriptorColumnDatatype.DATE are displayed in a date column.

DATETIME

public static final ListGridColumnType DATETIME

Column with date and time

Dates containing time are displayed in this columns. The date is displayed using the framework’s default date format. The framework’s default date and time format can be set using the JBStrap parameter JBStrapParamType.DATETIME_FORMAT. If you want to use a different format, a formatter must be implemented by using the method ListGridColumn.setFormatter(ListGridCellFormatter). If you want to modify only the display format, use the ListGridDateFormatter class.

The default alignment setting for the time is center-aligned. If you want a different alignment, it must be specified for the column using the method ListGridColumn.setAlignment(ListGridColumnAlignment).

All DataDescriptor columns with the data type DataDescriptorColumnDatatype.DATETIME are displayed in a date and time column.

NUMBER

public static final ListGridColumnType NUMBER

Numeric column

The column displays numeric data. Numeric values in the column are not formatted, but converted to text. Formatting the numbers or attaching prefixes/postfixes to them can be achieved by using the formatter method ListGridColumn.setFormatter(ListGridCellFormatter) .

Numeric data are by default aligned to the right. If you want to use a different alignment, use the method ListGridColumn.setAlignment(ListGridColumnAlignment).

All DataDescriptor columns with the data type DataDescriptorColumnDatatype.INTEGER, DataDescriptorColumnDatatype.DOUBLE or DataDescriptorColumnDatatype.LONG are displayed in a numeric column.

BOOLEAN

public static final ListGridColumnType BOOLEAN

Boolean column

The column displays boolean values. If the value is a Boolean type value and it is true, the column says “Yes”, otherwise "No”. In order to display the boolean values in a different way, a custom formatter must be implemented. To do this, use the ListGridColumn.setFormatter(ListGridCellFormatter) method. Use the ListGridBooleanFormatter class to modify the displayed texts. This enables you to set the text for TRUE and FALSE values.

The default alignment setting for the displayed value is center-aligned. If you want to use a different alignment, it must be set using the ListGridColumn.setAlignment(ListGridColumnAlignment) method.

All DataDescriptor columns with the data type DataDescriptorColumnDatatype.BOOLEAN are displayed in a boolean column.

TEXT

public static final ListGridColumnType TEXT

Text column

The column displays text data. If the value is not a text value, it is displayed converted to text. The default alignment setting is left-aligned. If you want to use a different alignment, it must be set using the ListGridColumn.setAlignment(ListGridColumnAlignment) method.

All DataDescriptor columns with the data type DataDescriptorColumnDatatype.TEXT or columns with unassigned data type are displayed in a text column.

CUSTOM

public static final ListGridColumnType CUSTOM

Custom column

By default, no formatting or alignment is set for the column. The column is used if the displayed content is rendered by a custom cell renderer class. This happens when you want to display a single or multiple components in the column. Read the description of the ListGridCellRenderer interface for more details on custom renderer. Use the ListGridColumn.setRenderer(ListGridCellRenderer) method to set the custom renderer class for the column.

Method Details

values

public static ListGridColumnType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ListGridColumnType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getStyleClass

public String getStyleClass()

Returns:

The column’s style class or null if there is no style class for the column

getDefaultColumnFormatter

public ListGridCellFormatter getDefaultColumnFormatter()

Returns:

An instance of the column’s default formatter class or null if there is no formatter class for the column

getDefaultAlignment

public ListGridColumnAlignment getDefaultAlignment()

Returns:

The column’s default alignment or null if no default alignment is set for the column

fromDsDataType

public static ListGridColumnType fromDsDataType(DataDescriptorColumnDatatype dataType)

Parameters:

dataType - The data type of the DataDescriptor

Returns:

List grid column type for the specified data type or null if there is no column type for the specified data type