Expand all

ve.ui.WindowAction

Extends

Constructor

new ve.ui.WindowAction(surface, [source]) #

Window action.

Parameters:

Name Type Attributes Description
surface ve.ui.Surface

Surface to act on
source string optional
Source:
Window action.

Methods

close(name, [data]) → {boolean} #

Close a window

Parameters:

Name Type Attributes Description
name string

Symbolic name of window to open
data Object optional

Window closing data
Source:

Returns:

Action was executed

Type
boolean
Close a window

getWindowManager(windowType) → {ve.ui.WindowManager|null} #

Get the window manager for a specified window type

Parameters:

Name Type Description
windowType ve.ui.WindowAction.WindowType

Window type object. See #getWindowType
Source:

Returns:

Window manager

Type
ve.ui.WindowManager | null
Get the window manager for a specified window type

getWindowType(name) → {ve.ui.WindowAction.WindowType} #

Get the specified window type

Parameters:

Name Type Description
name string

Window name
Source:

Returns:

Type
ve.ui.WindowAction.WindowType
Get the specified window type

open(name, [data], [action]) → {boolean|jQuery.Promise} #

Open a window.

Parameters:

Name Type Attributes Description
name string

Symbolic name of window to open
data Object optional

Window opening data
action string optional

Action to execute after opening, or immediately if the window is already open
Source:

Returns:

Action was executed; if a Promise, it'll resolve once the action is finished executing

Type
boolean | jQuery.Promise
Open a window.

toggle(name, [data]) → {boolean} #

Toggle a window between open and close

Parameters:

Name Type Attributes Description
name string

Symbolic name of window to open or close
data Object optional

Window opening or closing data
Source:

Returns:

Action was executed

Type
boolean
Toggle a window between open and close

Type Definitions

WindowType #

Type:

Properties:

Name Type Attributes Description
name string | null

Window name ('inspector', 'toolbar', 'dialog' or null)
position string optional

Window position (for toolbar dialogs)
Source: