RichText

RichText

new RichText()

Description:

  • RichText Object

Source:

Extends

Members

(readonly) attributes

Description:

  • Returns the object attributes

Source:
Inherited From:

Returns the object attributes

(readonly) changed :boolean

Description:

  • Returns true if the field value has been changed

Source:
Inherited From:

Returns true if the field value has been changed

Type:
  • boolean
Example
Field.changed

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

currentValue

Description:

  • For use in the valuechanged event. The current value. type {*}

Source:
Inherited From:

For use in the valuechanged event. The current value. type {*}

currentValueNative

Description:

  • For use in the valuechanged event. The current value native. type {*}

Source:
Inherited From:

For use in the valuechanged event. The current value native. type {*}

(readonly) dataSource :DataSource

Description:

  • The form field linked datasource

Source:
Inherited From:

The form field linked datasource

Type:

dataValue :*

Description:

  • The linked datasource field value

Source:
Inherited From:

The linked datasource field value

Type:
  • *

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

enableLiveValidation

Description:

  • Whether the validation should be called on value set, screenValue

Source:
Inherited From:

Whether the validation should be called on value set, screenValue

ignoreValidateEvent :boolean

Description:

  • Returns whether should ignore validation event or not.

Source:
Inherited From:

Returns whether should ignore validation event or not.

Type:
  • boolean

lastValue

Description:

  • For use in the valuechanged event. The last value. type {*}

Source:
Inherited From:

For use in the valuechanged event. The last 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) plainValue :string

Description:

  • Returns the plain text value unlike screenValue that returns the formatted HTML value

Source:

Returns the plain text value unlike screenValue that returns the formatted HTML value

Type:
  • string

required :boolean

Description:

  • The form field required mode

Source:
Inherited From:

The form field required mode

Type:
  • boolean

(readonly) screen

Description:

  • The swat object inner screen (container)

Source:
Inherited From:

The swat object inner screen (container)

screenValue :*

Description:

  • The form field screen value

Source:
Overrides:

The form field screen value

Type:
  • *

(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

deleteValidationRule(rule)

Description:

  • Delete form field validation rule

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

The rule type i.e. 'required', 'minlength', 'maxlength' or 'notequal'

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

getValidationRule() → {*}

Description:

  • Returns the form field validation type rule

Source:
Inherited From:
Returns:

The validation rule

Type
*

getValidationRules() → {*}

Description:

  • Returns all the form field validation rules

Source:
Inherited From:
Returns:

The validation rules

Type
*

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

setValidationRule()

Description:

  • Set form field validation rule (new or existing)

Source:
Inherited From:
Parameters:
Name Type Description
opts.rule string

The rule type i.e. 'required', 'minlength', 'maxlength' or 'notequal'
opts.smartmessage string

The smartmessage - e.g. 'valmsg-121'
opts.value *

The validation value