GxOptions.bbj

rem /**
rem  * The package exports a collection of option interfaces which are used to configure the grid and the columns
rem  */
rem package GxOptions
rem /**
rem  * This file is part of the BBjGridExWidget plugin.
rem  * (c) Basis Europe <eu@basis.com>
rem  *
rem  * For the full copyright and license information, please view the LICENSE
rem  * file that was distributed with this source code.
rem  */
use java.util.ArrayList
use com.google.gson.Gson
use com.google.gson.JsonParser
use com.google.gson.JsonObject
use com.google.gson.JsonArray
use com.basiscomponents.db.ResultSet
use ::BBjGridExWidget/BBjGridExWidget.bbj::BBjGridExWidget
use ::BBjGridExWidget/GxLanguageManager.bbj::GxLanguageManager
use ::BBjGridExWidget/GxSidebar.bbj::GxSidebar
use ::BBjGridExWidget/GxSidebar.bbj::GxDefaultSidebar
use ::BBjGridExWidget/GxSidebar.bbj::GxFiltersToolpanel
use ::BBjGridExWidget/GxStatusBar.bbj::GxStatusBar
use ::BBjGridExWidget/GxContextMenu.bbj::GxContextMenu
use ::BBjGridExWidget/GxContextMenu.bbj::GxDefaultContextMenu
use ::BBjGridExWidget/GxColumns.bbj::GxDefaultColumnDefinition
use ::BBjGridExWidget/GxColumns.bbj::GxAutoGroupColumn
use ::BBjGridExWidget/GxColumns.bbj::GxDefaultColumnGroup
use ::BBjGridExWidget/GxExpressions.bbj::GxExpressionInterface
use ::BBjGridExWidget/GxExpressions.bbj::GxExpression
use ::BBjGridExWidget/GxLogger.bbj::GxLogger
rem /**
rem  * The class defines the common boolean options shared between components which
rem  * manipulate booleans
rem  *
rem  * @author Hyyan Abo Fakher
rem  */
class public GxOptionsBoolean
    rem /**
    rem  * A hashset of what is considered true
    rem  */
    field public JsonArray PossibleTrueValues! = new JsonArray()
    rem /**
    rem  * A hashset of what is considered false
    rem  */
    field public JsonArray PossibleFalseValues! = new JsonArray()
    rem /**
    rem  * Construct new GxOptionsBoolean
    rem  */
    method public GxOptionsBoolean()
        rem fill predefined false values
        #getPossibleFalseValues().add("0")
        #getPossibleFalseValues().add("false")
        #getPossibleFalseValues().add("n")
        #getPossibleFalseValues().add("no")
        rem fill predefined yes values
        #getPossibleTrueValues().add("1")
        #getPossibleTrueValues().add("true")
        #getPossibleTrueValues().add("y")
        #getPossibleTrueValues().add("yes")
    methodend
    rem /**
    rem  * Transform the options object to json
    rem  *
    rem  * @return JsonObject
    rem  */
    method public JsonObject getAsJsonObject()
        declare JsonObject json!

        json! = new JsonObject()
        json!.        add("booleanTrueValue", iff(#getPossibleTrueValues().size() > 0, #getPossibleTrueValues(), listEmpty!) ,err=*next)
        json!.        add("booleanFalseValue", iff(#getPossibleFalseValues().size() > 0, #getPossibleFalseValues(), listEmpty!) ,err=*next)
        methodret json!
    methodend

classend
rem /**
rem  * The class defines the common date time options shared between components which
rem  * manipulate dates , times & timestamps
rem  *
rem  * @author Hyyan Abo Fakher
rem  */
class public GxOptionsDateTime
    rem /**
    rem  * Enable / disable time selection
    rem  */
    field public BBjNumber EnableTime! = 1
    rem /**
    rem  * Enable / disable time 24 format.
    rem  */
    field public BBjNumber Enable24HR! = 1
    rem /**
    rem  * Enable / disable seconds selection
    rem  */
    field public BBjNumber EnableSeconds! = 0
    rem /**
    rem  * Enable / disable Calendar input.
    rem  */
    field public BBjNumber EnableCalendar! = 1
    rem /**
    rem  * Set disableMobile to true to always use the non-native picker.
    rem  */
    field public BBjNumber DisableMobile! = 1
    rem /**
    rem  * Enables display of week numbers in calendar.
    rem  */
    field public BBjNumber EnableWeekNumber! = 0
    rem /**
    rem  * The Date mask for calender input
    rem  */
    field public BBjString Mask! = "%Y/%Mz/%Dz %Hz:%mz:%sz"
    rem /**
    rem  * Initial value of the hour element.
    rem  */
    field public BBjNumber DefaultHour! = 12
    rem /**
    rem  * Initial value of the minute element.
    rem  */
    field public BBjNumber DefaultMinute! = 0
    rem /**
    rem  * A valid iso 8601 datetime which defines the max allowed value in the
    rem  * calender
    rem  */
    field public BBjString Max! = null()
    rem /**
    rem  * A valid iso 8601 datetime which defines the min allowed value in the
    rem  * calender
    rem  */
    field public BBjString Min! = null()
    rem /**
    rem  * A valid expression which validates the datetime
    rem  */
    field public GxExpressionInterface FormatterExpression! = null()
    rem /**
    rem  * The locale used to format and display dates and times. default to the System settings
    rem  */
    field public BBjString Locale! = null()
    rem /**
    rem  * When true then accepts direct user's input from the input field.
    rem  *
    rem  * @deprecated since version 0.101.0, GxOptionsDateTime.AllowInput is deprecated. Direct input is always disabled.
    rem  */
    field public BBjNumber AllowInput! = 1
    rem /**
    rem  * @deprecated since version 0.101.0, GxOptionsDateTime.setAllowInput(BBjNumber allow!) is deprecated. Direct input is always disabled.
    rem  */
    method public void setAllowInput(BBjNumber allow!)
        GxLogger.warn("GxOptions","since version 0.101.0, GxOptionsDateTime.setAllowInput(BBjNumber allow!) is deprecated. Direct input is always disabled.")
    methodend
    rem /**
    rem  * @deprecated since version 0.101.0, GxOptionsDateTime.getAllowInput() is deprecated. Direct input is always disabled.
    rem  */
    method public BBjNumber getAllowInput()
        GxLogger.warn("GxOptions","since version 0.101.0, GxOptionsDateTime.getAllowInput() is deprecated. Direct input is always disabled.")
        methodret 0
    methodend
    rem /**
    rem  * Create a GxExpression from string and set it as FormatterExpression
    rem  *
    rem  * @param BBjString expression! Javascript expression
    rem  */
    method public void setFormatterExpression(BBjString expression!)
        #FormatterExpression! = new GxExpression(expression!)
    methodend
    rem /**
    rem  * Set the initial value of the hour element.
    rem  *
    rem  * @param hour! - if Enable24HR is true , the hour must be between 0 & 24 , otherwise between 0 & 12
    rem  *
    rem  * @return void
    rem  */
    method public void setDefaultHour(BBjNumber hour!)
        isEnable24HR! = #getEnable24HR().booleanValue()

        if(isEnable24HR!) then
            if(!(hour! >= 0 AND hour! <= 24))
                throw "Invalid Default Hour, Value must be in range 0 ~ 24", 256
            FI
        else
            if(!(hour! >= 0 AND hour! <= 12))
                throw "Invalid Default Hour, Value must be in range 0 ~ 12", 256
            FI
        FI

        #DefaultHour! = hour!
    methodend
    rem /**
    rem  * Set the initial value of the minute element.
    rem  *
    rem  * @param minute! - value in range 0 ~ 60
    rem  *
    rem  * @return void
    rem  */
    method public void setDefaultMinute(BBjNumber minute!)
        if(!(minute! >= 0 AND minute! <= 60))
            throw "Invalid Default Minute, Value must be in range 0 ~ 60", 256
        FI

        #DefaultMinute! = minute!
    methodend
    rem /**
    rem  * Enable / disable time 24 format.
    rem  *
    rem  * @param hour! - 1 for enabled , 0 for disabled
    rem  *
    rem  * @return void
    rem  */
    method public void setEnable24HR(BBjNumber enabled!)
        hour! = #getDefaultHour()

        if(enabled!) then
            if(!(hour! >= 0 AND hour! <= 24))
                throw "Invalid Default Hour, Value must be in range 0 ~ 24", 256
            FI
        else
            if(!(hour! >= 0 AND hour! <= 12))
                throw "Invalid Default Hour, Value must be in range 0 ~ 12", 256
            FI
        FI

        #Enable24HR! = enabled!
    methodend
    rem /**
    rem  * Transform the options object to json
    rem  *
    rem  * @return JsonObject
    rem  */
    method public JsonObject getAsJsonObject()
        declare JsonObject json!

        json! = new JsonObject()
        json!.addProperty("dateTimeEnableTime" , #getEnableTime().booleanValue(),err=*next)
        json!.addProperty("dateTimeEnable24HR" , #getEnable24HR().booleanValue(),err=*next)
        json!.addProperty("dateTimeEnableSeconds" , #getEnableSeconds().booleanValue(),err=*next)
        json!.addProperty("dateTimeEnableCalendar" , #getEnableCalendar().booleanValue(),err=*next)
        json!.addProperty("dateTimeDisableMobile", #getDisableMobile().booleanValue(),err=*next)
        json!.addProperty("dateTimeEnableWeekNumber", #getEnableWeekNumber().booleanValue(),err=*next)
        json!.addProperty("dateTimeDefaultHour", #getDefaultHour().longValue(),err=*next)
        json!.addProperty("dateTimeDefaultMinute", #getDefaultMinute().longValue(),err=*next)
        json!.addProperty("dateTimeMask", #getMask(),err=*next)
        json!.addProperty("dateTimeMax", #getMax(),err=*next)
        json!.addProperty("dateTimeMin", #getMin(),err=*next)
        json!.addProperty("dateTimeLocale", #getLocale(),err=*next)
        json!.addProperty("dateTimeFormatter",#getFormatterExpression().toString(),err=*next)
        methodret json!
    methodend

classend
rem /**
rem  * The class holds the grid configuration properties
rem  *
rem  * Every property and method has one or more tag attached.
rem  *
rem  * The following is the meaning for each tag :<br><br>
rem  *
rem  *
rem  * <table border="1" cellpadding="10">
rem  *  <tbody>
rem  *      <tr>
rem  *          <td><strong>&nbsp;Enterprise</strong></td>
rem  *          <td>The property/method is used only with the enterprise version. using it without having a valid license will<br />be ignored.</td>
rem  *      </tr>
rem  *      <tr>
rem  *          <td>&nbsp;<strong>Configuration</strong></td>
rem  *          <td>Properties and methods which are tagged with&nbsp;this tag are used to configure the grid before it is rendered on the client.<br />Changing these properties or calling these methods won't affect&nbsp;the grid which is displayed on the client.<br />In order to reflect your changes on the client, you need to re-render the whole grid <br />or re-render the column definition once again.</td>
rem  *      </tr>
rem  *      <tr>
rem  *          <td>&nbsp;<strong>API</strong></td>
rem  *          <td>Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh.</td>
rem  *      </tr>
rem  *      <tr>
rem  *          <td><strong>&nbsp;ColumnsRenderer</strong></td>
rem  *          <td>Changing this property or calling this method after the first render require columns re-render using <i>updateColumns()</i> method</td>
rem  *      </tr>
rem  *      <tr>
rem  *          <td><strong>&nbsp;GridRenderer</strong></td>
rem  *          <td>Changing this property or calling this method after the first render require full re-render using <i>render()</i> method</td>
rem  *      </tr>
rem  *  </tbody>
rem  * </table>
rem  * @author Hyyan Abo Fakher
rem  */
class public GxOptions
    rem /**
    rem  * Contains column properties all columns will inherit.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public GxDefaultColumnDefinition DefaultColumnDefinition! = new GxDefaultColumnDefinition()
    rem /**
    rem  * Contains column group properties all column groups will inherit.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public GxDefaultColumnGroup DefaultColumnGroupDefinition! = new GxDefaultColumnGroup()
    rem /**
    rem  * Suppresses auto-sizing columns for columns. In other words, double-clicking a column header's edge will not auto-size.Default is false
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressAutoSize! = null()
    rem /**
    rem  * How many pixels to add to a column width after the auto-sizing calculation. The default is 4 pixels. Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber AutoSizePadding! = null()
    rem /**
    rem  * If true, the ag-column-moving class is not added to the grid while columns are moving. In the default themes, this transpires to no animation for moving columns.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressColumnMoveAnimation! = null()
    rem /**
    rem  * Set to true to suppress column moving. In other words, set to true to make the columns fixed position.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressMovableColumns! = null()
    rem /**
    rem  * Set to true to show the 'no sort' icon.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber UnSortIcon! = null()
    rem /**
    rem  * Set to true to suppress multi-sort when the user shift-clicks a column header.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressMultiSort! = null()
    rem /**
    rem  * Set to true to always show the column menu button, rather than only showing when the mouse is over the column header.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressMenuHide! = null()
    rem /**
    rem  * Allows specifying the group 'auto column' if you are not happy with the default.
    rem  * If grouping, this column def is included as the first column definition in the grid.
    rem  * If not grouping, this column is not included.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public GxAutoGroupColumn AutoGroupColumnDefinition! = new GxAutoGroupColumn()
    rem /**
    rem  * Set to true to suppress column events being raised when state is changed throw the API methods
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressSetColumnStateEvents! = null()
    rem /**
    rem  * Set to true to specify that the sort should take into account accented characters, if this feature is turned on the sort will perform slower.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber AccentedSort! = null()
    rem /**
    rem  * Set to true to suppress sorting of un-sorted data to match original row data
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressMaintainUnsortedOrder! = null()
    rem /**
    rem  * Allow selection of multiple cells or rows. When true enable multiselection, disable otherwise
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber MultipleSelection! = 0
    rem /**
    rem  * Set to true to allow multiple rows to be selected with a single click.
    rem  *
    rem  * E.g. if you click select one row, then click select another row, the first row will keep it's selection.
    rem  * Clicking a selected row in this mode will deselect the row.
    rem  * This is useful for touch devices where ctrl and shift clicking is
    rem  * not an option.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  * <br>
    rem  * <b>Note</b> that Despite the setting name, it works when MultipleSelection is enabled or disabled
    rem  */
    field public BBjNumber RowMultiSelectWithClick! = 0
    rem /**
    rem  * Set to true or false. If true, then rows will be deselected if you
    rem  * hold down ctrl + click the row. Normal behaviour with the grid disallows
    rem  * deselection of nodes (ie once a row is selected, it remains selected until
    rem  * another row is selected in its place).
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *  
    rem  *  @deprecated since v1.7.0 - use `SuppressRowDeselection` instead
    rem  */
    field public BBjNumber RowDeselection! = 0

    rem /**
    rem  * If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */    
    field public BBjNumber SuppressRowDeselection! = 1    
    rem /**
    rem  * If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressRowClickSelection! = 0
    rem /**
    rem  * Set to true to enable Single Click Editing for cells, to start editing with a single click.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SingleClickEdit! = null()
    rem /**
    rem  * Set to true so that neither single or double-click starts editing.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressClickEdit! = null()
    rem /**
    rem  * Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *
    rem  * @see BBjGridExWidget.GRID_EDITTYPE_ROW()
    rem  * @see BBjGridExWidget.GRID_EDITTYPE_CELL()
    rem  */
    field public BBjString EditType! = BBjGridExWidget.GRID_EDITTYPE_CELL()
    rem /**
    rem  * Set this to true to stop cell editing when grid loses focus. The default is the grid stays editing until focus goes onto another cell. For inline (non-popup) editors only.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber StopEditingWhenGridLosesFocus! = null()
    rem /**
    rem  *  Set to true to have Enter key move focus to the cell below if not editing. The default is Enter key starts editing the currently focused cell.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber EnterMovesDown! = null()
    rem /**
    rem  * Set to true to have Enter key move focus to the cell below after Enter is pressed while editing. The default is editing will stop and focus will remain on the editing cell.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber EnterMovesDownAfterEdit! = null()
    rem /**
    rem  * The height for the row containing the column label header. If not specified the default is 25px.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber HeaderHeight! = null()
    rem /**
    rem  * The height for the rows containing header column groups. If not specified, it uses headerHeight
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupHeaderHeight! = null()
    rem /**
    rem  * The height for the row containing the floating filters. If not specified the default is 20px.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber FloatingFiltersHeight! = null()
    rem /**
    rem  * The height for the row containing the columns when in pivot mode. If not specified, it uses headerHeight.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber PivotHeaderHeight! = null()
    rem /**
    rem  * The height for the row containing header column groups when in pivot mode. If not specified, it uses groupHeaderHeight
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber PivotGroupHeaderHeight! = null()
    rem /**
    rem  * If grouping, set to true or false (default is false).
    rem  * If true, a group row will span all columns across the entire width of the table.
    rem  * If false, the cells will be rendered as normal and you will have the opportunity to include
    rem  * a grouping column (normally the first on the left) to show the group
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupUseEntireRow! = null()
    rem /**
    rem  * If grouping, set to the number of levels to expand by default. Eg 0 for none, 1 first level only, etc. Default is 0 (expand none). Set to -1 for expand everything
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupDefaultExpanded! = null()
    rem /**
    rem  * If true, the grid will not swap in the grouping column when grouping is enabled.
    rem  * Use this if you want complete control on the column displayed and don't want the grids help.
    rem  * In other words, you already have a column in your column definitions that is responsible for displaying the groups
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupSuppressAutoColumn! = null()
    rem /**
    rem  * If using auto column, set to true to have each group in its own column separate column, eg if group by Country then Year, two auto columns will be created, one for country and one for year
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupMultiAutoColumn! = null()
    rem /**
    rem  * If true, the group row won't be displayed and the groups will be expanded by default with no ability to expand / contract the groups. Useful when you want to just 'group' the rows, but not add parent group row to each group
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *  
    rem  *  @deprecated since v1.7.0 - There is no replacement for this functionality.
    rem  */
    field public BBjNumber GroupSuppressRow! = null()
    rem /**
    rem  * When true, selecting a group will have the impact of selecting all its children
    rem  * When false, then the group is selectable independently of the child nodes.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  * <br>
    rem  * <b>Note</b>That this settings has no effect if MultipleSelection is disabled
    rem  */
    field public BBjNumber GroupSelectsChildren! = null()
    rem /**
    rem  * If grouping, whether to show a group footer when the group is expanded.
    rem  * If true, then by default, the footer will contain aggregate data (if any)
    rem  * when shown and the header will be blank.
    rem  * When closed, the header will contain the aggregate data regardless
    rem  * of this setting (as footer is hidden anyway).
    rem  * This is handy for 'total' rows, that are displayed below the data when
    rem  * the group is open, and alongside the group when it is closed
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupIncludeFooter! = null()
    rem /**
    rem  * Set to true to show a 'grand' total group footer across all groups.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupIncludeTotalFooter! = null()
    rem /**
    rem  * If true, and showing footer, aggregate data will be displayed at both the header and footer levels always.
    rem  * This stops the possibly undesirable behaviour of the header details 'jumping' to the footer on expand.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupSuppressBlankHeader! = null()
    rem /**
    rem  * If using groupSelectsChildren, then only the children that pass the current filter will get selected
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupSelectsFiltered! = null()
    rem /**
    rem  * Set to true to collapse groups that only have one child.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupRemoveSingleChildren! = null()
    rem /**
    rem  * Set to true to collapse lowest level groups that only have one child.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupRemoveLowestSingleChildren! = null()
    rem /**
    rem  * Set to true to hide parents that are open. When used with multiple columns for showing groups, it can give more pleasing user experience
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber GroupHideOpenParents! = null()
    rem /**
    rem  * When to show the 'row group panel' (where you drag rows to group) at the top. Default is never. Set to either 'always' or 'onlyWhenGrouping'
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *
    rem  * @see BBjGridExWidget.GRID_GROUPPANEL_SHOW_HIDDEN()
    rem  * @see BBjGridExWidget.GRID_GROUPPANEL_SHOW_VISIBLE()
    rem  * @see BBjGridExWidget.GRID_GROUPPANEL_SHOW_ONGROUPING()
    rem  */
    field public BBjString RowGroupPanelShow! = BBjGridExWidget.GRID_GROUPPANEL_SHOW_ONGROUPING()
    rem /**
    rem  * Set to true to enable pivot mode
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#API</small></b>
    rem  */
    field public BBjNumber PivotMode! = null()
    rem /**
    rem  * When to show the 'pivot panel' (where you drag rows to pivot) at the top.
    rem  * Default is never. Set to either 'always' or 'onlyWhenPivoting'.
    rem  * Note that the pivot panel will never show if pivotMode is off.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *
    rem  * @see GRID_GROUPPANEL_SHOW_HIDDEN()
    rem  * @see GRID_GROUPPANEL_SHOW_VISIBLE()
    rem  * @see GRID_GROUPPANEL_SHOW_ONGROUPING()
    rem  */
    field public BBjNumber PivotPanelShow! = null()
    rem /**
    rem  * When true, if you set new data into the grid and have groups open, the grid will keep groups open if they exist in the new dataset
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber RememberGroupStateWhenNewData! = null()
    rem /**
    rem  * When true, column headers won't include the aggFunc, eg 'sum(Bank Balance)' will just be 'Bank Balance'.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressAggFuncInHeader! = null()
    rem /**
    rem  * When true, the aggregations won't be computed for root node of the grid
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressAggAtRootLevel! = null()
    rem /**
    rem  * If true, then row group, pivot and value aggregation will be read only from the UI.
    rem  * The grid will display what values are used for each, but will not allow the use to change the selection
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#API</small></b>
    rem  */
    field public BBjNumber FunctionsReadOnly! = null()
    rem /**
    rem  * By default when a column is un-grouped, it is made visible.
    rem  * This property stops the column becoming visible again when un-grouping.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressMakeVisibleAfterUnGroup! = null()
    rem /**
    rem  * Set to true to always show the vertical scrollbar.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber AlwaysShowVerticalScroll! = null()
    rem /**
    rem  * Set to true to never show the horizontal scroll.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressHorizontalScroll! = null()
    rem /**
    rem  * When true, the grid will not scroll to the top when new row data is provided.
    rem  * Use this if you don't want the default behaviour of scrolling to the top every time you load new data.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressScrollOnNewData! = null()
    rem /**
    rem  * When true, the grid will not use animation frames when drawing rows while scrolling.
    rem  * Use this if the grid is working fast enough that you don't need animations frame and you don't want the grid to flicker.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressAnimationFrame! = null()
    rem /**
    rem  * Icons to use inside the grid instead of the grid's default icons.
    rem  *
    rem  * The icons can either be set on the grid options (all icons) or on the column definition (all except group).
    rem  * If defined in both the grid options and column definitions, the column definition will get used.
    rem  * This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for
    rem  * specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons
    rem  * and just the simple arrow for other columns.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>.
    rem  * <br>
    rem  * The icons are set as follows:
    rem  * <pre>
    rem  * <code>
    rem *      // column header items
    rem *      menu
    rem *      filter
    rem *      columns
    rem *      sortAscending
    rem *      sortDescending
    rem *      sortUnSort
    rem *
    rem *      // expand / contract row group
    rem *      groupExpanded
    rem *      groupContracted
    rem *
    rem *      // expand / contract column group
    rem *      columnGroupOpened
    rem *      columnGroupClosed
    rem *
    rem *      // tool panel column group open / close
    rem *      columnSelectOpen
    rem *      columnSelectClosed
    rem *
    rem *      // row checkbox selection and tool panel column selection
    rem *      checkboxChecked
    rem *      checkboxUnchecked
    rem *      checkboxIndeterminate
    rem *
    rem *      // tool panel column selection, when read only (ie disabled checkboxes)
    rem *      checkboxCheckedReadOnly
    rem *      checkboxUncheckedReadOnly
    rem *      checkboxIndeterminateReadOnly
    rem *
    rem *      // when moving columns
    rem *      columnMovePin // when column is to the left, before it gets pinned
    rem *      columnMoveAdd // when adding a column
    rem *      columnMoveHide // when removing a column
    rem *      columnMoveMove // when moving a column
    rem *      columnMoveLeft // when moving and scrolling left
    rem *      columnMoveRight // when moving and scrolling right
    rem *      columnMoveGroup // when about to drop into group panel
    rem *      columnMoveValue // when about to drop into value panel
    rem *      columnMovePivot // when about to drop into pivot panel
    rem *      dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it
    rem *
    rem *      // menu
    rem *      menuPin // beside the column pin menu item
    rem *      menuValue // beside the column value menu item
    rem *      menuAddRowGroup // beside the column row group menu item
    rem *      menuRemoveRowGroup // beside the column row group menu item
    rem *      clipboardCopy // beside the copy to clipboard menu item
    rem *      clipboardPaste // beside the paste from clipboard menu item
    rem *
    rem *      // column drop panels
    rem *      rowGroupPanel // beside where to drop columns for row group
    rem *      pivotPanel // beside where to drop columns for pivot
    rem *      valuePanel // beside where to drop columns for value
    rem  * </code>
    rem  * </pre>
    rem  */
    field public JsonObject Icons! = new JsonObject()
    rem /**
    rem  * Default Row Height in pixels. Default is 25 pixels.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#API</small></b>
    rem  */
    field public BBjNumber RowHeight! = null()
    rem /**
    rem  * Set to true to enable Row Animation.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber AnimateRows! = null()
    rem /**
    rem  * Property to set style for all rows. Set to an object of key (style names) and values (style values)
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public JsonObject RowStyle! = new JsonObject()
    rem /**
    rem  * Property to set CSS class for all rows
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public ArrayList RowClass!  =  new ArrayList()
    rem /**
    rem  * Rules which can be applied to include certain CSS classes for rows.
    rem  *
    rem  * These rules are provided as a JavaScript map where the keys are class names and the values are expressions that
    rem  * if evaluated to true, the class gets used. The expression is a string which is treated as a shorthand for a
    rem  * function by the grid.<br><b><small>#Configuration</small></b><br><b><small>#GridRenderer</small></b>.
    rem  *
    rem  * The expression has the following attributes available: <br>
    rem  *
    rem  * <table border="1" cellpadding="10">
    rem  *    <tbody>
    rem  *        <tr>
    rem  *            <td><strong>&nbsp;rowIndex</strong></td>
    rem  *            <td>&nbsp;Maps the current row index</td>
    rem  *        </tr>
    rem  *        <tr>
    rem  *            <td>&nbsp;<strong>data</strong></td>
    rem  *            <td>&nbsp;Mapped from the DataRow</td>
    rem  *        </tr>
    rem  *        <tr>
    rem  *            <td>&nbsp;<strong>ctx</strong></td>
    rem  *            <td>&nbsp;The grid client context</td>
    rem  *        </tr>
    rem  *    </tbody>
    rem  * </table>
    rem  */
    field public JsonObject RowClassRules! = new JsonObject()
    rem /**
    rem  * Set to true to not highlight rows by adding the ag-row-hover CSS class.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressRowHoverHighlight! = null()
    rem /**
    rem  * If true, then middle clicks will result in 'click' events for cell and row. Otherwise the browser will use middle click to scroll the grid.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressMiddleClickScrolls! = null()
    rem /**
    rem  * Set to true to use the browser's default tooltip instead of using Ag-Grid's Tooltip Component.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber EnableBrowserTooltips! = null()
    rem /**
    rem  * The delay in milliseconds that it takes for tooltips to show up once an element is hovered.
    rem  *
    rem  * <b>Note:</b> This property does not work if enableBrowserTooltips is true.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber TooltipShowDelay! = null()
    rem /**
    rem  * If true, when you drag a column out of the grid (eg to the group zone) the column is not hidden.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressDragLeaveHidesColumns! = null()
    rem /**
    rem  * Set to true to operate grid in RTL (Right to Left) mode.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber EnableRtl! = null()
    rem /**
    rem  * Set to true to not show context menu. Use if you don't want to use the default 'right click' context menu.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressContextMenu! = null()
    rem /**
    rem  * Disables touch support (but does not remove the browsers efforts to simulate mouse events on touch).
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressTouch! = null()
    rem /**
    rem  * When true enables the floating filters, disable otherwise
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *
    rem  * @deprecated enabling/disabling the floatingFilter on the Options level is deprecated. Use `GxColumn.FloatingFilter` on the column level instead.
    rem  */
    field public BBjNumber EnableFloatingFilter! = 0
    rem /**
    rem  * When true, A selection box will be shown on the first column
    rem  * When false, no checkbox will be displayed.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  * <br>
    rem  * <b>Note</b> The first column can override this settings when it sets the <i>CheckboxSelection</i> to true
    rem  */
    field public BBjNumber ShowSelectionCheckbox! = 0
    rem /**
    rem  * When true, selection box will be show on the first column's header
    rem  * When false, no checkbox will be displayed.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  * <br>
    rem  * <b>Note</b> The first column can override this settings when it sets the <i>tHeaderCheckboxSelection</i> to true
    rem  * <b>Note</b> This option will ignore multi row selection option by default so it is always enabled
    rem  */
    field public BBjNumber ShowHeaderSelectionCheckbox! = 0
    rem /**
    rem  * Defines how users can move between rows using arrow keys.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *
    rem  * @see BBjGridExWidget.GRID_NAVIGATION_BEHAVIOUR_NEXT_ROW()
    rem  * @see BBjGridExWidget.GRID_NAVIGATION_BEHAVIOUR_NEXT_CELL()
    rem  */
    field public BBjString NavigationBehavior! = BBjGridExWidget.GRID_NAVIGATION_BEHAVIOUR_NEXT_ROW()
    rem /**
    rem  * The grid context menu
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public GxContextMenu ContextMenu! = new GxDefaultContextMenu()
    rem /**
    rem  * By default when new columns are loaded into the grid, the following properties
    rem  * (Order, Aggregation Function, Width, Pivot, Row Group, Pinned ) are not used
    rem  *
    rem  * To change this behaviour and have column attributes above take effect each time the grid updates the columns,
    rem  * then set this option to true
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *
    rem  * @deprecated use `GxOptions.ImmutableColumns` instead
    rem  */
    field public BBjNumber DeltaColumnMode! = 0
    rem /**
    rem  * Puts the grid into Immutable Column mode, so that setting new columns keeps column state.
    rem  * Default: false
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber ImmutableColumns! = 0
    rem /**
    rem  * Disables the 'loading' overlay.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressLoadingOverlay! = null()
    rem /**
    rem  * Disables the 'no rows' overlay.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressNoRowsOverlay! = null()
    rem /**
    rem  * Provide a template for 'loading' overlay if not happy with the default one.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjString OverlayLoadingTemplate! = null()
    rem /**
    rem  * Provide a template for 'no rows' overlay if not happy with the provided.
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjString OverlayNoRowsTemplate! = null()
    rem /**
    rem  * Enable / Disable Tree Data mode
    rem  * <br><b><small>#Enterprise</small></b>
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber TreeData! = null()
    rem /**
    rem  * A string template which will be compiled on the client to return an array
    rem  * for the tree hierarchy.
    rem  *
    rem  * <br><b><small>#Enterprise</small></b>
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjString DataPathTemplate! = null()
    rem /**
    rem  * Set to true to enable Range Selection
    rem  *
    rem  * <br><b><small>#Enterprise</small></b>
    rem  * <br><b><small>#Configuration</small></b>
    rem  */
    field public BBjNumber EnableRangeSelection! = null()
    rem /**
    rem  * Enable / disable one range selection even if ctrl key is held down
    rem  *
    rem  * <br><b><small>#Enterprise</small></b>
    rem  * <br><b><small>#Configuration</small></b>
    rem  */
    field public BBjNumber SuppressMultiRangeSelection! = null()
    rem /**
    rem  * If true, cells won't be selectable. This means cells will not get keyboard focus when you click on them.
    rem  * Default: false
    rem  */
    field public BBjNumber SuppressCellSelection! = null()
    rem /**
    rem  * Set to true to enable charting
    rem  *
    rem  * <br><b><small>#Enterprise</small></b>
    rem  * <br><b><small>#Configuration</small></b>
    rem  */
    field public BBjNumber EnableCharts! = null()
    rem /**
    rem  * Set to true so that the grid doesn't virtualize the columns. S
    rem  * o if you have 100 columns, but only 10 visible due to scrolling, all 100 will always be rendered.
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressColumnVirtualisation! = null()
    rem /**
    rem  * Set this to true to skip the headerName when autoSize is called by default
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SkipHeaderOnAutoSize! = null()
    rem /**
    rem  * Uses CSS top instead of CSS transform for positioning rows.
    rem  *
    rem  * Useful if the transform function is causing issues such as used in row spanning.
    rem  * Default: false
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  */
    field public BBjNumber SuppressRowTransform! = null()
    rem /**
    rem  * When true , then the user will be able to sort by multiple columns by holding down the `ctrl`
    rem  * key (or Command key on Apple) while clicking the column header. By default this action is possible using the `shit` key.
    rem  */
    field public BBjNumber UseCtrlForMultiSort! = 0
    rem /**
    rem  * The ResultSet instance which contains the top pinned rows
    rem  */
    field public ResultSet PinnedTopRows! = new ResultSet()
    rem /**
    rem  * The ResultSet instance which contains the bottom pinned rows
    rem  */
    field public ResultSet PinnedBottomRows! = new ResultSet()
    rem /**
    rem  * Set the grid theme
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#API</small></b>
    rem  */
    field public BBjString Theme! = BBjGridExWidget.GRID_THEME_ALPINE()
    rem /**
    rem  * The grid language manager
    rem  */
    field public GxLanguageManager LanguageManager! = new GxLanguageManager()
    rem /**
    rem  * The grid sidebar
    rem  */
    field public GxSidebar Sidebar! = null()
    rem /**
    rem  * The grid statusbar
    rem  */
    field public GxStatusBar Statusbar! = null()
    rem /**
    rem  * A json object which is used as context to configure the grid and it various components on the client
    rem  */
    field public JsonObject ClientContext! = new JsonObject()
    rem /**
    rem  * Disable default constructor
    rem  */
    method private GxOptions()
    methodend
    rem /**
    rem  * Construct new GxOptions instance
    rem  *
    rem  * @param BBjGridExWidget widget! widget instance
    rem  */
    method public GxOptions(BBjGridExWidget widget!)
        #setSidebar(new GxDefaultSidebar(widget!))
        #setStatusbar(new GxStatusBar(widget!))
    methodend
    rem /**
    rem  * Sets the default column width for all columns
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#ColumnsRenderer</small></b>
    rem  *
    rem  * @param BBjNumber width! The column width
    rem  */
    method public void setColumnWidth(BBjNumber width!)
        #getDefaultColumnDefinition().setWidth(Width!)
    methodend
    rem /**
    rem  * Enable / Disable column Filters.This method updates only the default column definition,
    rem  * columns can still override this setting individually.
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#ColumnsRenderer</small></b>
    rem  *
    rem  * @param BBjNumber enable! When true enable on added columns, disable otherwise
    rem  * @param BBjNumber enableFiltersToolpanel! When true the filters toolpanel will be enabled in the sidebar, disabled otherwise
    rem  */
    method public void setEnableFilter(BBjNumber enable! , BBjNumber enableFiltersToolpanel!)
        #getDefaultColumnDefinition().setEnableFilter(enable!)
        toolpanels! = #getSidebar().getToolpanels()

        if enableFiltersToolpanel! = 0 then
            toolpanels!.remove(GxFiltersToolpanel.getId(),err=*next)
        else
            if(toolpanels!.containsKey(GxFiltersToolpanel.getId()) = 0) then
                toolpanels!.put(GxFiltersToolpanel.getId() , new GxFiltersToolpanel())
            FI
        FI
    methodend
    rem /**
    rem  * Enable / Disable column Filters.This method updates only the default column definition,
    rem  * columns can still override this setting individually.
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#ColumnsRenderer</small></b>
    rem  *
    rem  * @param BBjNumber enable! When true enable on added columns, disable otherwise
    rem  */
    method public void setEnableFilter(BBjNumber enable!)
        #setEnableFilter(enable! , enable!)
    methodend
    rem /**
    rem  * Enable / disable column editing
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#ColumnsRenderer</small></b>
    rem  *
    rem  * @param BBjNumber editable! When true all columns will be editable, otherwise disable editing
    rem  */
    method public void setEditable(BBjNumber editable!)
        #getDefaultColumnDefinition().setEditable(editable!)
    methodend
    rem /**
    rem  * Set the default label used when a new group is created
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#ColumnsRenderer</small></b>
    rem  *
    rem  * @param BBjString label! The column label
    rem  */
    method public void setGroupColumnLabel(BBjString label!)
        #getAutoGroupColumnDefinition().setLabel(Label!)
    methodend
    rem /**
    rem  * Enable / disable showing row counts beside group labels
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#ColumnsRenderer</small></b>
    rem  *
    rem  * @param BBjNumber enabled! When true show row counts, hide otherwise
    rem  */
    method public void setShowGroupChildCount(BBjNumber enabled!)
        renderer! = #getAutoGroupColumnDefinition().getCellRenderer()
        renderer!.setSuppressCount(!enabled! , err=*next)
    methodend
    rem /**
    rem  * Enable/ disable checkbox selection on groups
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#ColumnsRenderer</small></b>
    rem  *
    rem  * @param BBjNumber enabled! When true enable checkbox selection, disable otherwise
    rem  */
    method public void setShowGroupSelectionCheckbox(BBjNumber enabled!)
        renderer! = #getAutoGroupColumnDefinition().getCellRenderer()
        renderer!.setCheckbox(enabled! , err=*next)
    methodend
    rem /**
    rem  * Set the grid icons
    rem  *
    rem  * <br><b><small>#Configuration</small></b>
    rem  * <br><b><small>#GridRenderer</small></b>
    rem  *
    rem  * @param BBjString json! The icons as a json object
    rem  */
    method public void setIcons(BBjString json!)
        declare JsonParser parser!

        parser! = new JsonParser()
        #setIcons(parser!.parse(json!).getAsJsonObject())
    methodend
    rem /**
    rem  * Enable/disable DeltaColumn Mode
    rem  *
    rem  * @param BBjNumber enabled!  true to enable , false to disable
    rem  *
    rem  * @deprecated Columns are immutable by default.
    rem  */
    method public void setImmutableColumns(BBjNumber enabled!)
        GxLogger.warn("since version 1.7.0, BBjGridExWidget.setImmutableColumns(BBjNumber enabled!) is deprecated. Columns are immutable by default.")
        #ImmutableColumns! = 1
    methodend      
    rem /**
    rem  * Get DeltaColumn Mode value
    rem  *
    rem  * @return BBjNumber true when enabled , false otherwise
    rem  *
    rem  * @deprecated Columns are immutable by default.
    rem  */
    method public BBjNumber getDeltaColumnMode()
        methodret 1
    methodend      
    rem /**
    rem  * Enable/disable DeltaColumn Mode
    rem  *
    rem  * @param BBjNumber enabled!  true to enable , false to disable
    rem  *
    rem  * @deprecated use `GxOptions.setImmutableColumns` instead
    rem  */
    method public void setDeltaColumnMode(BBjNumber enabled!)
        #setImmutableColumns(enabled!)
    methodend
    rem /**
    rem  * Get DeltaColumn Mode value
    rem  *
    rem  * @return BBjNumber true when enabled , false otherwise
    rem  *
    rem  * @deprecated use `GxOptions.getImmutableColumns` instead
    rem  */
    method public BBjNumber getDeltaColumnMode()
        methodret #getImmutableColumns()
    methodend
    rem /**
    rem  * @deprecated since v1.7.0 - use `GxOptions.setSuppressRowDeselection(BBjNumber value!)` instead
    rem  */
    method public void setRowDeselection(BBjNumber value!)      
      GxLogger.warn("since version 1.7.0, GxOptions.setRowDeselection(BBjNumber value!) is deprecated. Use GxOptions.setSuppressRowDeselection(BBjNumber value!) instead.")
      #RowDeselection! = value!
      #SuppressRowDeselection! = !value!
    methodend
    rem /**
    rem  *  @deprecated since v1.7.0 - use `GxOptions.setSuppressRowDeselection(BBjNumber value!)` instead
    rem  */    
    method public BBjNumber getRowDeselection()      
      GxLogger.warn("since version 1.7.0, GxOptions.getRowDeselection() is deprecated. use GxOptions.getSuppressRowDeselection() instead.")
      methodret #RowDeselection!
    methodend      
    rem /**
    rem  * Set a result set of pinned rows on top
    rem  *
    rem  * @param ResultSet rs! A ResultSet instance
    rem  */
    method public void setPinnedTopRows(ResultSet rs!)
        #PinnedTopRows! = rs!
        rs!.createIndex()
    methodend
    rem /**
    rem  * Get the top pinned rows as json String
    rem  *
    rem  * @return BBjString the top pinned row as json string
    rem  */
    method public BBjString getPinnedTopRowsAsJson()
        rows! = #getPinnedTopRows()
        result! = "[]"

        if(rows! <> null())
            result! = rows!.toJson(1 , "__ROW_INDEX")
        fi

        methodret result!
    methodend
    rem /**
    rem  * Get the top pinned rows as Json Array
    rem  *
    rem  * @return JsonArray the top pinned row as Json Array
    rem  */
    method public JsonArray getPinnedTopRowsAsJsonArray()
        parser! = new JsonParser()
        methodret parser!.parse(#getPinnedTopRowsAsJson()).getAsJsonArray()
    methodend
    rem /**
    rem  * Set a result set of pinned rows on bottom
    rem  *
    rem  * @param ResultSet rs! A ResultSet instance
    rem  */
    method public void setPinnedBottomRows(ResultSet rs!)
        #PinnedBottomRows! = rs!
        rs!.createIndex()
    methodend
    rem /**
    rem  * Get the bottom pinned rows as json String
    rem  *
    rem  * @return BBjString the bottom pinned row as json string
    rem  */
    method public BBjString getPinnedBottomRowsAsJson()
        rows! = #getPinnedBottomRows()
        result! = "[]"

        if(rows! <> null())
            result! = rows!.toJson(1 , "__ROW_INDEX")
        fi

        methodret result!
    methodend
    rem /**
    rem  * Get the bottom pinned rows as Json Array
    rem  *
    rem  * @return JsonArray the bottom pinned row as Json Array
    rem  */
    method public JsonArray getPinnedBottomRowsAsJsonArray()
        parser! = new JsonParser()
        methodret parser!.parse(#getPinnedBottomRowsAsJson()).getAsJsonArray()
    methodend
    rem /**
    rem  * Build the grid json configuration object
    rem  *
    rem  * @return JsonObject The grid options as JsonObject
    rem  */
    method public JsonObject getAsJsonObject()
        declare JsonObject options!

        comma$=","
        dot$="."
        a$=opts

        if ( AND ( a$(3,1), $02$ ) = $02$) then
            comma$=a$(5,1)
            dot$=a$(6,1)
        FI

        options! = new JsonObject()
        rem Data And Row Models
        rem ===========================
        options!.        add("pinnedTopRowData",#getPinnedTopRowsAsJsonArray(), err=*next)
        options!.        add("pinnedBottomRowData",#getPinnedBottomRowsAsJsonArray(), err=*next)
        rem Columns options
        rem ===========================
        options!.        add("defaultColDef",#getDefaultColumnDefinition().getAsJsonObject() , err=*next)
        options!.        add("defaultColGroupDef",#getDefaultColumnGroupDefinition().getAsJsonObject(), err=*next)
        options!.addProperty("suppressAutoSize",#getSuppressAutoSize().booleanValue(), err=*next)
        options!.addProperty("autoSizePadding",#getAutoSizePadding().longValue(), err=*next)
        options!.addProperty("suppressColumnMoveAnimation",#getSuppressColumnMoveAnimation().booleanValue(), err=*next)
        options!.addProperty("suppressMovableColumns",#getSuppressMovableColumns().booleanValue(), err=*next)
        options!.addProperty("unSortIcon",#getUnSortIcon().booleanValue(), err=*next)
        options!.addProperty("suppressMultiSort",#getSuppressMultiSort().booleanValue(), err=*next)
        options!.addProperty("suppressMenuHide",#getSuppressMenuHide().booleanValue(), err=*next)
        options!.addProperty("suppressColumnStateEvents",#getSuppressSetColumnStateEvents().booleanValue(), err=*next)
        options!.addProperty("immutableColumns",#getImmutableColumns().booleanValue(), err=*next)
        options!.addProperty("skipHeaderOnAutoSize",#getSkipHeaderOnAutoSize().booleanValue(), err=*next)
        rem Sort & Filter options
        rem ===========================
        options!.addProperty("accentedSort",#getAccentedSort().booleanValue(), err=*next)
        options!.addProperty("suppressMaintainUnsortedOrder",#getSuppressMaintainUnsortedOrder().booleanValue(), err=*next)
        rem Selection options
        rem ===========================
        options!.addProperty("rowSelection",iff(#getMultipleSelection() = 1 , "multiple" ,"single"), err=*next)
        options!.addProperty("rowMultiSelectWithClick",#getRowMultiSelectWithClick().booleanValue() , err=*next)
        options!.addProperty("suppressRowDeselection",#getSuppressRowDeselection().booleanValue())
        options!.addProperty("suppressRowClickSelection",#getSuppressRowClickSelection().booleanValue())
        options!.addProperty("enableRangeSelection",#getEnableRangeSelection().booleanValue(), err=*next)
        options!.addProperty("suppressMultiRangeSelection",#getSuppressMultiRangeSelection().booleanValue(), err=*next)
        options!.addProperty("suppressCellSelection",#getSuppressCellSelection().booleanValue(), err=*next)
        rem Editing Options
        rem ===========================
        options!.addProperty("singleClickEdit",#getSingleClickEdit().booleanValue(), err=*next)
        options!.addProperty("suppressClickEdit",#getSuppressClickEdit().booleanValue(), err=*next)
        options!.addProperty("enableGroupEdit",0); rem not really sure how this works and there are not docs
        options!.addProperty("editType",#getEditType(), err=*next )
        options!.addProperty("stopEditingWhenGridLosesFocus",#getStopEditingWhenGridLosesFocus().booleanValue(), err=*next )
        options!.addProperty("enterMovesDown",#getEnterMovesDown().booleanValue(), err=*next )
        options!.addProperty("enterMovesDownAfterEdit",#getEnterMovesDownAfterEdit().booleanValue(), err=*next )
        rem Headers options
        rem ===========================
        options!.addProperty("headerHeight",#getHeaderHeight().longValue(), err=*next )
        options!.addProperty("groupHeaderHeight",#getGroupHeaderHeight().longValue(), err=*next )
        options!.addProperty("floatingFiltersHeight",#getFloatingFiltersHeight().longValue(), err=*next )
        options!.addProperty("pivotHeaderHeight",#getPivotHeaderHeight().longValue(), err=*next )
        options!.addProperty("pivotGroupHeaderHeight",#getPivotGroupHeaderHeight().longValue(), err=*next )

        if(#getUseCtrlForMultiSort())
            options!.addProperty("multiSortKey","ctrl", err=*next)
        fi
        rem Grouping & Pivoting
        rem ===========================
        options!.addProperty("groupUseEntireRow",#getGroupUseEntireRow().booleanValue() , err=*next)
        options!.addProperty("groupDefaultExpanded",#getGroupDefaultExpanded().longValue(), err=*next)
        options!.        add("autoGroupColumnDef",#getAutoGroupColumnDefinition().getAsJsonObject(), err=*next)
        options!.addProperty("groupMultiAutoColumn",#getGroupMultiAutoColumn().booleanValue() , err=*next)
        options!.addProperty("groupSelectsChildren",#getGroupSelectsChildren().booleanValue(), err=*next)
        options!.addProperty("groupIncludeFooter",#getGroupIncludeFooter().booleanValue(), err=*next)
        options!.addProperty("groupIncludeTotalFooter",#getGroupIncludeTotalFooter().booleanValue(), err=*next)
        options!.addProperty("groupSuppressBlankHeader",#getGroupSuppressBlankHeader().booleanValue(), err=*next)
        options!.addProperty("groupSelectsFiltered",#getGroupSelectsFiltered().booleanValue(), err=*next)
        options!.addProperty("groupRemoveSingleChildren",#getGroupRemoveSingleChildren().booleanValue(), err=*next)
        options!.addProperty("groupRemoveLowestSingleChildren",#getGroupRemoveLowestSingleChildren().booleanValue(), err=*next)
        options!.addProperty("groupHideOpenParents",#getGroupHideOpenParents().booleanValue(), err=*next)
        options!.addProperty("rowGroupPanelShow",#getRowGroupPanelShow() , err=*next)
        options!.addProperty("pivotMode",#PivotMode!.booleanValue(), err=*next)
        options!.addProperty("rowGroupPanelShow",#getPivotPanelShow(), err=*next)
        options!.addProperty("rememberGroupStateWhenNewData",#getRememberGroupStateWhenNewData().booleanValue(), err=*next)
        options!.addProperty("suppressAggFuncInHeader",#getSuppressAggFuncInHeader().booleanValue(), err=*next)
        options!.addProperty("suppressAggAtRootLevel",#getSuppressAggAtRootLevel().booleanValue(), err=*next)
        options!.addProperty("functionsReadOnly",#getFunctionsReadOnly().booleanValue(), err=*next)
        options!.addProperty("suppressMakeVisibleAfterUnGroup",#getSuppressMakeVisibleAfterUnGroup().booleanValue(), err=*next)
        rem Scrolling Options
        rem ===========================
        options!.addProperty("alwaysShowVerticalScroll",#getAlwaysShowVerticalScroll().booleanValue(), err=*next)
        options!.addProperty("suppressHorizontalScroll",#getSuppressHorizontalScroll().booleanValue(), err=*next)
        options!.addProperty("suppressScrollOnNewData",#getSuppressScrollOnNewData().booleanValue(), err=*next)
        options!.addProperty("suppressAnimationFrame",#getSuppressAnimationFrame().booleanValue(), err=*next)
        options!.addProperty("suppressColumnVirtualisation",#getSuppressColumnVirtualisation().booleanValue(), err=*next)
        rem Rendering & Styling options
        rem ===========================
        options!.        add("icons",iff(#getIcons().entrySet().size() <> 0 , #getIcons(), null()), err=*next)
        options!.addProperty("rowHeight",#getRowHeight().longValue(), err=*next)
        options!.addProperty("animateRows",#getAnimateRows().booleanValue(), err=*next)
        options!.        add("rowStyle",iff(#getRowStyle().entrySet().size() <> 0 , #getRowStyle() , null()), err=*next)
        options!.addProperty("rowClass" , iff(#getRowClass().size() <> 0 ,new Gson().toJson(#getRowClass()), listIsEmpty!) ,err=*next)
        options!.        add("rowClassRules", iff(#getRowClassRules().entrySet().size() <> 0 , #getRowClassRules() , null()),err=*next)
        options!.addProperty("suppressRowHoverHighlight",#getSuppressRowHoverHighlight().booleanValue(), err=*next)
        rem Localization
        rem ===========================
        options!.addProperty("localeText" , #getLanguageManager().getLanguageKeys())
        rem Overlays
        rem ===========================
        options!.addProperty("suppressLoadingOverlay",#getSuppressLoadingOverlay().booleanValue(), err=*next)
        options!.addProperty("suppressNoRowsOverlay",#getSuppressNoRowsOverlay().booleanValue(), err=*next)
        options!.addProperty("overlayLoadingTemplate",#getOverlayLoadingTemplate(), err=*next)
        options!.addProperty("overlayNoRowsTemplate",#getOverlayNoRowsTemplate(), err=*next)
        rem Charts
        rem ===========================
        options!.addProperty("enableCharts",#getEnableCharts().booleanValue(), err=*next)
        rem Tree Data
        rem ===========================
        options!.addProperty("treeData",#getTreeData().booleanValue(), err=*next)
        rem Miscellaneous
        rem ===========================
        options!.addProperty("suppressMiddleClickScrolls",#getSuppressMiddleClickScrolls().booleanValue() , err=*next)
        options!.addProperty("enableBrowserTooltips",#getEnableBrowserTooltips().booleanValue() , err=*next)
        options!.addProperty("suppressDragLeaveHidesColumns",#getSuppressDragLeaveHidesColumns().booleanValue() , err=*next)
        options!.addProperty("tooltipShowDelay",#getTooltipShowDelay().doubleValue() , err=*next)
        options!.addProperty("enableRtl",#getEnableRtl().booleanValue() , err=*next)
        options!.addProperty("suppressContextMenu",#getSuppressContextMenu().booleanValue() , err=*next)
        options!.addProperty("allowContextMenuWithControlKey", iff(INFO(3,6)="5" , 0 , 1))
        options!.addProperty("statusBar",#getStatusbar().toString(), err=*next)
        options!.addProperty("suppressTouch",#getSuppressTouch().booleanValue() , err=*next)
        options!.addProperty("suppressPropertyNamesCheck",BBjGridExWidget.getDebug().booleanValue() , err=*next)
        options!.addProperty("floatingFilter",#getEnableFloatingFilter())
        options!.addProperty("suppressRowTransform",#getSuppressRowTransform().booleanValue() , err=*next)
        options!.        add("sideBar",#getSidebar().getAsJsonObject(), err=*next)
        rem Context
        rem ===========================
        context! = #getClientContext()
        context!.addProperty("numberGroupSep",comma$, err=*next)
        context!.addProperty("numberDecimalSep",dot$, err=*next)
        context!.addProperty("locale",#getLanguageManager().getLanguage(), err=*next)
        context!.addProperty("contextMenu",#ContextMenu!.toString(), err=*next)
        context!.addProperty("showSelectionCheckbox",#ShowSelectionCheckbox!, err=*next)
        context!.addProperty("showHeaderSelectionCheckbox",#ShowHeaderSelectionCheckbox!, err=*next)
        context!.addProperty("contextMenu",#ContextMenu!.toString(), err=*next)
        context!.addProperty("navigateToNextCell",Iff(#NavigationBehavior! = BBjGridExWidget.GRID_NAVIGATION_BEHAVIOUR_NEXT_ROW() , 1 , 0), err=*next)
        context!.addProperty("getDataPath",#getDataPathTemplate(), err=*next)
        context!.addProperty("platform",str(info(3,6)), err=*next)
        options!.add("context",context!)
        methodret options!
    methodend

classend