Class: PageLayout

.ui.PageLayout(name, configopt)

new PageLayout(name, configopt)

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:

Extends

Methods

focus()

Focus the panel layout The default implementation just focuses the first focusable element in the panel
Inherited From:
Source:

getClosestScrollableElementContainer() → {HTMLElement}

Get closest scrollable container.
Inherited From:
Source:
Returns:
Closest scrollable container
Type
HTMLElement

getData() → {Mixed}

Get element data.
Inherited From:
Source:
Returns:
Element data
Type
Mixed

getElementDocument() → {HTMLDocument}

Get the DOM document.
Inherited From:
Source:
Returns:
Document object
Type
HTMLDocument

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

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

getElementWindow() → {Window}

Get the DOM window.
Inherited From:
Source:
Returns:
Window object
Type
Window

getName() → {string}

Get the symbolic name of the page.
Source:
Returns:
Symbolic name of page
Type
string

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

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

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

isElementAttached() → {boolean}

Check if the element is attached to the DOM
Inherited From:
Source:
Returns:
The element is attached to the DOM
Type
boolean

isVisible() → {boolean}

Check if element is visible.
Inherited From:
Source:
Returns:
element is visible
Type
boolean

(protected) restorePreInfuseState(state)

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:

scrollElementIntoView(configopt) → {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

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 Description
active boolean Page is active
Source:
Fires:

setData(data)

Set element data.
Parameters:
Name Type Description
data Mixed Element data
Inherited From:
Source:

setElementGroup(group)

Set group element is in.
Parameters:
Name Type Description
group OO.ui.mixin.GroupElement | null Group element, null if none
Inherited From:
Source:

setElementId(id)

Set the element has an 'id' attribute.
Parameters:
Name Type Description
id string
Inherited From:
Source:

setOutlineItem(outlineItem)

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:

setupOutlineItem(outlineItem)

Set up the outline item. Use 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.
Parameters:
Name Type Description
outlineItem OO.ui.OutlineOptionWidget Outline option widget to set up
Source:

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

toggle(showopt)

Toggle visibility of an element.
Parameters:
Name Type Attributes Description
show boolean <optional>
Make element visible, omit to toggle visibility
Inherited From:
Source:
Fires:
  • event:visible

updateThemeClasses()

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