Options
All
  • Public
  • Public/Protected
  • All
Menu

External module Tabbing

Index

Modules

Interfaces

Functions

Functions

addTab

  • addTab(targetWindow: Identity, windowToAdd?: Identity): Promise<void>

  • Adds current window context (or window specified in second arg) to the tab group of the target window (first arg).

    Will reject with an error if the TabClient of the target and context tab group do not match.

    The added tab will be brought into focus.

    Parameters

    • targetWindow: Identity
    • Default value windowToAdd: Identity = getId()

    Returns Promise<void>

closeTab

  • closeTab(window?: Identity): Promise<void>

  • Closes the tab for the window context and removes it from the associated tab group.

    Parameters

    • Default value window: Identity = getId()

    Returns Promise<void>

closeTabGroup

  • closeTabGroup(window?: Identity): Promise<void>

  • Closes the tab group for the window context.

    Parameters

    • Default value window: Identity = getId()

    Returns Promise<void>

createTabGroup

  • createTabGroup(windows: Identity[]): Promise<void>

  • Given a set of windows, will create a tab group construct and UI around them. The bounds and positioning of the first (applicable) window in the set will be used as the seed for the tab UI properties.

    Parameters

    • windows: Identity[]

    Returns Promise<void>

getTabs

  • Returns array of window references for tabs belonging to the tab group of the provided window context.

    If no Identity is provided as an argument, the current window context will be used.

    If there is no tab group associated with the window context, will resolve to null.

    Parameters

    • Default value window: Identity = getId()

    Returns Promise<WindowIdentity[] | null>

maximizeTabGroup

  • maximizeTabGroup(window?: Identity): Promise<void>

  • Maximizes the tab group for the window context.

    Parameters

    • Default value window: Identity = getId()

    Returns Promise<void>

minimizeTabGroup

  • minimizeTabGroup(window?: Identity): Promise<void>

  • Minimizes the tab group for the window context.

    Parameters

    • Default value window: Identity = getId()

    Returns Promise<void>

removeTab

  • removeTab(window?: Identity): Promise<void>

  • Removes the specified tab from its tab group. Uses current window context by default

    Parameters

    • Default value window: Identity = getId()

    Returns Promise<void>

restoreTabGroup

  • restoreTabGroup(window?: Identity): Promise<void>

  • Restores the tab group for the window context to its normal state.

    Parameters

    • Default value window: Identity = getId()

    Returns Promise<void>

setActiveTab

  • setActiveTab(window?: Identity): Promise<void>

  • Brings the specified tab to the front of the set.

    Parameters

    • Default value window: Identity = getId()

    Returns Promise<void>

setTabClient

  • If a custom tab-strip UI is being used - this sets the URL for the tab-strip. This binding happens on the application level. An application cannot have different windows using different tabbing UI.

    Parameters

    Returns Promise<void>