Class idx.app.TabMenuLauncher

Extends dijit._TemplatedMixin, idx.app._Launcher.
TabMenuLauncher widget encapsulates the primary tabs described by the Vienna guidelines and acts as a container. A future enhancement to this widget may provide the Open menu pictured in the Vienna guidelines, but currently the variation with the Open menu is not supported in order to ease transition to IBM One UI since IBM One UI does not currently have such a variant in application layout. This class contains a TabMenuDock and uses the Dojo StackContainer to switch between tabs.
Defined in: <idx\app\TabMenuLauncher.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	idx.app.TabMenuLauncher()

Field Summary

Field Attributes	Field Name and Description
	showMenu Indicates whether or not to show the menu for launching new tabs.
	showOverflow Indicates whether or not the overflow menu should ALWAYS be visible regardless if there is overflow.

Fields borrowed from class idx.app._Launcher:: defaultWorkspaceTypeID, resources, stateCookieName

Method Summary

Method Attributes	Method Name and Description
	buildRendering() Overridden to obtain CSS options before calling the base implementation.
	constructor(args, node) Constructor - currently does nothing
	getWorkspaces(workspaceTypeID) If the specified workspace type ID is provided, then this method returns an array of all workspace IDs for that workspace type.
	onFocus() Called when the widget gets focus.
	postMixInProperties() Overrides dijit._Widget.postMixInProperties(), calls the inherited method.
	resize(changeSize, resultSize) Resize the widget and its contained elements, using style attributes
	selectWorkspace(workspace) Workspace selection method.
	startup() Extends base method by attaching to the onWorkspaceSelected event to the private _onWorkspaceSelected method.
	workspaceLoaded(workspace, data) After the workspace is loaded make sure we tell the content stack to resize in order to force an update of the content on-screen.

Methods borrowed from class idx.app._Launcher:: closeWorkspace, destroy, getFailedLoadMessage, getLoadingMessage, getMaxOpenWorkspaceCount, getOpenWorkspaceCount, getWorkspace, getWorkspaceStyleClass, getWorkspaceTypeIDs, onWorkspaceSelected, openWorkspace, removeChild, selectFirstWorkspaceOfType

Constructor Detail

idx.app.TabMenuLauncher()

	   Example usage:
	   <div dojoType="idx.app.TabMenuLauncher" 
			 defaultWorkspaceTypeID="HOME" 
			 stateCookieName="idx.app.launcher">
	   			<div dojoType="idx.app.WorkspaceType"
	   				 workspaceTypeID="HOME" 
	   				 urlTemplate="tests/home.html" 
	   				 mixinArgs="{workspaceTypeName: 
	   				 resources.homeTabTitle}"/>
	   </div>

See:: idx.app.TabMenuDock

Field Detail

{boolean} showMenu

Indicates whether or not to show the menu for launching new tabs. This can be set to false to prevent showing when all the workspaces that can be directly opened are visible at startup. TODO: we currently ignore if set to true

Default Value:: false

{boolean} showOverflow

Indicates whether or not the overflow menu should ALWAYS be visible regardless if there is overflow. The overflow menu allows you to flip between open tabs whether or not they are visible. Typically, this menu will only appear if the need arises (i.e.: if there is not enough room to show all open tabs). TODO: we currently do not support the overflow menu, but the attribute exists

Default Value:: false

Method Detail

buildRendering()

Overridden to obtain CSS options before calling the base implementation. Sets options, design and sizing.

constructor(args, node)

Constructor - currently does nothing

Parameters:
{Object} args
{Object} node

getWorkspaces(workspaceTypeID)

If the specified workspace type ID is provided, then this method returns an array of all workspace IDs for that workspace type. If not provided, this returns an array of all workspace IDs in order of how they appear.

Parameters:
workspaceTypeID

onFocus()

Called when the widget gets focus. Forces focus to the contained idx.app.TabMenuDock object.

postMixInProperties()

Overrides dijit._Widget.postMixInProperties(), calls the inherited method.

See:: idx.app._Launcher.postMixInProperties

resize(changeSize, resultSize)

Resize the widget and its contained elements, using style attributes

Parameters:
{Object} changeSize
{Object} resultSize

selectWorkspace(workspace)

Workspace selection method. Selects the specified workspace with the contained tabDock and contentStack.

Parameters:
{idx.app.Workspace} workspace

See:: idx.app.Workspace}

startup()

Extends base method by attaching to the onWorkspaceSelected event to the private _onWorkspaceSelected method.

workspaceLoaded(workspace, data)

After the workspace is loaded make sure we tell the content stack to resize in order to force an update of the content on-screen.

Parameters:
{idx.app.Workspace} workspace
{Object} data

See:: idx.app.Workspace