Scheduler

Scheduler

new Scheduler()

Description:

  • Scheduler Object

Source:

Extends

Members

(readonly) attributes

Description:

  • Returns the object attributes

Source:
Inherited From:

Returns the object attributes

collapsed :boolean

Description:

  • The panel collapsed mode if it is collapsed or expanded

Source:
Inherited From:

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

height :number

Description:

  • The panel height

Source:
Inherited From:

The panel height

Type:
  • number

hidden :boolean

Description:

  • The panel hidden mode if it is hidden or shown

Source:
Inherited From:

The panel hidden mode if it is hidden or shown

Type:
  • boolean

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

title :string

Description:

  • The panel title

Source:
Inherited From:

The panel title

Type:
  • string

(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

visible :boolean

Description:

  • The panel visible mode (opposite of hidden)

Source:
Inherited From:

The panel visible mode (opposite of hidden)

Type:
  • boolean

width :number

Description:

  • The panel width

Source:
Inherited From:

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

collapse() → {void}

Description:

  • Collapse a panel

Source:
Inherited From:
Returns:
Type
void

decrementChanges() → {void}

Description:

  • Decrement has changes on a form with 1

Source:
Inherited From:
Returns:
Type
void

expand() → {void}

Description:

  • Expand a panel

Source:
Inherited From:
Returns:
Type
void

fixSize(fixWidth, fixHeight) → {void}

Description:

  • Method for setting the fixed width/height of a panel level object

Source:
Inherited From:
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:
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

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

hideHeader() → {void}

Description:

  • Hide the header from a panel

Source:
Inherited From:
Returns:
Type
void

hidePanelMenuButton(name)

Description:

  • Hides a panelMenu button

Source:
Inherited From:
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:
Inherited From:
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:
Inherited From:
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:
Inherited From:
Parameters:
Name Type Description
id number
Returns:
Type
void

setCurrentView(date, view)

Description:

  • Displays the specified view and date

Source:
Parameters:
Name Type Description
date Date

The date to position the view. null will not change the position.
view SchedulerView

The day, week, month or year view. null will not change the view.

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

setHeight(height) → {void}

Description:

  • Set panel height

Source:
Inherited From:
Parameters:
Name Type Description
height number
Returns:
Type
void

setMinHeight(height) → {void}

Description:

  • Set panel min height

Source:
Inherited From:
Parameters:
Name Type Description
height number
Returns:
Type
void

setReadonly(readonly)

Description:

  • Sets the readonly attribute of the scheduler

Source:
Parameters:
Name Type Description
readonly Boolean

True for setting the scheduler as read-only, false for deactivating this setting (default value).

showHeader() → {void}

Description:

  • Show the header from a panel

Source:
Inherited From:
Returns:
Type
void

showPanelMenuButton(name)

Description:

  • Shows a panelMenu button

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

The button name (SCL menuFunctionCode/menuStructureCode)

updateView(date, view)

Description:

  • Displays the specified view and date BUT does not fire any events like setCurrentView. You could use updateView to change the scheduler view to week when the screen is displayed before the data has loaded and use setCurrentView to change the date after the data has loaded.

Source:
Parameters:
Name Type Description
date Date

The date to position the view. null will not change the position.
view SchedulerView

The day, week, month or year view. null will not change the view.