SwatObject

SwatObject

new SwatObject(dynObject)

Description:

  • Base Swat Object

Source:
Parameters:
Name Type Description
dynObject *

The dynObject

Members

(readonly) attributes

Description:

  • Returns the object attributes

Source:

Returns the object attributes

(readonly) container

Description:

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

Source:

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:

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

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

(readonly) dynObject :*

Description:

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

Source:

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

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

(readonly) name :string

Description:

  • The object name

Source:

The object name

Type:
  • string

(readonly) parent :SwatObject

Description:

  • The swat object direct parent

Source:

The swat object direct parent

Type:

(readonly) screen

Description:

  • The swat object inner screen (container)

Source:

The swat object inner screen (container)

(readonly) topScreen

Description:

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

Source:

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

type :string

Description:

  • Used for retriving the object type

Source:

Used for retriving the object type

Type:
  • string

(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:

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

Description:

  • Gets the object's link source or target object

Source:
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:
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:
Parameters:
Name Type Description
name string

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