abstract OO.ui.Window

Set focus traps

It is considered best practice to trap focus in a loop within a modal dialog, even though with 'inert' support we could allow focus to break out to the browser chrome.

• https://www.w3.org/TR/wai-aria-practices-1.1/examples/dialog-modal/dialog.html#kbd_label
• https://allyjs.io/tutorials/accessible-dialog.html#reacting-to-kbdtabkbd-and-kbdshift-tabkbd
• https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/dialog_role#focus_management

Overlay element to use for the $overlay configuration option of widgets that support it. Things put inside it are overlaid on top of the window and are not bound to its dimensions. See https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays.

MyDialog.prototype.initialize = function () {
  ...
  const popupButton = new OO.ui.PopupButtonWidget( {
    $overlay: this.$overlay,
    label: 'Popup button',
    popup: {
      $content: $( '<p>Popup content.</p><p>More content.</p><p>Yet more content.</p>' ),
      padded: true
    }
  } );
  ...
};

Symbolic name of the window size: small, medium, large, larger or full.

The static size is used if no #size is configured during construction.

Close the window.

This method is a wrapper around a call to the window manager’s closeWindow method.

The window's #getHoldProcess and #getTeardownProcess methods are called during the closing phase of the window’s lifecycle and can be used to specify closing behavior each time the window closes.

Get the height of the window body.

To get the height of the full window contents (the window body, head, and foot together), use #getContentHeight.

When this function is called, the window will temporarily have been resized to height=1px, so .scrollHeight measurements can be taken accurately.

Get the height of the full window contents (i.e., the window head, body and foot together).

What constitutes the head, body, and foot varies depending on the window type. A message dialog displays a title and message in its body, and any actions in the foot. A process dialog displays a title and special actions in the head, and dialog content in the body.

To get just the height of the dialog body, use the #getBodyHeight method.

Get the directionality of the frame (right-to-left or left-to-right).

Get the 'hold' process.

The hold process is used to keep a window from being used in a particular context, based on the data argument. This method is called during the closing phase of the window’s lifecycle (before the closing animation). You can close dropdowns of elements in the window in this process, if they do not get closed automatically.

Override this method to add additional steps to the 'hold' process the parent method provides using the first and next methods of OO.ui.Process.

Get the window manager.

All windows must be attached to a window manager, which is used to open and close the window and control its presentation.

Get the ‘ready’ process.

The ready process is used to ready a window for use in a particular context, based on the data argument. This method is called during the opening phase of the window’s lifecycle, after the window has been setup (after the opening animation). You can focus elements in the window in this process, or open their dropdowns.

Override this method to add additional steps to the ‘ready’ process the parent method provides using the first and next methods of OO.ui.Process.

Get the 'setup' process.

The setup process is used to set up a window for use in a particular context, based on the data argument. This method is called during the opening phase of the window’s lifecycle (before the opening animation). You can add elements to the window in this process or set their default values.

Override this method to add additional steps to the ‘setup’ process the parent method provides using the first and next methods of OO.ui.Process.

To add window content that persists between openings, you may wish to use the #initialize method instead.

Get the symbolic name of the window size (e.g., small or medium).

Get the size properties associated with the current window size

Get the ‘teardown’ process.

The teardown process is used to teardown a window after use. During teardown, user interactions within the window are conveyed and the window is closed, based on the data argument. This method is called during the closing phase of the window’s lifecycle (after the closing animation). You can remove elements in the window in this process or clear their values.

Override this method to add additional steps to the ‘teardown’ process the parent method provides using the first and next methods of OO.ui.Process.

Hold window.

This is called by OO.ui.WindowManager during window closing (before the animation), and should not be called directly by other systems.

Check if the window is closing.

This method is a wrapper around the window manager's isClosing method.

Check if the window has been initialized.

Initialization occurs when a window is added to a manager.

Check if the window is opened.

This method is a wrapper around the window manager's isOpened method.

Check if the window is opening.

This method is a wrapper around the window manager's isOpening method.

Check if the window is visible.

Called when someone tries to focus the hidden element at the end of the dialog. Sends focus back to the start of the dialog.

Open the window.

This method is a wrapper around a call to the window manager’s openWindow method.

To customize the window each time it opens, use #getSetupProcess or #getReadyProcess.

Ready window.

This is called by OO.ui.WindowManager during window opening (after the animation), and should not be called directly by other systems.

Setup window.

This is called by OO.ui.WindowManager during window opening (before the animation), and should not be called directly by other systems.

Teardown window.

This is called by OO.ui.WindowManager during window closing (after the animation), and should not be called directly by other systems.