Expand all

OO.ui.PageLayout

Extends

Constructor

new OO.ui.PageLayout(name, [config]) #

PageLayouts are used within booklet layouts to create pages that users can select and display from the booklet's optional outline navigation. Pages are usually not instantiated directly, rather extended to include the required content and functionality.

Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See BookletLayout for an example.

Parameters:

Name Type Attributes Description
name string

Unique symbolic name of page
config Object optional

Configuration options
Source:

PageLayouts are used within booklet layouts to create pages that users can select and display from the booklet's optional outline navigation.

Methods

focus() #

Focus the panel layout

The default implementation just focuses the first focusable element in the panel

Inherited from:
Source:

Focus the panel layout

The default implementation just focuses the first focusable element in the panel

getClosestScrollableElementContainer() → {HTMLElement} #

Get closest scrollable container.

Inherited from:
Source:

Returns:

Closest scrollable container

Type
HTMLElement
Get closest scrollable container.

getData() → {any} #

Get element data.

Inherited from:
Source:

Returns:

Element data

Type
any
Get element data.

getElementDocument() → {HTMLDocument} #

Get the DOM document.

Inherited from:
Source:

Returns:

Document object

Type
HTMLDocument
Get the DOM document.

getElementGroup() → {OO.ui.mixin.GroupElement|null} #

Get group element is in.

Inherited from:
Source:

Returns:

Group element, null if none

Type
OO.ui.mixin.GroupElement | null
Get group element is in.

getElementId() → {string} #

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

Inherited from:
Source:

Returns:

Type
string

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

getElementWindow() → {Window} #

Get the DOM window.

Inherited from:
Source:

Returns:

Window object

Type
Window
Get the DOM window.

getName() → {string} #

Get the symbolic name of the page.

Source:

Returns:

Symbolic name of page

Type
string
Get the symbolic name of the page.

getOutlineItem() → {OO.ui.OutlineOptionWidget|null} #

Get outline item.

The outline item allows users to access the page from the booklet's outline navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.

Source:

Returns:

Outline option widget

Type
OO.ui.OutlineOptionWidget | null
Get outline item.

getTagName() → {string} #

Get the HTML tag name.

Override this method to base the result on instance information.

Inherited from:
Source:

Returns:

HTML tag name

Type
string
Get the HTML tag name.

isActive() → {boolean} #

Check if page is active.

Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.

Source:

Returns:

Page is active

Type
boolean
Check if page is active.

isElementAttached() → {boolean} #

Check if the element is attached to the DOM

Inherited from:
Source:

Returns:

The element is attached to the DOM

Type
boolean
Check if the element is attached to the DOM

isVisible() → {boolean} #

Check if element is visible.

Inherited from:
Source:

Returns:

element is visible

Type
boolean
Check if element is visible.

resetScroll() → {OO.ui.Layout}chainable #

Reset scroll offsets

Inherited from:
Source:

Returns:

The layout, for chaining

Type
OO.ui.Layout
Reset scroll offsets

restorePreInfuseState(state)protected #

Restore the pre-infusion dynamic state for this widget.

This method is called after #$element has been inserted into DOM. The parameter is the return value of #gatherPreInfuseState.

Parameters:

Name Type Description
state Object
Inherited from:
Source:
Restore the pre-infusion dynamic state for this widget.

scrollElementIntoView([config]) → {jQuery.Promise} #

Scroll element into view.

Parameters:

Name Type Attributes Description
config Object optional

Configuration options
Inherited from:
Source:

Returns:

Promise which resolves when the scroll is complete

Type
jQuery.Promise
Scroll element into view.

setActive([active]) #

Set the page to its 'active' state.

Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional CSS is applied to the outline item to reflect the page's active state. Outside of the booklet context, setting the active state on a page does nothing.

Parameters:

Name Type Attributes Default Description
active boolean optional
 false

Page is active
Source:

Fires:

Set the page to its 'active' state.

setData(data) → {OO.ui.Element}chainable #

Set element data.

Parameters:

Name Type Description
data any

Element data
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set element data.

setElementGroup(group) → {OO.ui.Element}chainable #

Set group element is in.

Parameters:

Name Type Description
group OO.ui.mixin.GroupElement | null

Group element, null if none
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set group element is in.

setElementId(id) → {OO.ui.Element}chainable #

Set the element has an 'id' attribute.

Parameters:

Name Type Description
id string
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set the element has an 'id' attribute.

setOutlineItem(outlineItem) → {OO.ui.PageLayout}chainable #

Set or unset the outline item.

Specify an outline option to set it, or null to clear the outline item. To customize the outline item itself (e.g., to set a label or outline level), use #setupOutlineItem instead of this method.

Parameters:

Name Type Description
outlineItem OO.ui.OutlineOptionWidget | null

Outline option widget, null to clear
Source:

Returns:

The layout, for chaining

Type
OO.ui.PageLayout
Set or unset the outline item.

setupOutlineItem()protected #

Set up the outline item.

Override this method to customize the outline item (e.g., to add a label or outline level). To set or unset the outline item itself (with an outline option or null), use the #setOutlineItem method instead.

Source:
Set up the outline item.

supports(methods) → {boolean} #

Check if element supports one or more methods.

Parameters:

Name Type Description
methods string | Array.<string>

Method or list of methods to check
Inherited from:
Source:

Returns:

All methods are supported

Type
boolean
Check if element supports one or more methods.

toggle([show]) → {OO.ui.Element}chainable #

Toggle visibility of an element.

Parameters:

Name Type Attributes Description
show boolean optional

Make element visible, omit to toggle visibility
Inherited from:
Source:

Fires:

Returns:

The element, for chaining

Type
OO.ui.Element
Toggle visibility of an element.

updateThemeClasses() #

Update the theme-provided classes.

This is called in element mixins and widget classes any time state changes. Updating is debounced, minimizing overhead of changing multiple attributes and guaranteeing that theme updates do not occur within an element's constructor

Inherited from:
Source:
Update the theme-provided classes.

Events

active(active) #

An 'active' event is emitted when the page becomes active. Pages become active when they are shown in a booklet layout that is configured to display only one page at a time.

Parameters:

Name Type Description
active boolean

Page is active
Source:
An 'active' event is emitted when the page becomes active.