GxDefaultColumnDefinition

GxColumnDefinition
- GxDefaultColumnDefinition

```
public class GxDefaultColumnDefinition
extends GxColumnDefinition
```
The class represents the default column definition which the grid will use.

See Also:
[]

Field Summary

Modifier and Type Field and Description

BBjString

AggFunc!

Name of function to use for aggregation. One of [sum, min, max, first, last].

#Configuration
#ColumnsRenderer

HashSet

AllowedAggFuncs!

Aggregation functions allowed on this column eg ['sum', 'avg'].

#Configuration
#ColumnsRenderer

BBjNumber

AutoHeight!

Set to true to have the grid calculate height of row based on contents of this column.

#Configuration
#ColumnsRenderer

ArrayList

CellClass!

CSS class(es) to use for the cell.

#Configuration
#ColumnsRenderer

JsonObject

CellClassRules!

Rules which can be applied to include certain CSS classes. These rules are provided as a map where the keys are the class names and the values are expressions that if evaluated to true, the class gets used. An expression is evaluated by the grid by executing the string as if it were a Javascript expression.

#Configuration
#ColumnsRenderer.

The expression has the following attributes available to it.

x	Mapped from cell value
rowIndex	Maps the current row index
data	Mapped from the DataRow
ctx	The grid client context

GxCellEditorInterface

CellEditor!

CellEditor to use for this column

#Configuration
#ColumnsRenderer

GxRendererInterface

CellRenderer!

A cellRenderer to use for this column

#Configuration
#ColumnsRenderer

JsonObject

CellStyle!

A map of css values.

#Configuration
#ColumnsRenderer

BBjString

ChartType!

Defines the chart data type that should be used for a column. There are two types of charting ranges; a category range that is highlighted in green and a series range that is highlighted in blue. A category range can only contain cells from a single column, whereas a series range can contain values from many columns. Columns can be explicitly configured or left for the grid to infer the type based on the data contained in the cells where columns containing string values will map to 'categories' and columns containing number values will map to 'series' charting columns.

#Configuration
#ColumnsRenderer.

BBjNumber

CheckboxSelection!

Set to true to render a selection checkbox in the column.

#Configuration
#ColumnsRenderer

GxExpressionInterface

ColumnSpanExpression!

A grid expression which can be executed to perform column spanning.

The expression must return the number of columns to span , if no spanning should be applied , then return 1 instead (ex: "data.Section === 'quarters'")

By default, each cell will take up the width of one column. You can change this behaviour to allow cells to span multiple columns. This feature is similar to 'cell merging' in Excel or 'column spanning' in HTML tables.

Constraints with Column Spanning :

Column Spanning breaks out of the row / cell calculations that a lot of features in the grid are based on. If using Column Spanning, be aware of the following:

Range Selection will not work correctly when spanning cells. This is because it is not possible to cover all scenarios, as a range is no longer a perfect rectangle.

#Configuration
#ColumnsRenderer.

BBjString

DefaultDatesMask!

The default dates mask to use. by default %Dz.%Mz.%Yd

BBjString

DefaultNumbersMask!

The default numbers mask to use. by default null()

BBjString

DefaultStringsMask!

The default strings mask to use. by default null()

BBjString

DefaultTimesMask!

The default dates mask to use. by default %Dz.%Hz:%mz:%sz

BBjString

DefaultTimestampsMask!

The default timestamps mask to use. by default %Dz.%Mz.%Yl %Hz:%mz:%sz

BBjNumber

Editable!

Set to true if the column is editable, otherwise false.

#Configuration
#ColumnsRenderer

GxExpressionInterface

EditableExpression!

An expression which determines whether the column is editable or not. when this config is different than null , then the column configuration Editable will be ignored

BBjNumber

EnableFilter!

When true the filter is enabled, disabled otherwise

#Configuration
#ColumnsRenderer

BBjNumber

EnablePivot!

Set to true if you want to be able to pivot by this column via the UI.

#Enterprise
#Configuration
#ColumnsRenderer

BBjNumber

EnableRowGroup!

Set to true if you want to be able to row group by this column via the UI.

#Enterprise
#Configuration
#ColumnsRenderer

BBjNumber

EnableValue!

Set to true if you want to be able to aggregate by this column via the UI.

#Enterprise
#Configuration
#ColumnsRenderer

GxFilterInterface

Filter!

The filter component to use for this column

#Configuration
#ColumnsRenderer

GxExpressionInterface

FilterValueGetterExpression!

An Ag Grid expression which can be executed to get the value for filtering purposes.

#Configuration
#ColumnsRenderer.

BBjNumber

FloatingFilter!

When true enable the floating filter on this column , false otherwise

#Configuration
#ColumnsRenderer

BBjNumber

HeaderCheckboxSelection!

Set to true to render a selection checkbox in the column's header.

#Configuration
#ColumnsRenderer

BBjNumber

HeaderCheckboxSelectionFilteredOnly!

When true , The checkbox will select only filtered rows when checked and un-select only filtered rows when unchecked. The checkbox will update its state based only on filtered rows. When false The checkbox will select all rows when checked, and un-select all rows when unchecked. The checkbox will update its state based on all rows.

#Configuration
#ColumnsRenderer

BBjNumber

Hidden!

Set to true to make a column hidden by default.

#Configuration
#ColumnsRenderer

JsonObject

Icons!

Icons to use inside the column instead of the grid's default icons.

The icons can either be set on the grid options (all icons) or on the column definition (all except group). If defined in both the grid options and column definitions, the column definition will get used. This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons and just the simple arrow for other columns.

#Configuration
#ColumnsRenderer.

The icons are set as follows:

 
 // column header items
 menu
 filter
 columns
 sortAscending
 sortDescending
 sortUnSort

 // row checkbox selection and tool panel column selection
 checkboxChecked
 checkboxUnchecked
 checkboxIndeterminate

 // tool panel column selection, when read only (ie disabled checkboxes)
 checkboxCheckedReadOnly
 checkboxUncheckedReadOnly
 checkboxIndeterminateReadOnly

 // when moving columns
 columnMovePin // when column is to the left, before it gets pinned
 columnMoveAdd // when adding a column
 columnMoveHide // when removing a column
 columnMoveMove // when moving a column
 columnMoveLeft // when moving and scrolling left
 columnMoveRight // when moving and scrolling right
 columnMoveGroup // when about to drop into group panel
 columnMoveValue // when about to drop into value panel
 columnMovePivot // when about to drop into pivot panel
 dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it

 // menu
 menuPin // beside the column pin menu item
 menuValue // beside the column value menu item
 menuAddRowGroup // beside the column row group menu item
 menuRemoveRowGroup // beside the column row group menu item
 clipboardCopy // beside the copy to clipboard menu item
 clipboardPaste // beside the paste from clipboard menu item

 // column drop panels
 pivotPanel // beside where to drop columns for pivot
 valuePanel // beside where to drop columns for value

BBjNumber

LockPinned!

Set to true block pinning column via the UI (API will still work).

#Configuration
#ColumnsRenderer

BBjNumber

LockPosition!

Set to true to always have column displayed first.

#Configuration
#ColumnsRenderer

BBjNumber

LockVisible!

Set to true block making column visible / hidden via the UI (API will still work).

#Configuration
#ColumnsRenderer

BBjString

Mask!

The default column mask

BBjNumber

MaxWidth!

Initial max width in pixels

#Configuration
#ColumnsRenderer

ArrayList

MenuTabs!

Set to an array containing zero, one or many of the pre built men tabs. This is used to figure out which menu tabs are present and in which order the tabs are shown.

BBjNumber

MinWidth!

Initial min width in pixels

#Configuration
#ColumnsRenderer

BBjString

Pinned!

Set to 'left' or 'right' to pin.

#Configuration
#ColumnsRenderer

GxRendererInterface

PinnedRowCellRenderer!

A cellRenderer for pinned rows.

Use to give pinned row cell a different CellRenderer to the other cells. If both CellRenderer and PinnedRowCellRenderer are provided, pinned rows will use PinnedRowCellRenderer over CellRenderer.

#Configuration
#ColumnsRenderer

BBjNumber

PivotIndex!

Set this in columns you want to pivot by. If only pivoting by one column, set this to any number (eg 0). If pivoting by multiple columns, set this to where you want this column to be in the order of pivots (eg 0 for first, 1 for second, and so on).

#Configuration
#ColumnsRenderer

BBjNumber

Resizable!

Set to true to allow column to be resized.

#Configuration
#ColumnsRenderer

BBjNumber

RowGroup!

Set to true To group rows by this column

#Enterprise
#Configuration
#ColumnsRenderer

BBjNumber

RowGroupIndex!

Set this in columns you want to group by. If only grouping by one column, set this to any number (eg 0). If grouping by multiple columns, set this to where you want this column to be in the group (eg 0 for first, 1 for second, and so on).

#Configuration
#ColumnsRenderer

GxExpressionInterface

RowSpanExpression!

A grid expression which can be executed to perform row spanning.

The expression must return the number of rows to span , if no spanning should be applied , then return 1 instead (ex: "data.SHOW ? 4 : 1")

By default, each cell will take up the height of one row. You can change this behaviour to allow cells to span multiple rows. This feature is similar to 'cell merging' in Excel or 'row spanning' in HTML tables.

To allow row spanning, the grid must have options SuppressRowTransform=true To have a cell span more than one row, return how many rows to span in the RowSpanExpression.

The option SuppressRowTransform=true is used to stop the grid positioning rows using CSS transform and instead the grid will use CSS top. The reason row span will not work with CSS transform is that CSS transform creates a stacking context which constrains CSS z-index from placing cells on top of other cells in another row. Having cells extend into other rows is necessary for row span which means it will not work when using CSS transform. The downside to not using transform is performance; row animation (after sort or filter) will be slower.

Constraints with Row Spanning :

Row Spanning breaks out of the row / cell calculations that a lot of features in the grid are based on. If using Row Spanning, be aware of the following:

Responsibility is with the developer to not span past the last row. This is especially true if sorting and filtering (e.g. a cell may span outside the grid after the data is sorted and the cell's row ends up at the bottom of the grid).

Responsibility is with the developer to apply a background style to spanning cells so that overwritten cells cannot be seen.

Overwritten cells will still exist, but will not be visible. This means cell navigation will go to the other cells - e.g. if a row spanned cell has focus, and the user hits the 'arrow down' key, the focus will go to a hidden cell.

Row span does not work with dynamic row height or auto-height. The row span assumes default row height is used when calculating how high the cell should be.

Sorting and filtering will provide strange results when row spanning. For example a cell may span 4 rows, however applying a filter or a sort will probably change the requirements of what rows should be spanned.

Range Selection will not work correctly when spanning cells. This is because it is not possible to cover all scenarios, as a range is no longer a perfect rectangle.

#Configuration
#ColumnsRenderer.

BBjString

Sort!

Set to 'asc' or 'desc' to sort by this column by default.

#Configuration
#ColumnsRenderer

BBjNumber

Sortable!

Set to true to allow sorting on this column.

#Configuration
#ColumnsRenderer

BBjNumber

SuppressMenu!

Set to true if no menu should be shown for this column header.

#Configuration
#ColumnsRenderer

BBjNumber

SuppressMovable!

Set to true if you do not want this column to be movable via dragging.

#Configuration
#ColumnsRenderer

BBjNumber

SuppressNavigable!

Set to true if this col is not navigable (ie cannot be tabbed into), otherwise false.

#Configuration
#ColumnsRenderer

BBjNumber

SuppressSizeToFit!

Set to true if you want this columns width to be fixed during 'size to fit' operation.

#Configuration
#ColumnsRenderer

BBjString

TooltipField!

The field of the tooltip to apply to the cell.

#Configuration
#ColumnsRenderer

GxExpressionInterface

TooltipValueGetterExpression!

A Grid expression which can be executed to return the tooltip value to display for each cell.

#Configuration
#ColumnsRenderer.

BBjNumber

Type!

The Field Type.

#Configuration
#ColumnsRenderer

Note : Not all sql types are supported, for example it does not make sense to declare a colum type as STRUCT.

BBjNumber

UnSortIcon!

Set to true if you want the unsorted icon to be shown when no sort is applied to this column.

#Configuration
#ColumnsRenderer

GxExpressionInterface

ValueFormatterExpression!

An Ag Grid expression which can be executed to format the value for display.

#Configuration
#ColumnsRenderer.

GxExpressionInterface

ValueGetterExpression!

An Ag Grid expression which can be executed before getting the value from your data for display

#Configuration
#ColumnsRenderer.

GxExpressionInterface

ValueParserExpression!

An Ag Grid expression which can be executed to parse the value for saving.

#Configuration
#ColumnsRenderer.

GxExpressionInterface

ValueSetterExpression!

An Ag Grid expression which can be executed before setting the value into your data for saving.

#Configuration
#ColumnsRenderer.

BBjNumber

Width!

Initial width in pixels

#Configuration
#ColumnsRenderer

Note: setting the width to zero will not hide the column, use setHidden() instead. And if the width is null() this means the grid will auto set the width for this column

Method Summary

Methods
Modifier and Type	Method and Description
`static BBjString`	`CHART_TYPE_CATEGORY()` A constant which defines column chart category
`static BBjString`	`CHART_TYPE_EXCLUDED()` A constant which defines column chart excluded, columns which set chart type to excluded will be excluded from charts
`static BBjString`	`CHART_TYPE_SERIES()` A constant which defines column chart series
`static BBjString`	`COLUMN_GROUP_CLOSED()` A constant which defines the group state as opened
`static BBjString`	`COLUMN_GROUP_OPENED()` A constant which defines the group state as opened
`JsonObject`	`getAsJsonObject()` Convert the definition to Json Object
`BBjString`	`getDefaultDatesMask()`
`BBjString`	`getDefaultNumbersMask()`
`BBjString`	`getDefaultStringsMask()`
`BBjString`	`getDefaultTimesMask()`
`BBjString`	`getDefaultTimestampsMask()`
`BBjString`	`getMask()` Get the column mask
`static BBjString`	`PINNED_LEFT()` Get pinned left constant
`static BBjString`	`PINNED_RIGHT()` Get pinned right constant
`void`	`setAlignment(BBjNumber align!, BBjNumber alignHeader!)` Sets the default alignment for a column
`void`	`setAlignment(BBjNumber align!)` Sets the default alignment for a column
`void`	`setAllowedAggFuncs(BBjString funcs!)` Set the allowed aggregation functions allowed on this column
`void`	`setBackColor(BBjColor color!)` Sets the background color of a column
`void`	`setBackColor(BBjString color!)` Sets the background color of a column
`void`	`setColumnMask(BBjString mask!)` Set the mask of a column in all supported components (filters , formatters , ...) In case the column has no value formatter expression , then the method will create one
`void`	`setColumnSpanExpression(BBjString expression!)` Create a GxExpression from string and set it as column span expression
`void`	`setDefaultDatesMask(BBjString mask!)`
`void`	`setDefaultNumbersMask(BBjString mask!)`
`void`	`setDefaultStringsMask(BBjString mask!)`
`void`	`setDefaultTimesMask(BBjString mask!)`
`void`	`setDefaultTimestampsMask(BBjString mask!)`
`void`	`setEditableExpression(BBjString expression!)` Create a GxExpression from string and set it as editable expression
`void`	`setForeColor(BBjColor color!)` Sets the foreground color for a column
`void`	`setForeColor(BBjString color!)` Sets the foreground color for a column
`void`	`setHeaderAlignment(BBjNumber align!)` Sets the default alignment for a column's header
`void`	`setIcons(BBjString json!)` Set the grid icons
`void`	`setMask(BBjString mask!)` Set the mask of a column in all supported components (filters , formatters , ...) In case the column has no value formatter expression , then the method will create one
`void`	`setRowSpanExpression(BBjString expression!)` Create a GxExpression from string and set it as row span expression
`void`	`setTooltipValueGetterExpression(BBjString expression!)` Create a GxExpression from string and set it as tooltip value getter
`void`	`setType(BBjNumber type!)` Set the column type
`void`	`setValueFormatterExpression(BBjString expression!)` Create a GxExpression from string and set it as value formatter
`void`	`setValueGetterExpression(BBjString expression!)` Create a GxExpression from string and set it as value getter
`void`	`setValueParserExpression(BBjString expression!)` Create a GxExpression from string and set it as value parser
`void`	`setValueSetterExpression(BBjString expression!)` Create a GxExpression from string and set it as value setter
`static BBjString`	`SORT_ASC()` Get sort direction constant
`static BBjString`	`SORT_DESC()` Get sort direction constant

- Field Detail
  - AggFunc!
```
public BBjString AggFunc!
```
    Name of function to use for aggregation. One of [sum, min, max, first, last].
    
    #Configuration
    #ColumnsRenderer
  - AllowedAggFuncs!
```
public HashSet AllowedAggFuncs!
```
    Aggregation functions allowed on this column eg ['sum', 'avg'].
    
    #Configuration
    #ColumnsRenderer
  - AutoHeight!
```
public BBjNumber AutoHeight!
```
    Set to true to have the grid calculate height of row based on contents of this column.
    
    #Configuration
    #ColumnsRenderer
  - CellClass!
```
public ArrayList CellClass!
```
    CSS class(es) to use for the cell.
    
    #Configuration
    #ColumnsRenderer
  - CellClassRules!
```
public JsonObject CellClassRules!
```
    Rules which can be applied to include certain CSS classes. These rules are provided as a map where the keys are the class names and the values are expressions that if evaluated to true, the class gets used. An expression is evaluated by the grid by executing the string as if it were a Javascript expression.
    
    #Configuration
    #ColumnsRenderer.
    
    The expression has the following attributes available to it.
    
    x Mapped from cell value
    
    rowIndex Maps the current row index
    
    data Mapped from the DataRow
    
    ctx The grid client context
  - CellEditor!
```
public GxCellEditorInterface CellEditor!
```
    CellEditor to use for this column
    
    #Configuration
    #ColumnsRenderer
  - CellRenderer!
```
public GxRendererInterface CellRenderer!
```
    A cellRenderer to use for this column
    
    #Configuration
    #ColumnsRenderer
  - CellStyle!
```
public JsonObject CellStyle!
```
    A map of css values.
    
    #Configuration
    #ColumnsRenderer
  - ChartType!
```
public BBjString ChartType!
```
    Defines the chart data type that should be used for a column. There are two types of charting ranges; a category range that is highlighted in green and a series range that is highlighted in blue. A category range can only contain cells from a single column, whereas a series range can contain values from many columns. Columns can be explicitly configured or left for the grid to infer the type based on the data contained in the cells where columns containing string values will map to 'categories' and columns containing number values will map to 'series' charting columns.
    
    #Configuration
    #ColumnsRenderer.
  - CheckboxSelection!
```
public BBjNumber CheckboxSelection!
```
    Set to true to render a selection checkbox in the column.
    
    #Configuration
    #ColumnsRenderer
  - ColumnSpanExpression!
```
public GxExpressionInterface ColumnSpanExpression!
```
    A grid expression which can be executed to perform column spanning.
    
    The expression must return the number of columns to span , if no spanning should be applied , then return 1 instead (ex: "data.Section === 'quarters'")
    
    By default, each cell will take up the width of one column. You can change this behaviour to allow cells to span multiple columns. This feature is similar to 'cell merging' in Excel or 'column spanning' in HTML tables.
    
    Constraints with Column Spanning :
    
    Column Spanning breaks out of the row / cell calculations that a lot of features in the grid are based on. If using Column Spanning, be aware of the following:
    
    Range Selection will not work correctly when spanning cells. This is because it is not possible to cover all scenarios, as a range is no longer a perfect rectangle.
    
    #Configuration
    #ColumnsRenderer.
    See Also:
    GxExpression
  DefaultDatesMask!
  public BBjString DefaultDatesMask!
  The default dates mask to use. by default %Dz.%Mz.%Yd
  
  Deprecated:
  - Use Mask instead
  DefaultNumbersMask!
  public BBjString DefaultNumbersMask!
  The default numbers mask to use. by default null()
  
  Deprecated:
  - Use Mask instead
  DefaultStringsMask!
  public BBjString DefaultStringsMask!
  The default strings mask to use. by default null()
  
  Deprecated:
  - Use Mask instead
  DefaultTimesMask!
  public BBjString DefaultTimesMask!
  The default dates mask to use. by default %Dz.%Hz:%mz:%sz
  
  Deprecated:
  - Use Mask instead
  DefaultTimestampsMask!
  public BBjString DefaultTimestampsMask!
  The default timestamps mask to use. by default %Dz.%Mz.%Yl %Hz:%mz:%sz
  
  Deprecated:
  - Use Mask instead
  Editable!
  public BBjNumber Editable!
  Set to true if the column is editable, otherwise false.
  
  #Configuration
  #ColumnsRenderer
  
  EditableExpression!
  public GxExpressionInterface EditableExpression!
  An expression which determines whether the column is editable or not. when this config is different than null , then the column configuration Editable will be ignored
  
  EnableFilter!
  public BBjNumber EnableFilter!
  When true the filter is enabled, disabled otherwise
  
  #Configuration
  #ColumnsRenderer
  
  EnablePivot!
  public BBjNumber EnablePivot!
  Set to true if you want to be able to pivot by this column via the UI.
  
  #Enterprise
  #Configuration
  #ColumnsRenderer
  
  EnableRowGroup!
  public BBjNumber EnableRowGroup!
  Set to true if you want to be able to row group by this column via the UI.
  
  #Enterprise
  #Configuration
  #ColumnsRenderer
  
  EnableValue!
  public BBjNumber EnableValue!
  Set to true if you want to be able to aggregate by this column via the UI.
  
  #Enterprise
  #Configuration
  #ColumnsRenderer
  
  Filter!
  public GxFilterInterface Filter!
  The filter component to use for this column
  
  #Configuration
  #ColumnsRenderer
  
  FilterValueGetterExpression!
  public GxExpressionInterface FilterValueGetterExpression!
  An Ag Grid expression which can be executed to get the value for filtering purposes.
  
  #Configuration
  #ColumnsRenderer.
  
  See Also:
  Gx.Expression.GxExpression
  FloatingFilter!
  public BBjNumber FloatingFilter!
  When true enable the floating filter on this column , false otherwise
  
  #Configuration
  #ColumnsRenderer
  
  HeaderCheckboxSelection!
  public BBjNumber HeaderCheckboxSelection!
  Set to true to render a selection checkbox in the column's header.
  
  #Configuration
  #ColumnsRenderer
  
  HeaderCheckboxSelectionFilteredOnly!
  public BBjNumber HeaderCheckboxSelectionFilteredOnly!
  When true , The checkbox will select only filtered rows when checked and un-select only filtered rows when unchecked. The checkbox will update its state based only on filtered rows. When false The checkbox will select all rows when checked, and un-select all rows when unchecked. The checkbox will update its state based on all rows.
  
  #Configuration
  #ColumnsRenderer
  
  Hidden!
  public BBjNumber Hidden!
  Set to true to make a column hidden by default.
  
  #Configuration
  #ColumnsRenderer
  
  Icons!
  public JsonObject Icons!
  Icons to use inside the column instead of the grid's default icons.
  
  The icons can either be set on the grid options (all icons) or on the column definition (all except group). If defined in both the grid options and column definitions, the column definition will get used. This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons and just the simple arrow for other columns.
  
  #Configuration
  #ColumnsRenderer.
  
  The icons are set as follows:
  
  // column header items menu filter columns sortAscending sortDescending sortUnSort // row checkbox selection and tool panel column selection checkboxChecked checkboxUnchecked checkboxIndeterminate // tool panel column selection, when read only (ie disabled checkboxes) checkboxCheckedReadOnly checkboxUncheckedReadOnly checkboxIndeterminateReadOnly // when moving columns columnMovePin // when column is to the left, before it gets pinned columnMoveAdd // when adding a column columnMoveHide // when removing a column columnMoveMove // when moving a column columnMoveLeft // when moving and scrolling left columnMoveRight // when moving and scrolling right columnMoveGroup // when about to drop into group panel columnMoveValue // when about to drop into value panel columnMovePivot // when about to drop into pivot panel dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it // menu menuPin // beside the column pin menu item menuValue // beside the column value menu item menuAddRowGroup // beside the column row group menu item menuRemoveRowGroup // beside the column row group menu item clipboardCopy // beside the copy to clipboard menu item clipboardPaste // beside the paste from clipboard menu item // column drop panels pivotPanel // beside where to drop columns for pivot valuePanel // beside where to drop columns for value
  
  LockPinned!
  public BBjNumber LockPinned!
  Set to true block pinning column via the UI (API will still work).
  
  #Configuration
  #ColumnsRenderer
  
  LockPosition!
  public BBjNumber LockPosition!
  Set to true to always have column displayed first.
  
  #Configuration
  #ColumnsRenderer
  
  LockVisible!
  public BBjNumber LockVisible!
  Set to true block making column visible / hidden via the UI (API will still work).
  
  #Configuration
  #ColumnsRenderer
  
  Mask!
  public BBjString Mask!
  The default column mask
  
  MaxWidth!
  public BBjNumber MaxWidth!
  Initial max width in pixels
  
  #Configuration
  #ColumnsRenderer
  
  MenuTabs!
  public ArrayList MenuTabs!
  Set to an array containing zero, one or many of the pre built men tabs. This is used to figure out which menu tabs are present and in which order the tabs are shown.
  
  See Also:
  GxColumn.MENU_TAB_FILTER()
  GxColumn.MENU_TAB_GENERAL()
  GxColumn.MENU_TAB_COLUMNS()
  MinWidth!
  public BBjNumber MinWidth!
  Initial min width in pixels
  
  #Configuration
  #ColumnsRenderer
  
  Pinned!
  public BBjString Pinned!
  Set to 'left' or 'right' to pin.
  
  #Configuration
  #ColumnsRenderer
  
  See Also:
  PINNED_LEFT()
  PINNED_RIGHT()
  PinnedRowCellRenderer!
  public GxRendererInterface PinnedRowCellRenderer!
  A cellRenderer for pinned rows.
  
  Use to give pinned row cell a different CellRenderer to the other cells. If both CellRenderer and PinnedRowCellRenderer are provided, pinned rows will use PinnedRowCellRenderer over CellRenderer.
  
  #Configuration
  #ColumnsRenderer
  
  Deprecated:
  since v1.7.0, Setting this value won't affect the rendering. Please use the `CellRenderer` instead.
  PivotIndex!
  public BBjNumber PivotIndex!
  Set this in columns you want to pivot by. If only pivoting by one column, set this to any number (eg 0). If pivoting by multiple columns, set this to where you want this column to be in the order of pivots (eg 0 for first, 1 for second, and so on).
  
  #Configuration
  #ColumnsRenderer
  
  Resizable!
  public BBjNumber Resizable!
  Set to true to allow column to be resized.
  
  #Configuration
  #ColumnsRenderer
  
  RowGroup!
  public BBjNumber RowGroup!
  Set to true To group rows by this column
  
  #Enterprise
  #Configuration
  #ColumnsRenderer
  
  See Also:
  Gx.Columns.EnableRowGroup!
  RowGroupIndex!
  public BBjNumber RowGroupIndex!
  Set this in columns you want to group by. If only grouping by one column, set this to any number (eg 0). If grouping by multiple columns, set this to where you want this column to be in the group (eg 0 for first, 1 for second, and so on).
  
  #Configuration
  #ColumnsRenderer
  
  RowSpanExpression!
  public GxExpressionInterface RowSpanExpression!
  A grid expression which can be executed to perform row spanning.
  
  The expression must return the number of rows to span , if no spanning should be applied , then return 1 instead (ex: "data.SHOW ? 4 : 1")
  
  By default, each cell will take up the height of one row. You can change this behaviour to allow cells to span multiple rows. This feature is similar to 'cell merging' in Excel or 'row spanning' in HTML tables.
  
  To allow row spanning, the grid must have options SuppressRowTransform=true To have a cell span more than one row, return how many rows to span in the RowSpanExpression.
  
  The option SuppressRowTransform=true is used to stop the grid positioning rows using CSS transform and instead the grid will use CSS top. The reason row span will not work with CSS transform is that CSS transform creates a stacking context which constrains CSS z-index from placing cells on top of other cells in another row. Having cells extend into other rows is necessary for row span which means it will not work when using CSS transform. The downside to not using transform is performance; row animation (after sort or filter) will be slower.
  
  Constraints with Row Spanning :
  
  Row Spanning breaks out of the row / cell calculations that a lot of features in the grid are based on. If using Row Spanning, be aware of the following:
  
  Responsibility is with the developer to not span past the last row. This is especially true if sorting and filtering (e.g. a cell may span outside the grid after the data is sorted and the cell's row ends up at the bottom of the grid).
  
  Responsibility is with the developer to apply a background style to spanning cells so that overwritten cells cannot be seen.
  
  Overwritten cells will still exist, but will not be visible. This means cell navigation will go to the other cells - e.g. if a row spanned cell has focus, and the user hits the 'arrow down' key, the focus will go to a hidden cell.
  
  Row span does not work with dynamic row height or auto-height. The row span assumes default row height is used when calculating how high the cell should be.
  
  Sorting and filtering will provide strange results when row spanning. For example a cell may span 4 rows, however applying a filter or a sort will probably change the requirements of what rows should be spanned.
  
  Range Selection will not work correctly when spanning cells. This is because it is not possible to cover all scenarios, as a range is no longer a perfect rectangle.
  
  #Configuration
  #ColumnsRenderer.
  
  See Also:
  GxExpression
  Sort!
  public BBjString Sort!
  Set to 'asc' or 'desc' to sort by this column by default.
  
  #Configuration
  #ColumnsRenderer
  
  See Also:
  SORT_DESC()
  SORT_ASC()
  Sortable!
  public BBjNumber Sortable!
  Set to true to allow sorting on this column.
  
  #Configuration
  #ColumnsRenderer
  
  SuppressMenu!
  public BBjNumber SuppressMenu!
  Set to true if no menu should be shown for this column header.
  
  #Configuration
  #ColumnsRenderer
  
  SuppressMovable!
  public BBjNumber SuppressMovable!
  Set to true if you do not want this column to be movable via dragging.
  
  #Configuration
  #ColumnsRenderer
  
  SuppressNavigable!
  public BBjNumber SuppressNavigable!
  Set to true if this col is not navigable (ie cannot be tabbed into), otherwise false.
  
  #Configuration
  #ColumnsRenderer
  
  SuppressSizeToFit!
  public BBjNumber SuppressSizeToFit!
  Set to true if you want this columns width to be fixed during 'size to fit' operation.
  
  #Configuration
  #ColumnsRenderer
  
  TooltipField!
  public BBjString TooltipField!
  The field of the tooltip to apply to the cell.
  
  #Configuration
  #ColumnsRenderer
  
  TooltipValueGetterExpression!
  public GxExpressionInterface TooltipValueGetterExpression!
  A Grid expression which can be executed to return the tooltip value to display for each cell.
  
  #Configuration
  #ColumnsRenderer.
  
  See Also:
  GxExpressions.GxExpression
  Type!
  public BBjNumber Type!
  The Field Type.
  
  #Configuration
  #ColumnsRenderer
  
  Note : Not all sql types are supported, for example it does not make sense to declare a colum type as STRUCT.
  
  See Also:
  https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html
  UnSortIcon!
  public BBjNumber UnSortIcon!
  Set to true if you want the unsorted icon to be shown when no sort is applied to this column.
  
  #Configuration
  #ColumnsRenderer
  
  ValueFormatterExpression!
  public GxExpressionInterface ValueFormatterExpression!
  An Ag Grid expression which can be executed to format the value for display.
  
  #Configuration
  #ColumnsRenderer.
  
  See Also:
  Gx.Expression.GxExpression
  ValueGetterExpression!
  public GxExpressionInterface ValueGetterExpression!
  An Ag Grid expression which can be executed before getting the value from your data for display
  
  #Configuration
  #ColumnsRenderer.
  
  See Also:
  Gx.Expression.GxExpression
  ValueParserExpression!
  public GxExpressionInterface ValueParserExpression!
  An Ag Grid expression which can be executed to parse the value for saving.
  
  #Configuration
  #ColumnsRenderer.
  
  See Also:
  Gx.Expression.GxExpression
  ValueSetterExpression!
  public GxExpressionInterface ValueSetterExpression!
  An Ag Grid expression which can be executed before setting the value into your data for saving.
  
  #Configuration
  #ColumnsRenderer.
  
  See Also:
  Gx.Expression.GxExpression
  Width!
  public BBjNumber Width!
  Initial width in pixels
  
  #Configuration
  #ColumnsRenderer
  
  Note: setting the width to zero will not hide the column, use setHidden() instead. And if the width is null() this means the grid will auto set the width for this column
  
  See Also:
  setHidden()
Method Detail
CHART_TYPE_CATEGORY
public static BBjString CHART_TYPE_CATEGORY()
A constant which defines column chart category

Returns:
BBjString category
CHART_TYPE_EXCLUDED
public static BBjString CHART_TYPE_EXCLUDED()
A constant which defines column chart excluded, columns which set chart type to excluded will be excluded from charts

Returns:
BBjString excluded
CHART_TYPE_SERIES
public static BBjString CHART_TYPE_SERIES()
A constant which defines column chart series

Returns:
BBjString series
COLUMN_GROUP_CLOSED
public static BBjString COLUMN_GROUP_CLOSED()
A constant which defines the group state as opened

Returns:
BBjString opened
COLUMN_GROUP_OPENED
public static BBjString COLUMN_GROUP_OPENED()
A constant which defines the group state as opened

Returns:
BBjString opened
getAsJsonObject
public JsonObject getAsJsonObject()
Convert the definition to Json Object

getDefaultDatesMask
public BBjString getDefaultDatesMask()
Deprecated:
Use `getMask` instead
getDefaultNumbersMask
public BBjString getDefaultNumbersMask()
Deprecated:
Use `getMask` instead
getDefaultStringsMask
public BBjString getDefaultStringsMask()
Deprecated:
Use `getMask` instead
getDefaultTimesMask
public BBjString getDefaultTimesMask()
Deprecated:
Use `getDefaultTimesMask` instead
getDefaultTimestampsMask
public BBjString getDefaultTimestampsMask()
Deprecated:
Use `getDefaultTimesMask` instead
getMask
public BBjString getMask()
Get the column mask

Returns:
BBjString the column mask
PINNED_LEFT
public static BBjString PINNED_LEFT()
Get pinned left constant

Returns:
BBjString left
PINNED_RIGHT
public static BBjString PINNED_RIGHT()
Get pinned right constant

Returns:
BBjString right
setAlignment
public void setAlignment(BBjNumber align!, BBjNumber alignHeader!)
Sets the default alignment for a column

Parameters:
BBjNumber align! The column alignment
BBjNumber alignHeader! when true the column's header will use the same alignment valid alignments:
See Also:
BBjGridExWidget.GRID_ALIGN_LEFT()
BBjGridExWidget.GRID_ALIGN_CENTER()
BBjGridExWidget.GRID_ALIGN_RIGHT()
setAlignment
public void setAlignment(BBjNumber align!)
Sets the default alignment for a column

Parameters:
BBjNumber align! The column alignment valid alignments:
See Also:
BBjGridExWidget.GRID_ALIGN_LEFT()
BBjGridExWidget.GRID_ALIGN_CENTER()
BBjGridExWidget.GRID_ALIGN_RIGHT()
setAllowedAggFuncs
public void setAllowedAggFuncs(BBjString funcs!)
Set the allowed aggregation functions allowed on this column

Parameters:
BBjString funcs! comma separated functions
setBackColor
public void setBackColor(BBjColor color!)
Sets the background color of a column

Parameters:
BBjColor color! The color for the column
setBackColor
public void setBackColor(BBjString color!)
Sets the background color of a column

Parameters:
BBjColor color$ Valid CSS color
See Also:
https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
setColumnMask
public void setColumnMask(BBjString mask!)
Set the mask of a column in all supported components (filters , formatters , ...)

In case the column has no value formatter expression , then the method will create one

Parameters:
mask! - The BBj date string or numeric mask.
Deprecated:
Use `setMask` instead
setColumnSpanExpression
public void setColumnSpanExpression(BBjString expression!)
Create a GxExpression from string and set it as column span expression

Parameters:
BBjString expression! Javascript expression
setDefaultDatesMask
public void setDefaultDatesMask(BBjString mask!)
Deprecated:
Use `setMask` instead
setDefaultNumbersMask
public void setDefaultNumbersMask(BBjString mask!)
Deprecated:
Use `setMask` instead
setDefaultStringsMask
public void setDefaultStringsMask(BBjString mask!)
Deprecated:
Use `setMask` instead
setDefaultTimesMask
public void setDefaultTimesMask(BBjString mask!)
Deprecated:
Use `setMask` instead
setDefaultTimestampsMask
public void setDefaultTimestampsMask(BBjString mask!)
Deprecated:
Use `setMask` instead
setEditableExpression
public void setEditableExpression(BBjString expression!)
Create a GxExpression from string and set it as editable expression

Parameters:
BBjString expression! Javascript expression
setForeColor
public void setForeColor(BBjColor color!)
Sets the foreground color for a column

Parameters:
BBjColor color! the color for the column
setForeColor
public void setForeColor(BBjString color!)
Sets the foreground color for a column

Parameters:
BBjString color$ Valid CSS color
See Also:
https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
setHeaderAlignment
public void setHeaderAlignment(BBjNumber align!)
Sets the default alignment for a column's header

Parameters:
BBjNumber align! The column's header alignment valid alignments:
See Also:
BBjGridExWidget.GRID_ALIGN_LEFT()
BBjGridExWidget.GRID_ALIGN_CENTER()
BBjGridExWidget.GRID_ALIGN_RIGHT()
setIcons
public void setIcons(BBjString json!)
Set the grid icons

Parameters:
BBjString json! The icons as a json object
setMask
public void setMask(BBjString mask!)
Set the mask of a column in all supported components (filters , formatters , ...)

In case the column has no value formatter expression , then the method will create one

Parameters:
mask! - The BBj date string or numeric mask.
setRowSpanExpression
public void setRowSpanExpression(BBjString expression!)
Create a GxExpression from string and set it as row span expression

Parameters:
BBjString expression! Javascript expression
setTooltipValueGetterExpression
public void setTooltipValueGetterExpression(BBjString expression!)
Create a GxExpression from string and set it as tooltip value getter

Parameters:
BBjString expression! Javascript expression
setType
public void setType(BBjNumber type!)
Set the column type

Parameters:
BBjString type! SQL type Note : Not all sql types are supported, for example it does not make sense to declare a colum type as STRUCT. Setting the type will change the column common properties automatically like the filter, cell editor, ....
See Also:
https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html
setValueFormatterExpression
public void setValueFormatterExpression(BBjString expression!)
Create a GxExpression from string and set it as value formatter

Parameters:
BBjString expression! Javascript expression
setValueGetterExpression
public void setValueGetterExpression(BBjString expression!)
Create a GxExpression from string and set it as value getter

Parameters:
BBjString expression! Javascript expression
setValueParserExpression
public void setValueParserExpression(BBjString expression!)
Create a GxExpression from string and set it as value parser

Parameters:
BBjString expression! Javascript expression
setValueSetterExpression
public void setValueSetterExpression(BBjString expression!)
Create a GxExpression from string and set it as value setter

Parameters:
BBjString expression! Javascript expression
SORT_ASC
public static BBjString SORT_ASC()
Get sort direction constant

Returns:
BBjString asc
SORT_DESC
public static BBjString SORT_DESC()
Get sort direction constant

Returns:
BBjString desc

Class GxDefaultColumnDefinition

Field Summary

Method Summary

Field Detail

AggFunc!

AllowedAggFuncs!

AutoHeight!

CellClass!

CellClassRules!

CellEditor!

CellRenderer!

CellStyle!

ChartType!

CheckboxSelection!

ColumnSpanExpression!

DefaultDatesMask!

DefaultNumbersMask!

DefaultStringsMask!

DefaultTimesMask!

DefaultTimestampsMask!

Editable!

EditableExpression!

EnableFilter!

EnablePivot!

EnableRowGroup!

EnableValue!

Filter!

FilterValueGetterExpression!

FloatingFilter!

HeaderCheckboxSelection!

HeaderCheckboxSelectionFilteredOnly!

Hidden!

Icons!

LockPinned!

LockPosition!

LockVisible!

Mask!

MaxWidth!

MenuTabs!

MinWidth!

Pinned!

PinnedRowCellRenderer!

PivotIndex!

Resizable!

RowGroup!

RowGroupIndex!

RowSpanExpression!

Sort!

Sortable!

SuppressMenu!

SuppressMovable!

SuppressNavigable!

SuppressSizeToFit!

TooltipField!

TooltipValueGetterExpression!

Type!

UnSortIcon!

ValueFormatterExpression!

ValueGetterExpression!

ValueParserExpression!

ValueSetterExpression!

Width!

Method Detail

CHART_TYPE_CATEGORY

CHART_TYPE_EXCLUDED

CHART_TYPE_SERIES

COLUMN_GROUP_CLOSED

COLUMN_GROUP_OPENED

getAsJsonObject

getDefaultDatesMask

getDefaultNumbersMask

getDefaultStringsMask

getDefaultTimesMask

getDefaultTimestampsMask

getMask

PINNED_LEFT

PINNED_RIGHT

setAlignment

setAlignment

setAllowedAggFuncs