Ribbon

Ribbon

new Ribbon()

Description:

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

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

items

Description:

  • The ribbon item and items block names

Source:

The ribbon item and items block names

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

  • 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

disableItem(name)

Description:

  • Disables a ribbon item or items block

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)

disableSubitem(itemName, subitemName)

Description:

  • Disables a ribbon subitem

Source:
Parameters:
Name Type Description
itemName string

The name of the item (case-insensitive)
subitemName string

The name of the subitem (case-insensitive)

enableItem(name)

Description:

  • Enables a ribbon item or items block

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)

enableSubitem(itemName, subitemName)

Description:

  • Enables a ribbon subitem

Source:
Parameters:
Name Type Description
itemName string

The name of the item (case-insensitive)
subitemName string

The name of the subitem (case-insensitive)

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:

getItem(name)

Description:

  • Gets the ribbon item by the name

Source:
Parameters:
Name Type Description
name string

The name of the item or block (case-insensitive)

getItemLabel(name)

Description:

  • Gets the ribbon item or items block label

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)

getItemTooltip(name)

Description:

  • Gets the ribbon item or items block tooltip

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)
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

getSelectedOption(name)

Description:

  • Gets the selected option from a RibbonCombo

Source:
Parameters:
Name Type Description
name string

The name of the combo item (case-insensitive)

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

hasItem(name)

Description:

  • Returns of the item or items block exists in the ribbon

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)

hideItem(name)

Description:

  • Hides a ribbon item or items block

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)

hideSubitem(itemName, subitemName)

Description:

  • Hides a ribbon subitem

Source:
Parameters:
Name Type Description
itemName string

The name of the item (case-insensitive)
subitemName string

The name of the subitem (case-insensitive)

isItemEnabled(name)

Description:

  • Returns true if the ribbon item or items block is enabled

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)

isItemVisible(name)

Description:

  • Returns true if the ribbon item or items block is visible

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)

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

setItemLabel(name, label, setTooltip)

Description:

  • Sets the ribbon item or items block label

Source:
Parameters:
Name Type Default Description
name string

The name of the item or items block (case-insensitive)
label string

The label to set
setTooltip boolean false

Set tooltip with the same value as the label (default is false)

setItemTooltip(name, tooltip)

Description:

  • Sets the ribbon item or items block tooltip

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)
tooltip string

The tooltip to set

showItem(name)

Description:

  • Shows a ribbon item or items block

Source:
Parameters:
Name Type Description
name string

The name of the item or items block (case-insensitive)

showSubitem(itemName, subitemName)

Description:

  • Shows a ribbon subitem

Source:
Parameters:
Name Type Description
itemName string

The name of the item (case-insensitive)
subitemName string

The name of the subitem (case-insensitive)