DocViewer

Extends

• Panel

Members

(readonly) attributes

Description:

• Returns the object attributes

Source:

• index.js, line 993

Inherited From:

• SwatObject#attributes

collapsed :boolean

Description:

• The panel collapsed mode if it is collapsed or expanded

Source:

• index.js, line 4525

Inherited From:

• Panel#collapsed

Type:

• boolean

(readonly) container

Description:

• The swat object top-level parent, usually a window or dialog object

Source:

• index.js, line 1031

Inherited From:

• SwatObject#container

(readonly) controller :*

Description:

• The object's legacy API controller. Used for JavaScript calls from TypeScript.

Source:

• index.js, line 974

Inherited From:

• SwatObject#controller

Type:

• *

Example

window.akioma.myFunction(eventSource.controller);

(readonly) dynObject :*

Description:

• The object's legacy API dynObject. Used for JavaScript calls from TypeScript.

Source:

• index.js, line 985

Inherited From:

• SwatObject#dynObject

Type:

• *

Example

window.akioma.myFunction(eventSource.dynObject);

height :number

Description:

• The panel height

Source:

• index.js, line 4559

Inherited From:

• Panel#height

Type:

• number

hidden :boolean

Description:

• The panel hidden mode if it is hidden or shown

Source:

• index.js, line 4459

Inherited From:

• Panel#hidden

Type:

• boolean

(readonly) name :string

Description:

• The object name

Source:

• index.js, line 1002

Inherited From:

• SwatObject#name

Type:

• string

(readonly) parent :SwatObject

Description:

• The swat object direct parent

Source:

• index.js, line 1012

Inherited From:

• SwatObject#parent

Type:

• SwatObject

(readonly) screen

Description:

• The swat object inner screen (container)

Source:

• index.js, line 1055

Inherited From:

• SwatObject#screen

title :string

Description:

• The panel title

Source:

• index.js, line 4580

Inherited From:

• Panel#title

Type:

• string

(readonly) topScreen

Description:

• The swat object top screen (container), usually a window or dialog object

Source:

• index.js, line 1043

Inherited From:

• SwatObject#topScreen

type :string

Description:

• Used for retriving the object type

Source:

• index.js, line 1165

Inherited From:

• SwatObject#type

Type:

• string

visible :boolean

Description:

• The panel visible mode (opposite of hidden)

Source:

• index.js, line 4515

Inherited From:

• Panel#visible

Type:

• boolean

width :number

Description:

• The panel width

Source:

• index.js, line 4538

Inherited From:

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

• index.js, line 1123

Inherited From:

• SwatObject#window

Type:

• Window

Methods

addPanelMessage(msg) → {number}

Description:

• Add an panel message and return the index of the message

Source:

• index.js, line 2122

Inherited From:

• VisualObject#addPanelMessage

Parameters:

Returns:

Type

number

clearCustomState(name) → {void}

Description:

• Remove a custom state from a controller

Source:

• index.js, line 2097

Inherited From:

• VisualObject#clearCustomState

Parameters:

Returns:

Type

void

clearHasChanges()

Description:

• Method to clear the hasChanges flag on the object

Source:

• index.js, line 2068

Inherited From:

• VisualObject#clearHasChanges

Example

Object.clearChanges()

clearPanelMessages() → {void}

Description:

• Remove all panel messages from a controller

Source:

• index.js, line 2141

Inherited From:

• VisualObject#clearPanelMessages

Returns:

Type

void

collapse() → {void}

Description:

• Collapse a panel

Source:

• index.js, line 4651

Inherited From:

• Panel#collapse

Returns:

Type

void

decrementChanges() → {void}

Description:

• Decrement has changes on a form with 1

Source:

• index.js, line 2076

Inherited From:

• VisualObject#decrementChanges

Returns:

Type

void

dispatchMethodCall(methodName, params) → {Promise.<any>}

Description:

• Calls a docviewer method by messaging the docviewer and returning the response

Source:

• index.js, line 4764

Example

const docViewer = eventSource.window.getDocViewer('MyDocViewer');

docViewer.dispatchMethodCall('getPageCount')
    .then((numPages) => {
        console.log(numPages);
    });

Parameters:

Returns:

Type

Promise.<any>

expand() → {void}

Description:

• Expand a panel

Source:

• index.js, line 4642

Inherited From:

• Panel#expand

Returns:

Type

void

fixSize(fixWidth, fixHeight) → {void}

Description:

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

Source:

• index.js, line 4604

Inherited From:

• Panel#fixSize

Parameters:

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:

• index.js, line 2032

Inherited From:

• VisualObject#forceShow

getLink(link) → {SwatObject}

Description:

• Gets the object's link source or target object

Source:

• index.js, line 1085

Inherited From:

• SwatObject#getLink

Example

myForm.getLink("DISPLAY:SRC")

Parameters:

Returns:

Type

SwatObject

getLinks(link) → {SwatObject}

Description:

• Gets the object's link source or target objects

Source:

• index.js, line 1099

Inherited From:

• SwatObject#getLinks

Example

myDataSource.getLinks("DISPLAY:TRG")

Parameters:

Returns:

Type

SwatObject

getObject(name) → {SwatObject}

Description:

• Gets a descendant object by name

Source:

• index.js, line 1068

Inherited From:

• SwatObject#getObject

Parameters:

Returns:

Type

SwatObject

hasChanges() → {boolean}

Description:

• Returns if there are changes in the object or its descendents

Source:

• index.js, line 2056

Inherited From:

• VisualObject#hasChanges

Example

Object.hasChanges()

Returns:

Type

boolean

hasErrors() → {boolean}

Description:

• Returns if there are changes in the object or its descendents

Source:

• index.js, line 2104

Inherited From:

• VisualObject#hasErrors

Returns:

Type

boolean

hideHeader() → {void}

Description:

• Hide the header from a panel

Source:

• index.js, line 4624

Inherited From:

• Panel#hideHeader

Returns:

Type

void

hidePanelMenuButton(name)

Description:

• Hides a panelMenu button

Source:

• index.js, line 4689

Inherited From:

• Panel#hidePanelMenuButton

Parameters:

hideToolbarButton(name) → {void}

Description:

• Hide toolbar button in docviewer based on given name

Source:

• index.js, line 4787

Parameters:

Returns:

Type

void

hideTopToolbar() → {void}

Description:

• Hides top Toolbar navigation in docviewer

Source:

• index.js, line 4816

Returns:

Type

void

progressOff(bPauseProgressOff) → {void}

Description:

• Method for setting the progress cursor off for this particular object

Source:

• index.js, line 4615

Inherited From:

• Panel#progressOff

Parameters:

Returns:

Type

void

progressOn(bPauseProgressOff) → {void}

Description:

• Method for setting the progress cursor on for this particular object

Source:

• index.js, line 4593

Inherited From:

• Panel#progressOn

Parameters:

Returns:

Type

void

removePanelMessage(id) → {void}

Description:

• Remove a panel message from a controller by the given id

Source:

• index.js, line 2132

Inherited From:

• VisualObject#removePanelMessage

Parameters:

Returns:

Type

void

setCallback(eventName, callback)

Description:

• Sets a callback function for an event

Source:

• index.js, line 4775

Parameters:

setCustomState(name, optionsopt) → {void}

Description:

• Set a custom state on a controller

Source:

• index.js, line 2087

Inherited From:

• VisualObject#setCustomState

Parameters:

Returns:

Type

void

setHeight(height) → {void}

Description:

• Set panel height

Source:

• index.js, line 4661

Inherited From:

• Panel#setHeight

Parameters:

Returns:

Type

void

setMinHeight(height) → {void}

Description:

• Set panel min height

Source:

• index.js, line 4671

Inherited From:

• Panel#setMinHeight

Parameters:

Returns:

Type

void

setValue(value)

Description:

• Name of the document file to load inside the docviewer control

Source:

• index.js, line 4845

Parameters:

showHeader() → {void}

Description:

• Show the header from a panel

Source:

• index.js, line 4633

Inherited From:

• Panel#showHeader

Returns:

Type

void

showPanelMenuButton(name)

Description:

• Shows a panelMenu button

Source:

• index.js, line 4680

Inherited From:

• Panel#showPanelMenuButton

Parameters:

showSideToolbar() → {void}

Description:

• Shows side Toolbar navigation in docviewer

Source:

• index.js, line 4809

Returns:

Type

void

showToolbarButton(name) → {void}

Description:

• Show toolbar button in docviewer based on given name

Source:

• index.js, line 4795

Parameters:

Returns:

Type

void

showTopToolbar() → {void}

Description:

• Shows top Toolbar navigation in docviewer

Source:

• index.js, line 4823

Returns:

Type

void

unsetCallback(eventName, callback)

Description:

• Removes a callback function for an event

Source:

• index.js, line 4832

Parameters: