BaseGrid

BaseGrid

new BaseGrid()

Description:

  • Grid Object

Source:

Extends

Members

(readonly) attributes

Description:

  • Returns the object attributes

Source:
Inherited From:

Returns the object attributes

collapsed :boolean

Description:

  • The panel collapsed mode if it is collapsed or expanded

Source:
Inherited From:

The panel collapsed mode if it is collapsed or expanded

Type:
  • boolean

(readonly) container

Description:

  • The swat object top-level parent, usually a window or dialog object

Source:
Inherited From:

The swat object top-level parent, usually a window or dialog object

(readonly) controller :*

Description:

  • The object's legacy API controller. Used for JavaScript calls from TypeScript.

Source:
Inherited From:

The object's legacy API controller. Used for JavaScript calls from TypeScript.

Type:
  • *
Example
window.akioma.myFunction(eventSource.controller);

(readonly) dataSource :DataSource

Description:

  • The linked business entity to this form

Source:

The linked business entity to this form

Type:

defaultFilterLoader :Promise

Description:

  • Promise for waiting on default filter to be loaded in Grid

Source:

Promise for waiting on default filter to be loaded in Grid

Type:
  • Promise

(readonly) dynObject :*

Description:

  • The object's legacy API dynObject. Used for JavaScript calls from TypeScript.

Source:
Inherited From:

The object's legacy API dynObject. Used for JavaScript calls from TypeScript.

Type:
  • *
Example
window.akioma.myFunction(eventSource.dynObject);

enabled :boolean

Description:

  • The grid enabled mode

Source:

The grid enabled mode

Type:
  • boolean

event

Description:

  • Event payload

Source:

Event payload

(readonly) gridColNames :Array.<string>

Description:

  • An array containing the grid columns names

Source:

An array containing the grid columns names

Type:
  • Array.<string>

height :number

Description:

  • The panel height

Source:
Inherited From:

The panel height

Type:
  • number

hidden :boolean

Description:

  • The panel hidden mode if it is hidden or shown

Source:
Inherited From:

The panel hidden mode if it is hidden or shown

Type:
  • boolean

(readonly) name :string

Description:

  • The object name

Source:
Inherited From:

The object name

Type:
  • string

panelHeaderMenusLoader

Description:

  • Promise loader for header menus

Source:

Promise loader for header menus

(readonly) parent :SwatObject

Description:

  • The swat object direct parent

Source:
Inherited From:

The swat object direct parent

Type:

(readonly) screen

Description:

  • The swat object inner screen (container)

Source:
Inherited From:

The swat object inner screen (container)

title :string

Description:

  • The panel title

Source:
Inherited From:

The panel title

Type:
  • string

(readonly) topScreen

Description:

  • The swat object top screen (container), usually a window or dialog object

Source:
Inherited From:

The swat object top screen (container), usually a window or dialog object

type :string

Description:

  • Used for retriving the object type

Source:
Inherited From:

Used for retriving the object type

Type:
  • string

visible :boolean

Description:

  • The panel visible mode (opposite of hidden)

Source:
Inherited From:

The panel visible mode (opposite of hidden)

Type:
  • boolean

width :number

Description:

  • The panel width

Source:
Inherited From:

The panel width

Type:
  • number

(readonly) window :Window

Description:

  • The swat object top-level window object. Note: Desktop windows are windows not frames so the window property of a child object in a desktop window will return the desktop window unlike the container property which will return the main desktop window for the application. Note: If the object is a window then it will returns itself.

Source:
Inherited From:

The swat object top-level window object. Note: Desktop windows are windows not frames so the window property of a child object in a desktop window will return the desktop window unlike the container property which will return the main desktop window for the application. Note: If the object is a window then it will returns itself.

Type:

Methods

FilterGo()

Description:

  • Method for filtering on Grid

Source:

addClass(selector, classes) → {void}

Description:

  • Adding classes while keeping the old ones

Source:
Parameters:
Name Type Description
selector string
classes array

array of class names
Returns:
Type
void

addPanelMessage(msg) → {number}

Description:

  • Add an panel message and return the index of the message

Source:
Inherited From:
Parameters:
Name Type Description
msg PanelMessage

The panel message

Properties
Name Type Description
text string

The panel message text
type string

The panel message type i.e. info, warning, error, success
Returns:
Type
number

clearCustomState(name) → {void}

Description:

  • Remove a custom state from a controller

Source:
Inherited From:
Parameters:
Name Type Description
name string
Returns:
Type
void

clearHasChanges()

Description:

  • Clears hasChanges (dirty state)

Source:
Overrides:

clearPanelMessages() → {void}

Description:

  • Remove all panel messages from a controller

Source:
Inherited From:
Returns:
Type
void

collapse() → {void}

Description:

  • Collapse a panel

Source:
Inherited From:
Returns:
Type
void

decrementChanges() → {void}

Description:

  • Decrement has changes on a form with 1

Source:
Inherited From:
Returns:
Type
void

disableAutoFocus() → {void}

Description:

  • Disables autoFocus on a grid after a data refresh

Source:
Returns:
Type
void

disableColumnFilters()

Description:

  • Method for disabling the column filters in a grid

Source:

disableContextMenuItem(itemCode)

Description:

  • Method for disabling a given context menu item

Source:
Parameters:
Name Type Description
itemCode

Name of the item to disable

disableContextMenuItems()

Description:

  • Method for disabling all context menu items

Source:

disableDragAndDrop()

Description:

  • Disables drag and drop on a grid

Source:

enableAutoFocus() → {void}

Description:

  • Enables autoFocus on a grid after a data refresh

Source:
Returns:
Type
void

enableColumnFilters()

Description:

  • Method for enabling the column filters in a grid

Source:

enableContextMenuItem(itemCode)

Description:

  • Method for enabling a given context menu item

Source:
Parameters:
Name Type Description
itemCode

Name of the item to enable

enableContextMenuItems()

Description:

  • Method for enabling all context menu items

Source:

enableDragAndDrop()

Description:

  • Enables drag and drop on a grid

Source:

expand() → {void}

Description:

  • Expand a panel

Source:
Inherited From:
Returns:
Type
void

fixSize(fixWidth, fixHeight) → {void}

Description:

  • Method for setting the fixed width/height of a panel level object

Source:
Inherited From:
Parameters:
Name Type Description
fixWidth boolean

'says' to fix the width of the cell (optional)
fixHeight boolean

'says' to fix the height of the cell (optional)
Returns:
Type
void

forceShow()

Description:

  • Forces the object to show. For example, if the object is in a collapsed panel, the panel is expanded or in an unselected tab, selects the object tab etc.

Source:
Inherited From:

getCellAkEvent(rowId, colIndex) → {object|null}

Description:

  • Gets the akEvent for a cell. The akEvent contains the currentValue and lastValue of the cell.

Source:
Parameters:
Name Type Description
rowId string
colIndex number
Returns:
Type
object | null

getCellByRowAndCol(rowId, colIndex) → {*}

Description:

  • Expose the cell of the grid by a given rowID and colIndex

Source:
Parameters:
Name Type Description
rowId string
colIndex number
Returns:
Type
*

getColIndexById(name) → {number}

Description:

  • Method for getting the column index by id

Source:
Parameters:
Name Type Description
name string

The grid column name
Returns:
Type
number

getDataValue(name) → {*}

Description:

  • Helper method for getting a grid column data value. Equivalent to grid.getGridCol('mygridCol').dataValue.

Source:
Parameters:
Name Type Description
name string

The grid column name
Returns:
Type
*

getGridCol(name) → {GridCol}

Description:

  • Gets a grid column object

Source:
Parameters:
Name Type Description
name string

The grid column name (case-insensitive)
Returns:
Type
GridCol

getLabel(name) → {string}

Description:

  • Helper method for getting a grid column label. Equivalent to grid.getGridCol('mygridcol').label.

Source:
Parameters:
Name Type Description
name string

The grid column name (case-insensitive)
Returns:
Type
string
Description:

  • Gets the object's link source or target object

Source:
Inherited From:
Example
myForm.getLink("DISPLAY:SRC")
Parameters:
Name Type Description
link string

The link name separated by ":" and SRC/TRG points e.g. "DATA:TRG"
Returns:
Type
SwatObject
Description:

  • Gets the object's link source or target objects

Source:
Inherited From:
Example
myDataSource.getLinks("DISPLAY:TRG")
Parameters:
Name Type Description
link string

The link name separated by ":" and SRC/TRG points e.g. "DATA:TRG"
Returns:

[]

Type
SwatObject

getLookupKeyValue(name) → {*}

Description:

  • Helper method for getting a grid column lookup key value. Equivalent to grid.getGridCol('mygridCol').lookupKeyValue.

Source:
Parameters:
Name Type Description
name string

The grid col name
Returns:
Type
*

getObject(name) → {SwatObject}

Description:

  • Gets a descendant object by name

Source:
Inherited From:
Parameters:
Name Type Description
name string

The object name (case-insensitive)
Returns:
Type
SwatObject

getPanelFilterState(name)

Description:

  • Method for reading filter panel manu states

Source:
Parameters:
Name Type Description
name string

Name of panel menu

getScreenValue(name) → {*}

Description:

  • Helper method for getting a grid column screen value. Equivalent to grid.getGridCol('mygridCol').screenValue.

Source:
Parameters:
Name Type Description
name string

The grid column name
Returns:
Type
*

getSelectedRecords()

Description:

  • Method for getting currently selected records of Grid

Source:

handleProperties(selector, styles, remove) → {void}

Description:

  • Method for handling a class, id or any propertie

Source:
Parameters:
Name Type Description
selector string
styles *

object where the key is property name and value is the value of the propertie. in case where remove is true, property values should be empty string.
remove boolean

true for remove, false or undefined for add
Returns:
Type
void

hasChanges() → {boolean}

Description:

  • Returns if there are changes in the object or its descendents

Source:
Inherited From:
Example
Object.hasChanges()
Returns:
Type
boolean

hasDragAndDropEnabled() → {boolean}

Description:

  • Checks if drag and drop is enabled on a grid

Source:
Returns:
Type
boolean

hasErrors() → {boolean}

Description:

  • Returns if there are changes in the object or its descendents

Source:
Inherited From:
Returns:
Type
boolean

hideContextMenuItem(itemCode)

Description:

  • Method for hiding a given context menu item

Source:
Parameters:
Name Type Description
itemCode

Name of the item to hide

hideContextMenuItems()

Description:

  • Method for hiding all context menu items

Source:

hideHeader() → {void}

Description:

  • Hide the header from a panel

Source:
Inherited From:
Returns:
Type
void

hidePanelMenuButton(name)

Description:

  • Hides a panelMenu button

Source:
Inherited From:
Parameters:
Name Type Description
name string

The button name (SCL menuFunctionCode/menuStructureCode)

isEnabled() → {boolean}

Description:

  • Method for checking if the grid is enabled

Source:
Returns:
Type
boolean

isPanelHeaderMenusLoaded() → {boolean}

Description:

  • Method to check if panel Menus are loaded

Source:
Returns:
Type
boolean

progressOff(bPauseProgressOff) → {void}

Description:

  • Method for setting the progress cursor off for this particular object

Source:
Inherited From:
Parameters:
Name Type Description
bPauseProgressOff boolean

A value of true will stop all the future progressOff method calls for this element until reset
Returns:
Type
void

progressOn(bPauseProgressOff) → {void}

Description:

  • Method for setting the progress cursor on for this particular object

Source:
Inherited From:
Parameters:
Name Type Description
bPauseProgressOff boolean

A value of true will stop all the future progressOff method calls for this element until reset
Returns:
Type
void

removeClass(selector, classes)

Description:

  • Removing classes while keeping the old ones

Source:
Parameters:
Name Type Description
selector string
classes array

array of class names

removePanelMessage(id) → {void}

Description:

  • Remove a panel message from a controller by the given id

Source:
Inherited From:
Parameters:
Name Type Description
id number
Returns:
Type
void

resetAndRefresh()

Description:

  • Reset filters to default and refresh the grid

Source:

setCustomState(name, optionsopt) → {void}

Description:

  • Set a custom state on a controller

Source:
Inherited From:
Parameters:
Name Type Attributes Description
name string
options object <optional>
Returns:
Type
void

setDragAndDropBehaviour(dragDropBehaviour)

Description:

  • Sets the drag and drop behaviour on a grid

Source:
Parameters:
Name Type Description
dragDropBehaviour

'default' | 'copy' | 'move' Type of drag and drop behaviour

setEditable(editable)

Description:

  • Method for enabling or disabling the grid

Source:
Parameters:
Name Type Description
editable

True for enabling the grid, false for disabling it

setHasChanges(dirtyStateStatus, primaryKey) → {*}

Description:

  • Sets the dirty state for a record identified by the primaryKey

Source:
Parameters:
Name Type Description
dirtyStateStatus boolean

True or False
primaryKey string

The value corresponding to the KeyField attribute in the dataSource; used to uniquely identify the record for which to set the new value; Optional
Returns:
Type
*

setHeight(height) → {void}

Description:

  • Set panel height

Source:
Inherited From:
Parameters:
Name Type Description
height number
Returns:
Type
void

setLabel(name, label)

Description:

  • Helper method for setting a grid column label by the name

Source:
Parameters:
Name Type Description
name string

The grid column name (case-insensitive)
label string

The new label

setMinHeight(height) → {void}

Description:

  • Set panel min height

Source:
Inherited From:
Parameters:
Name Type Description
height number
Returns:
Type
void

showContextMenuItem(itemCode)

Description:

  • Method for showing a given context menu item

Source:
Parameters:
Name Type Description
itemCode

Name of the item to show

showContextMenuItems()

Description:

  • Method for showing all context menu items

Source:

showHeader() → {void}

Description:

  • Show the header from a panel

Source:
Inherited From:
Returns:
Type
void

showPanelMenuButton(name)

Description:

  • Shows a panelMenu button

Source:
Inherited From:
Parameters:
Name Type Description
name string

The button name (SCL menuFunctionCode/menuStructureCode)