Extends
Members
(readonly) attributes
- Description:
Returns the object attributes
- Source:
- Overrides:
Returns the object attributes
collapsed :boolean
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:
- Overrides:
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:
- Overrides:
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:
- Overrides:
The object's legacy API dynObject. Used for JavaScript calls from TypeScript.
Type:
- *
Example
window.akioma.myFunction(eventSource.dynObject);height :number
The panel height
Type:
- number
hidden :boolean
The panel hidden mode if it is hidden or shown
Type:
- boolean
(readonly) name :string
- Description:
The object name
- Source:
- Overrides:
The object name
Type:
- string
(readonly) parent :SwatObject
- Description:
The swat object direct parent
- Source:
- Overrides:
The swat object direct parent
Type:
(readonly) screen
- Description:
The swat object inner screen (container)
- Source:
- Overrides:
The swat object inner screen (container)
title :string
The panel title
Type:
- string
(readonly) topScreen
- Description:
The swat object top screen (container), usually a window or dialog object
- Source:
- Overrides:
The swat object top screen (container), usually a window or dialog object
type :string
- Description:
Used for retriving the object type
- Source:
- Overrides:
Used for retriving the object type
Type:
- string
visible :boolean
The panel visible mode (opposite of hidden)
Type:
- boolean
width :number
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:
- Overrides:
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:
- Overrides:
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
msg |
PanelMessage | The panel message Properties
|
Returns:
- Type
- number
clearCustomState(name) → {void}
- Description:
Remove a custom state from a controller
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string |
Returns:
- Type
- void
clearHasChanges()
- Description:
Method to clear the hasChanges flag on the object
- Source:
- Overrides:
Example
Object.clearChanges()clearPanelMessages() → {void}
- Description:
Remove all panel messages from a controller
- Source:
- Overrides:
Returns:
- Type
- void
collapse() → {void}
Returns:
- Type
- void
decrementChanges() → {void}
- Description:
Decrement has changes on a form with 1
- Source:
- Overrides:
Returns:
- Type
- void
expand() → {void}
Returns:
- Type
- void
fixSize(fixWidth, fixHeight) → {void}
- Description:
Method for setting the fixed width/height of a panel level object
- Source:
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:
- Overrides:
getLink(link) → {SwatObject}
- Description:
Gets the object's link source or target object
- Source:
- Overrides:
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
getLinks(link) → {SwatObject}
- Description:
Gets the object's link source or target objects
- Source:
- Overrides:
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:
- Overrides:
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:
- Overrides:
Example
Object.hasChanges()Returns:
- Type
- boolean
hasErrors() → {boolean}
- Description:
Returns if there are changes in the object or its descendents
- Source:
- Overrides:
Returns:
- Type
- boolean
hideHeader() → {void}
Returns:
- Type
- void
hidePanelMenuButton(name)
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The button name (SCL menuFunctionCode/menuStructureCode) |
progressOff(bPauseProgressOff) → {void}
- Description:
Method for setting the progress cursor off for this particular object
- Source:
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:
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
removePanelMessage(id) → {void}
- Description:
Remove a panel message from a controller by the given id
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
number |
Returns:
- Type
- void
setCustomState(name, optionsopt) → {void}
- Description:
Set a custom state on a controller
- Source:
- Overrides:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | ||
options |
object |
<optional> |
Returns:
- Type
- void
setHeight(height) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
height |
number |
Returns:
- Type
- void
setMinHeight(height) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
height |
number |
Returns:
- Type
- void
showHeader() → {void}
Returns:
- Type
- void
showPanelMenuButton(name)
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The button name (SCL menuFunctionCode/menuStructureCode) |