JSDoc: Namespace: stbWindowMgr

Main object stbWindowMgr methods declaration.

Some methods require windowId field which can be achieved either from stbWindowMgr.windowInit or from stbWebWindow.windowId.

Methods

addBrowserBookmark <static> addBrowserBookmark ()

Open "bookmark manager" web application and pass currently opened URL of "wild web browser" to application as parameter.

Since:

0.2.16

Deprecated:

since 0.2.18

closeWebWindow <static> closeWebWindow ()

Close "Wild Web" window.

Deprecated:

since 0.2.18

closeWindow <static> closeWindow ( windowId ) → {boolean}

Close window "windowId".

Parameters:

Name	Type	Description
`windowId`	number	ID of window to close

Since:

0.2.18

Returns:

Type

Description

boolean

operations status:

Value	Description
true	executed correctly
false	failed to execute

getCurrentTitle <static> getCurrentTitle () → {string}

Get title of currently opened "Wild Web" window.

If there is no "Wild Web" window opened then return empty string.

Since:

0.2.16

Returns:

Type	Description
string	title

getCurrWebUrl <static> getCurrWebUrl () → {string}

Get currently loaded URL of "Wild Web" window.

If there is no "Wild Web" window opened then returns empty string.

Since:

0.2.18

Returns:

Type	Description
string	URL

GetFocusedInputInfo <static> GetFocusedInputInfo () → {stbWindowMgr.uiElementInfo}

Get information for currently focused user interface element (HTML inputs etc...).

Since:

0.2.18

Returns:

Type	Description
stbWindowMgr.uiElementInfo	attributes of element

hideWindow <static> hideWindow ( windowId )

Make specified window invisible.

If there other windows exist on window stack then most upper window will became active (be visible and has input focus).

Parameters:

Name	Type	Description
`windowId`	number	window ID to hide

Since:

0.2.18

initWebWindow <static> initWebWindow ( url )

Create and initialize the "Wild Web" window using URL "url". Created window will be invisible by default.

Parameters:

Name	Type	Description
`url`	string	URL to load into newly created window

Since:

0.2.18

InitWebWindow <static> InitWebWindow ()

Deprecated:

since 0.2.18

IsScreenSaverWindowExist <static> IsScreenSaverWindowExist () → {boolean}

Get status for "screen saver" window.

Since:

0.2.18

Returns:

Type

Description

boolean

possible values:

Value	Description
true	window exist
false	window not found

IsWebVkWindowExist <static> IsWebVkWindowExist () → {boolean}

Check if "Virtual Keyboard" dedicated window exists.

Since:

0.2.18

Returns:

Type

Description

boolean

operations status:

Value	Description
true	window existed
false	window not found

IsWebWindowExist <static> IsWebWindowExist () → {boolean}

Check if "Wild Web" dedicated window exists.

Since:

0.2.16

Returns:

Type

Description

boolean

operations status:

Value	Description
true	window existed
false	window not found

LoadUrl <static> LoadUrl ( url )

Load URL "url" to "Wild Web" dedicated window.

Parameters:

Name	Type	Description
`url`	string	URL to load (if string is empty then load `file:///home/pages/blank/index.html`)

Since:

0.2.16

openDownloadManager <static> openDownloadManager ( url )

Open "download manager" dedicated web window using "url".

Parameters:

Name	Type	Description
`url`	string	URL to open

Deprecated:

since 0.2.18

openMediaPlayer <static> openMediaPlayer ()

Since:

0.2.16

Deprecated:

since 0.2.18

openWebCfgPortal <static> openWebCfgPortal ( windowAttributes )

Open "Configuration Portal" window and run specified web application.

Parameters:

Name	Type	Description
`windowAttributes`	stbWindowMgr.windowAttributes	parameters of created window

Since:

0.2.18

openWebFace <static> openWebFace ( url ) → {number}

Create "Web Face" dedicated window and load address "url".

Parameters:

Name	Type	Description
`url`	string	address to load

Since:

0.2.18

Returns:

Type	Description
number	ID of the created window

openWebFavorites <static> openWebFavorites ()

Since:

0.2.16

Deprecated:

since 0.2.18

openWebWindow <static> openWebWindow ()

Since:

0.2.16

Deprecated:

since 0.2.18

raiseWebFaceWindow <static> raiseWebFaceWindow ()

Make "Web Face" window active. Do nothing if window does not exist.

Since:

0.2.18

raiseWebWindow <static> raiseWebWindow ()

Make "Wild Web" window active. Do nothing if window does not exist.

Since:

0.2.18

resizeWebWindow <static> resizeWebWindow ( x, y, w, h )

Resize "Wild Web" window using given coordinates. "x","y" - top left corner, "w","h" - width and height of the new window.

Parameters:

Name	Type	Description
`x`	number	X
`y`	number	Y
`w`	number	width
`h`	number	height

Since:

0.2.18

setBookmarkImplUrl <static> setBookmarkImplUrl ( url )

Set URL "url" for "web favorites" web application.

Parameters:

Name	Type	Description
`url`	string	URL to set

Deprecated:

since 0.2.18

SetFocusedInputText <static> SetFocusedInputText ( text )

Set text "text" for currently focused HTML element.

Parameters:

Name	Type	Description
`text`	string	string to set

Since:

0.2.18

SetVirtualKeyboardCoord <static> SetVirtualKeyboardCoord ( hint, xPos, yPos )

Set manual position for "Virtual keyboard" window. This effectively override default behavior of stbWindowMgr.GetFocusedInputInfo.

Parameters:

Name Type Description

hint

string

defines the hint for positioning hint value depends on "Virtual keyboard" implementation

(value is defined for web application level) recommended values:

Value	Description
"none"	position hind is undefined
"topleft"	window should be positioned close to top-left corner
"topright"	window should be positioned close to top-right corner
"top"	window should be positioned close to top edge
"bottomright"	window should be positioned close to bottom-right corner
"bottomleft"	window should be positioned close to bottom-left corner
"bottom"	window should be positioned close to bottom edge

xPos

number

set manual "X" coordinate of top-left corner for "Virtual keyboard" window

-1 value cancel manual coordinates (stbWindowMgr.GetFocusedInputInfo will return coordinates of the active element)

yPos

number

set manual "Y" coordinate of top-left corner for "Virtual keyboard" window

-1 value cancel manual coordinates (stbWindowMgr.GetFocusedInputInfo will return coordinates of the active element)

Since:

0.2.18

setVirtualKeyboardInitAttr <static> setVirtualKeyboardInitAttr ( windowAttributes )

Set window init attributes for "Virtual keyboard" window.

Parameters:

Name	Type	Description
`windowAttributes`	stbWindowMgr.windowAttributes	attributes to set

Since:

0.2.18

setVirtualMouseMode <static> setVirtualMouseMode ( mode )

Set virtual mouse mode.

Parameters:

Name Type Description

mode

boolean

possible values:

Value	Description
true	turn virtual mouse on
false	turn virtual mouse off

Since:

0.2.16

setWebFaceInitAttr <static> setWebFaceInitAttr ( windowAttributes )

Set init window attributes for "Web Face" window.

Parameters:

Name	Type	Description
`windowAttributes`	stbWindowMgr.windowAttributes	attributes to set

Since:

0.2.18

showBrowserBookmarks <static> showBrowserBookmarks ()

Open "Web Favorites" window.

Since:

0.2.16

Deprecated:

since 0.2.18

showPortalWindow <static> showPortalWindow ()

Make the "Internal Portal" window active.

Since:

0.2.16

VkSetFocus <static> VkSetFocus ( mode )

Set focus mode for "Virtual keyboard" window.

Parameters:

Name Type Description

mode

boolean

possible values:

Value	Description
true	focus VK window
false	focus previously focused window

Since:

0.2.18

Deprecated:

since 0.2.18

windowActive <static> windowActive () → {number}

Get ID of currently active window.

Since:

0.2.18

Returns:

Type	Description
number	ID of the window. May return -1 if there is no proper candidates

windowAttr <static> windowAttr ( windowId, windowAttributes ) → {boolean}

Set window attributes.

Parameters:

Name	Type	Description
`windowId`	number	ID of target window
`windowAttributes`	stbWindowMgr.windowAttributes	parameters to set

Since:

0.2.18

Returns:

Type

Description

boolean

operations status:

Value	Description
true	executed correctly
false	failed to execute

windowClose <static> windowClose ( windowId ) → {boolean}

Close given window.

Parameters:

Name	Type	Description
`windowId`	number	ID of target window

Since:

0.2.18

Returns:

Type

Description

boolean

operations status:

Value	Description
true	executed correctly
false	failed to execute

windowHide <static> windowHide ( windowId ) → {boolean}

Make given window invisible.

Operation have the same effect as stbWindowMgr.windowAttr(id, '{"visible":false}').

Parameters:

Name	Type	Description
`windowId`	number	ID of target window

Since:

0.2.18

Returns:

Type

Description

boolean

operations status:

Value	Description
true	executed correctly
false	failed to execute

windowInfo <static> windowInfo ( windowId ) → {stbWindowMgr.windowAttributes}

Get attributes for given window.

Parameters:

Name	Type	Description
`windowId`	number	ID of target window

Since:

0.2.18

Returns:

Type	Description
stbWindowMgr.windowAttributes	parameters of the window

windowInit <static> windowInit ( windowAttributes ) → {number}

Create new window with specified attributes.

Parameters:

Name	Type	Description
`windowAttributes`	stbWindowMgr.windowAttributes	parameters of created window

Since:

0.2.18

Returns:

Type	Description
number	window ID for created window (-1 if window was not created)

windowList <static> windowList () → {stbWindowMgr.windowList}

Get list of ID of currently existing windows.

Since:

0.2.18

Returns:

Type	Description
stbWindowMgr.windowList	list of ID

windowLoad <static> windowLoad ( windowId, url ) → {boolean}

Load new web document into given window "windowId" using URL "url".

Parameters:

Name	Type	Description
`windowId`	number	ID of target window
`url`	string	address to load

Since:

0.2.16

Returns:

Type

Description

boolean

operations status:

Value	Description
true	executed correctly
false	failed to execute

windowShow <static> windowShow ( windowId ) → {boolean}

Make given window visible.

Operation have the same effect as stbWindowMgr.windowAttr(id, '{"visible":true}').

Parameters:

Name	Type	Description
`windowId`	number	ID of target window

Since:

0.2.18

Returns:

Type

Description

boolean

operations status:

Value	Description
true	executed correctly
false	failed to execute

Type Definitions

uiElementInfo uiElementInfo

Represents window list in JSON format.

See stbWindowMgr.GetFocusedInputInfo.

Type:

string

Properties:

Name	Type	Description
`x`	string
`y`	string
`w`	string
`h`	string
`isTextInput`	string
`text`	string
`positionHint`	string

Example

// parsed JSON data
{
    h: "100",
    isTextInput: "0",
    positionHint: "top",
    text: "some text",
    w: "100",
    x: "100",
    y: "100"
}

windowAttributes windowAttributes

Represents window attributes in JSON format.

See stbWindowMgr.openWebCfgPortal, stbWindowMgr.windowInit, stbWindowMgr.windowAttr, stbWindowMgr.windowInfo, stbWindowMgr.setWebFaceInitAttr.

Type:

string

Properties:

Name	Type	Description
`url`	string	web document (application) address to load
`x`	number	X-coordinate of the window (relative to screen)
`y`	number	Y-coordinate of the window (relative to screen)
`width`	number	width of the window
`height`	number	height of the window
`visible`	boolean	visibility
`backgroundColor`	string	background color

Example

// parsed JSON data
{
    url: "http://google.com", x: 100, y: 100, visible: true, backgroundColor: "#00ff00"
}

windowList windowList

Represents window list in JSON format.

See stbWindowMgr.windowList.

Type:

string

Properties:

Name	Type	Description
`errCode`	number	0 in case of success or -1 in case of general error
`errMsg`	string	error message. Non empty string indicate error
`result`	Array.<number>	Array (list of windows) of window unique identifiers

Example

// parsed JSON data
{
    errCode: 0, errMsg: "", result: Array[2]
}