system.nav.swapTo

Description

Performs a window swap from the current main screen window to the window specified. Swapping means that the opened window will take the place of the closing window - in this case it will be maximized. See also: Typical Navigation Strategy.

Syntax

system.nav.swapTo(path [, params])

Parameters

String path - The path of a window to swap to.

PyDictionary params - A dictionary of parameters to pass into the window. The keys in the dictionary must match dynamic property names on the target window's root container. The values for each key will be used to set those properties. [optional]

Returns

PyObject - A reference to the swapped-to window.

Scope

Client

Examples

Example 1:

This code would go in a button's ActionPerformed event to swap out of the current window and into a window named MyWindow

system.nav.swapTo("MyWindow")

Example 2:

This code would go in a button's ActionPerformed event to swap out of the current window and into a window named MyWindow. It also looks at the selected value in a dropdown menu and passes that value into the new window.

# MyWindow's Root Container must have a dynamic property named "paramValue"
dropdown = event.source.parent.getComponent("Dropdown")
system.nav.swapTo("MyWindow", {"paramValue":dropdown.selectedValue)

See also:

system.nav.swapWindow