Class orion.webui.Splitter

A splitter manages the layout of two panels, a side panel and a main panel.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/webui/splitter.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	orion.webui.Splitter(options) Constructs a new Splitter with the given options.

Method Summary
Method Attributes	Method Name and Description
	addEventListener(type, listener, useCapture) Adds an event listener to this event target.
	addResizeListener(listener) Adds an event listener for resizing the main and side panels.
	dispatchEvent(evt) Dispatches the given event to the listeners added to this event target.
	isClosed()
	openSidePanel() Close the side panel.
	removeEventListener(type, listener, useCapture) Removes an event listener from the event target.
	toggleSidePanel() Toggle the open/closed state of the side panel.

Class Detail

orion.webui.Splitter(options)

Constructs a new Splitter with the given options. A splitter manages the layout of two panels, a side panel and a main panel. An optional toggle button can open or close the side panel.

The relative proportions of the side and main panels are determined by the initial style of the splitter bar in the document. The panels will pin themselves to the splitter by default. Once the user moves the splitter, the positions are remembered.

By default, a splitter is open. The client can create a closed splitter by setting a data-initial-state attribute with value "closed" on the splitter's node element.

Parameters:
{Object} options: The options object which must specify the split dom node
{Element} options.node: The node for the splitter presentation. Required.
{Element} options.sidePanel: The node for the side (toggling) panel. Required.
{Element} options.mainPanel: The node for the main panel. Required.
{Boolean} options.toggle Optional, Default: false: Specifies that the side node should be able to toggle.
{Boolean} options.vertical Optional, Default: false: Specifies that the nodes are stacked vertically rather than horizontal.
{Boolean} options.closeReversely Optional, Default: false: Specifies that the splitter moves to right when nodes are stacked horizontally, or to bottom when nodes are stacked vertically.

Method Detail

addEventListener(type, listener, useCapture)

Adds an event listener to this event target.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.

Parameters:
{String} type: The event type.
{Function|EventListener} listener: The function or the EventListener that will be executed when the event happens.
{Boolean} useCapture Optional, Default: false: true if the listener should be trigged in the capture phase.

See:: orion.editor.EventTarget#removeEventListener

addResizeListener(listener)

Adds an event listener for resizing the main and side panels.

Parameters:
{Function} listener: The function called when a resize occurs. The DOM node that has been resized is passed as an argument.

Deprecated:
use addEventListener instead

dispatchEvent(evt)

Dispatches the given event to the listeners added to this event target.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.

Parameters:
{Event} evt: The event to dispatch.

isClosed()

openSidePanel()

Close the side panel. This function has no effect if the side panel is already closed.

removeEventListener(type, listener, useCapture)

Removes an event listener from the event target.

All the parameters must be the same ones used to add the listener.

Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.

Parameters:
{String} type: The event type
{Function|EventListener} listener: The function or the EventListener that will be executed when the event happens.
{Boolean} useCapture Optional, Default: false: true if the listener should be trigged in the capture phase.

See:: orion.editor.EventTarget#addEventListener

toggleSidePanel()

Toggle the open/closed state of the side panel.

Classes

Class orion.webui.Splitter