public class GxDefaultColumnDefinition extends GxColumnDefinition
The class represents the default column definition which the grid will use.
| Modifier and Type | Field and Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
BBjString | AggFunc!Name of function to use for aggregation. One of [sum, min, max, first, last].
| ||||||||
HashSet | AllowedAggFuncs!Aggregation functions allowed on this column eg ['sum', 'avg'].
| ||||||||
BBjNumber | AutoHeight!Set to true to have the grid calculate height of row based on contents of this column.
| ||||||||
ArrayList | CellClass!CSS class(es) to use for the cell.
| ||||||||
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.
| ||||||||
GxCellEditorInterface | CellEditor!CellEditor to use for this column
| ||||||||
GxRendererInterface | CellRenderer!A cellRenderer to use for this column
| ||||||||
JsonObject | CellStyle!A map of css values.
| ||||||||
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.
| ||||||||
BBjNumber | CheckboxSelection!Set to true to render a selection checkbox in the column.
| ||||||||
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 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:
| ||||||||
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.
| ||||||||
GxExpressionInterface | EditableExpression!An expression which determines whether the column is editable
or not. when this config is different than null , then the column
configuration | ||||||||
BBjNumber | EnableFilter!When true the filter is enabled, disabled otherwise
| ||||||||
BBjNumber | EnablePivot!Set to true if you want to be able to pivot by this column via the UI.
| ||||||||
BBjNumber | EnableRowGroup!Set to true if you want to be able to row group by this column via the UI.
| ||||||||
BBjNumber | EnableValue!Set to true if you want to be able to aggregate by this column via the UI.
| ||||||||
GxFilterInterface | Filter!The filter component to use for this column
| ||||||||
GxExpressionInterface | FilterValueGetterExpression!An Ag Grid expression which can be executed to get the value for filtering purposes.
| ||||||||
BBjNumber | Flex!Equivalent to flex-grow in CSS. When flex is set on one or more columns, any width value is ignored and instead the remaining free space in the grid is divided among flex columns in proportion to their flex value, so a column with flex: 2 will be twice the size as one with flex: 1.
| ||||||||
BBjNumber | FloatingFilter!When true enable the floating filter on this column , false otherwise
| ||||||||
BBjNumber | HeaderCheckboxSelection!Set to true to render a selection checkbox in the column's header.
| ||||||||
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.
| ||||||||
BBjNumber | Hidden!Set to true to make a column hidden by default.
| ||||||||
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.
The icons are set as follows:
| ||||||||
BBjNumber | LockPinned!Set to true block pinning column via the UI (API will still work).
| ||||||||
BBjNumber | LockPosition!Set to true to always have column displayed first.
| ||||||||
BBjNumber | LockVisible!Set to true block making column visible / hidden via the UI (API will still work).
| ||||||||
BBjString | Mask!The default column mask | ||||||||
BBjNumber | MaxWidth!Initial max width in pixels
| ||||||||
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
| ||||||||
BBjString | Pinned!Set to 'left' or 'right' to pin.
| ||||||||
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.
| ||||||||
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).
| ||||||||
BBjNumber | Resizable!Set to true to allow column to be resized.
| ||||||||
BBjNumber | RowGroup!Set to true To group rows by this column
| ||||||||
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).
| ||||||||
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 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 The option 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:
| ||||||||
BBjString | Sort!Set to 'asc' or 'desc' to sort by this column by default.
| ||||||||
BBjNumber | Sortable!Set to true to allow sorting on this column.
| ||||||||
BBjNumber | SuppressMenu!Set to true if no menu should be shown for this column header.
| ||||||||
BBjNumber | SuppressMovable!Set to true if you do not want this column to be movable via dragging.
| ||||||||
BBjNumber | SuppressNavigable!Set to true if this col is not navigable (ie cannot be tabbed into), otherwise false.
| ||||||||
BBjNumber | SuppressSizeToFit!Set to true if you want this columns width to be fixed during 'size to fit' operation.
| ||||||||
BBjString | TooltipField!The field of the tooltip to apply to the cell.
| ||||||||
GxExpressionInterface | TooltipValueGetterExpression!A Grid expression which can be executed to return the tooltip value to display for each cell.
| ||||||||
BBjNumber | Type!The Field Type.
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.
| ||||||||
GxExpressionInterface | ValueFormatterExpression!An Ag Grid expression which can be executed to format the value for display.
| ||||||||
GxExpressionInterface | ValueGetterExpression!An Ag Grid expression which can be executed before getting the value from your data for display
| ||||||||
GxExpressionInterface | ValueParserExpression!An Ag Grid expression which can be executed to parse the value for saving.
| ||||||||
GxExpressionInterface | ValueSetterExpression!An Ag Grid expression which can be executed before setting the value into your data for saving.
| ||||||||
BBjNumber | Width!Initial width in pixels
|
ColumnGroupShow!, HeaderClass!, HeaderTooltip!, Label!, SuppressFiltersToolPanel!, SuppressToolPanel!, ToolPanelClass! | 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 | setCellEditorSelector(BBjString expression!, HashMap editors!)Set a cell editor selector to use for this 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 |
COLUMN_GROUP_CLOSED, COLUMN_GROUP_OPENED, getAsJsonObject public BBjString AggFunc!Name of function to use for aggregation. One of [sum, min, max, first, last].
#Configuration
#ColumnsRenderer
public HashSet AllowedAggFuncs!Aggregation functions allowed on this column eg ['sum', 'avg'].
#Configuration
#ColumnsRenderer
public BBjNumber AutoHeight!Set to true to have the grid calculate height of row based on contents of this column.
#Configuration
#ColumnsRenderer
public ArrayList CellClass!CSS class(es) to use for the cell.
#Configuration
#ColumnsRenderer
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 |
public GxCellEditorInterface CellEditor!CellEditor to use for this column
#Configuration
#ColumnsRenderer
public GxRendererInterface CellRenderer!A cellRenderer to use for this column
#Configuration
#ColumnsRenderer
public JsonObject CellStyle!A map of css values.
#Configuration
#ColumnsRenderer
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.
public BBjNumber CheckboxSelection!Set to true to render a selection checkbox in the column.
#Configuration
#ColumnsRenderer
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:
#Configuration
#ColumnsRenderer.
GxExpressionpublic BBjString DefaultDatesMask!The default dates mask to use. by default %Dz.%Mz.%Yd
- Use Mask insteadpublic BBjString DefaultNumbersMask!The default numbers mask to use. by default null()
- Use Mask insteadpublic BBjString DefaultStringsMask!The default strings mask to use. by default null()
- Use Mask insteadpublic BBjString DefaultTimesMask!The default dates mask to use. by default %Dz.%Hz:%mz:%sz
- Use Mask insteadpublic BBjString DefaultTimestampsMask!The default timestamps mask to use. by default %Dz.%Mz.%Yl %Hz:%mz:%sz
- Use Mask insteadpublic BBjNumber Editable!Set to true if the column is editable, otherwise false.
#Configuration
#ColumnsRenderer
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
public BBjNumber EnableFilter!When true the filter is enabled, disabled otherwise
#Configuration
#ColumnsRenderer
public BBjNumber EnablePivot!Set to true if you want to be able to pivot by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
public BBjNumber EnableRowGroup!Set to true if you want to be able to row group by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
public BBjNumber EnableValue!Set to true if you want to be able to aggregate by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
public GxFilterInterface Filter!The filter component to use for this column
#Configuration
#ColumnsRenderer
public GxExpressionInterface FilterValueGetterExpression!An Ag Grid expression which can be executed to get the value for filtering purposes.
#Configuration
#ColumnsRenderer.
Gx.Expression.GxExpressionpublic BBjNumber Flex!Equivalent to flex-grow in CSS. When flex is set on one or more columns, any width value is ignored and instead the remaining free space in the grid is divided among flex columns in proportion to their flex value, so a column with flex: 2 will be twice the size as one with flex: 1.
#Configuration
#ColumnsRenderer
public BBjNumber FloatingFilter!When true enable the floating filter on this column , false otherwise
#Configuration
#ColumnsRenderer
public BBjNumber HeaderCheckboxSelection!Set to true to render a selection checkbox in the column's header.
#Configuration
#ColumnsRenderer
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
public BBjNumber Hidden!Set to true to make a column hidden by default.
#Configuration
#ColumnsRenderer
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
public BBjNumber LockPinned!Set to true block pinning column via the UI (API will still work).
#Configuration
#ColumnsRenderer
public BBjNumber LockPosition!Set to true to always have column displayed first.
#Configuration
#ColumnsRenderer
public BBjNumber LockVisible!Set to true block making column visible / hidden via the UI (API will still work).
#Configuration
#ColumnsRenderer
public BBjString Mask!The default column mask
public BBjNumber MaxWidth!Initial max width in pixels
#Configuration
#ColumnsRenderer
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.
GxColumn.MENU_TAB_FILTER() GxColumn.MENU_TAB_GENERAL() GxColumn.MENU_TAB_COLUMNS()public BBjNumber MinWidth!Initial min width in pixels
#Configuration
#ColumnsRenderer
public BBjString Pinned!Set to 'left' or 'right' to pin.
#Configuration
#ColumnsRenderer
PINNED_LEFT() PINNED_RIGHT()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
since v1.7.0, Setting this value won't affect the rendering. Please use the `CellRenderer` instead.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
public BBjNumber Resizable!Set to true to allow column to be resized.
#Configuration
#ColumnsRenderer
public BBjNumber RowGroup!Set to true To group rows by this column
#Enterprise
#Configuration
#ColumnsRenderer
Gx.Columns.EnableRowGroup!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
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:
#Configuration
#ColumnsRenderer.
GxExpressionpublic BBjString Sort!Set to 'asc' or 'desc' to sort by this column by default.
#Configuration
#ColumnsRenderer
SORT_DESC() SORT_ASC()public BBjNumber Sortable!Set to true to allow sorting on this column.
#Configuration
#ColumnsRenderer
public BBjNumber SuppressMenu!Set to true if no menu should be shown for this column header.
#Configuration
#ColumnsRenderer
public BBjNumber SuppressMovable!Set to true if you do not want this column to be movable via dragging.
#Configuration
#ColumnsRenderer
public BBjNumber SuppressNavigable!Set to true if this col is not navigable (ie cannot be tabbed into), otherwise false.
#Configuration
#ColumnsRenderer
public BBjNumber SuppressSizeToFit!Set to true if you want this columns width to be fixed during 'size to fit' operation.
#Configuration
#ColumnsRenderer
public BBjString TooltipField!The field of the tooltip to apply to the cell.
#Configuration
#ColumnsRenderer
public GxExpressionInterface TooltipValueGetterExpression!A Grid expression which can be executed to return the tooltip value to display for each cell.
#Configuration
#ColumnsRenderer.
GxExpressions.GxExpressionpublic 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.
https://docs.oracle.com/javase/8/docs/api/java/sql/Types.htmlpublic BBjNumber UnSortIcon!Set to true if you want the unsorted icon to be shown when no sort is applied to this column.
#Configuration
#ColumnsRenderer
public GxExpressionInterface ValueFormatterExpression!An Ag Grid expression which can be executed to format the value for display.
#Configuration
#ColumnsRenderer.
Gx.Expression.GxExpressionpublic GxExpressionInterface ValueGetterExpression!An Ag Grid expression which can be executed before getting the value from your data for display
#Configuration
#ColumnsRenderer.
Gx.Expression.GxExpressionpublic GxExpressionInterface ValueParserExpression!An Ag Grid expression which can be executed to parse the value for saving.
#Configuration
#ColumnsRenderer.
Gx.Expression.GxExpressionpublic GxExpressionInterface ValueSetterExpression!An Ag Grid expression which can be executed before setting the value into your data for saving.
#Configuration
#ColumnsRenderer.
Gx.Expression.GxExpressionpublic 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
setHidden()public static BBjString CHART_TYPE_CATEGORY()A constant which defines column chart category
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
public static BBjString CHART_TYPE_SERIES()A constant which defines column chart series
public static BBjString COLUMN_GROUP_CLOSED()A constant which defines the group state as opened
public static BBjString COLUMN_GROUP_OPENED()A constant which defines the group state as opened
public JsonObject getAsJsonObject()Convert the definition to Json Object
public BBjString getDefaultDatesMask() Use `getMask` insteadpublic BBjString getDefaultNumbersMask() Use `getMask` insteadpublic BBjString getDefaultStringsMask() Use `getMask` insteadpublic BBjString getDefaultTimesMask() Use `getDefaultTimesMask` insteadpublic BBjString getDefaultTimestampsMask() Use `getDefaultTimesMask` insteadpublic BBjString getMask()Get the column mask
public static BBjString PINNED_LEFT()Get pinned left constant
public static BBjString PINNED_RIGHT()Get pinned right constant
public void setAlignment(BBjNumber align!, BBjNumber alignHeader!)
Sets the default alignment for a column
BBjNumber align! The column alignmentBBjNumber alignHeader! when true the column's header will use the same alignment valid alignments: BBjGridExWidget.GRID_ALIGN_LEFT() BBjGridExWidget.GRID_ALIGN_CENTER() BBjGridExWidget.GRID_ALIGN_RIGHT()public void setAlignment(BBjNumber align!)
Sets the default alignment for a column
BBjNumber align! The column alignment valid alignments: BBjGridExWidget.GRID_ALIGN_LEFT() BBjGridExWidget.GRID_ALIGN_CENTER() BBjGridExWidget.GRID_ALIGN_RIGHT()public void setAllowedAggFuncs(BBjString funcs!)
Set the allowed aggregation functions allowed on this column
BBjString funcs! comma separated functionspublic void setBackColor(BBjColor color!)
Sets the background color of a column
BBjColor color! The color for the columnpublic void setBackColor(BBjString color!)
Sets the background color of a column
BBjColor color$ Valid CSS color https://developer.mozilla.org/en-US/docs/Web/CSS/color_valuepublic void setCellEditorSelector(BBjString expression!, HashMap editors!)
Set a cell editor selector to use for this column.
expression! Javascript expression to use to select the cell editoreditors! A set of possible cell editors to usepublic 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
mask! - The BBj date string or numeric mask. Use `setMask` insteadpublic void setColumnSpanExpression(BBjString expression!)
Create a GxExpression from string and set it as column span expression
BBjString expression! Javascript expressionpublic void setDefaultDatesMask(BBjString mask!)
Use `setMask` insteadpublic void setDefaultNumbersMask(BBjString mask!)
Use `setMask` insteadpublic void setDefaultStringsMask(BBjString mask!)
Use `setMask` insteadpublic void setDefaultTimesMask(BBjString mask!)
Use `setMask` insteadpublic void setDefaultTimestampsMask(BBjString mask!)
Use `setMask` insteadpublic void setEditableExpression(BBjString expression!)
Create a GxExpression from string and set it as editable expression
BBjString expression! Javascript expressionpublic void setForeColor(BBjColor color!)
Sets the foreground color for a column
BBjColor color! the color for the columnpublic void setForeColor(BBjString color!)
Sets the foreground color for a column
BBjString color$ Valid CSS color https://developer.mozilla.org/en-US/docs/Web/CSS/color_valuepublic void setHeaderAlignment(BBjNumber align!)
Sets the default alignment for a column's header
BBjNumber align! The column's header alignment valid alignments: BBjGridExWidget.GRID_ALIGN_LEFT() BBjGridExWidget.GRID_ALIGN_CENTER() BBjGridExWidget.GRID_ALIGN_RIGHT()public void setIcons(BBjString json!)
Set the grid icons
BBjString json! The icons as a json objectpublic 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
mask! - The BBj date string or numeric mask.public void setRowSpanExpression(BBjString expression!)
Create a GxExpression from string and set it as row span expression
BBjString expression! Javascript expressionpublic void setTooltipValueGetterExpression(BBjString expression!)
Create a GxExpression from string and set it as tooltip value getter
BBjString expression! Javascript expressionpublic void setType(BBjNumber type!)
Set the column type
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, .... https://docs.oracle.com/javase/8/docs/api/java/sql/Types.htmlpublic void setValueFormatterExpression(BBjString expression!)
Create a GxExpression from string and set it as value formatter
BBjString expression! Javascript expressionpublic void setValueGetterExpression(BBjString expression!)
Create a GxExpression from string and set it as value getter
BBjString expression! Javascript expressionpublic void setValueParserExpression(BBjString expression!)
Create a GxExpression from string and set it as value parser
BBjString expression! Javascript expressionpublic void setValueSetterExpression(BBjString expression!)
Create a GxExpression from string and set it as value setter
BBjString expression! Javascript expressionpublic static BBjString SORT_ASC()Get sort direction constant
public static BBjString SORT_DESC()Get sort direction constant