Frame

Frame

new Frame()

Description:

  • Frame Object

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);

customData

Description:

  • Retrive customData of a ak_frame object

Source:
Inherited From:

Retrive customData of a ak_frame object

(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);

(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) primaryDataSource :akioma.swat.DataSource

Description:

  • The window PRIMARYSDO linked datasource

Source:
Inherited From:

The window PRIMARYSDO linked datasource

Type:
  • akioma.swat.DataSource

(readonly) screen

Description:

  • The swat object inner screen (container)

Source:
Inherited From:

The swat object inner screen (container)

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

  • Clears hasChanges (dirty state)

Source:
Inherited From:

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:

getDataSource(name) → {DataSource}

Description:

  • Gets a descendent datasource object by name

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

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

getDocViewer(name) → {akioma.swat.DocViewer}

Description:

  • Gets a descendent docviewer object by name

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

The object name (case-insensitive)
Returns:
Type
akioma.swat.DocViewer

getForm(name) → {Form}

Description:

  • Gets a descendent form object by name

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

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

getFrame(name) → {akioma.swat.Frame}

Description:

  • Gets a descendent frame object by name

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

The object name (case-insensitive)
Returns:
Type
akioma.swat.Frame

getGrid(name) → {Grid}

Description:

  • Gets a descendent grid object by name

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

The object name (case-insensitive)
Returns:
Type
Grid
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

getRibbon(name) → {akioma.swat.Ribbon}

Description:

  • Gets a descendent ribbon object by name

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

The object name (case-insensitive)
Returns:
Type
akioma.swat.Ribbon

getScheduler(name) → {akioma.swat.Scheduler}

Description:

  • Gets a descendent scheduler object by name

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

The object name (case-insensitive)
Returns:
Type
akioma.swat.Scheduler

getTabbar(name) → {Tabbar}

Description:

  • Gets a descendent tabbar object by name

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

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

getToolbar(name) → {akioma.swat.Toolbar}

Description:

  • Gets a descendent toolbar object by name

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

The object name (case-insensitive)
Returns:
Type
akioma.swat.Toolbar

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

setCustomData(customData) → {void}

Description:

  • Sets Custom data

Source:
Inherited From:
Parameters:
Name Type Description
customData object | string
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