GridCol

GridCol

new GridCol()

Description:

  • Grid Column Base Class

Source:

Extends

Members

(readonly) attributes

Description:

  • Returns the object attributes

Source:
Inherited From:

Returns the object attributes

(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 grid column linked datasource

Source:

The grid column linked datasource

Type:

(readonly) dataValue :*

Description:

  • The linked datasource field value

Source:

The linked datasource field value

Type:
  • *

(readonly) dynObject :*

Description:

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

Source:
Overrides:

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

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

(readonly) enabled :boolean

Description:

  • The enabled property for the column

Source:

The enabled property for the column

Type:
  • boolean

(readonly) enabled

Description:

  • The isEnabled property for the column

Source:

The isEnabled property for the column

(readonly) grid :Grid

Description:

  • The grid column grid object

Source:

The grid column grid object

Type:

(readonly) hidden :boolean

Description:

  • The grid column hidden mode (opposite of visible)

Source:

The grid column hidden mode (opposite of visible)

Type:
  • boolean

ignoreValidateEvent :boolean

Description:

  • Returns whether should ignore validation event or not.

Source:

Returns whether should ignore validation event or not.

Type:
  • boolean

ignoreValidateEvent

Description:

  • Sets whether should ignore validation event or not.

Source:

Sets whether should ignore validation event or not.

(readonly) label :string

Description:

  • The grid column label

Source:

The grid column label

Type:
  • string

lookupDataSource

Description:

  • The grid column lookup datasource

Source:

The grid column lookup datasource

(readonly) lookupKeyValue :*

Description:

  • The grid column lookup key value

Source:

The grid column lookup key value

Type:
  • *

(readonly) name :string

Description:

  • The object name

Source:
Inherited From:

The object name

Type:
  • string

(readonly) parent :SwatObject

Description:

  • The swat object direct parent

Source:
Inherited From:

The swat object direct parent

Type:

(readonly) readonly :boolean

Description:

  • The grid column readonly mode

Source:

The grid column readonly mode

Type:
  • boolean

(readonly) screen

Description:

  • The swat object inner screen (container)

Source:
Inherited From:

The swat object inner screen (container)

(readonly) screenValue :*

Description:

  • The grid column screen value

Source:

The grid column screen value

Type:
  • *

screenValueFilter

Description:

  • The grid column screen value in filter

Source:

The grid column screen value in filter

screenValueFilter

Description:

  • The grid column screen value in filter

Source:

The grid column screen value in filter

(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

(readonly) visible :boolean

Description:

  • The grid column visible mode (opposite of hidden)

Source:

The grid column visible mode (opposite of hidden)

Type:
  • boolean

(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

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:

  • Method to clear the hasChanges flag on the object

Source:
Inherited From:
Example
Object.clearChanges()

clearPanelMessages() → {void}

Description:

  • Remove all panel messages from a controller

Source:
Inherited From:
Returns:
Type
void

decrementChanges() → {void}

Description:

  • Decrement has changes on a form with 1

Source:
Inherited From:
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:
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

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

hasChanges() → {boolean}

Description:

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

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

hasErrors() → {boolean}

Description:

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

Source:
Inherited From:
Returns:
Type
boolean

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

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