Caplin Trader 5.0.0

Class: module:br-workbench/ui/Workbench

module:br-workbench/ui/Workbench(nLeftWidth, nRightWidth)

Represents a UI component for displaying workbenches. A workbench contains left and right module:br-workbench/ui/WorkbenchPanels to which module:br-workbench/ui/WorkbenchComponent components can be added.

Constructor

new module:br-workbench/ui/Workbench(nLeftWidth, nRightWidth)

Parameters:
Name Type Description
nLeftWidth int

The width of the left panel in pixels.

nRightWidth int

The width of the right panel in pixels.

Methods

addToLeftWing(oWorkbenchComponent, sTitle, bCollapsed)

Adds a component to the left wing.

Parameters:
Name Type Description
oWorkbenchComponent WorkbenchComponent

The component to add.

sTitle String

The title to show for the component.

bCollapsed boolean

If true, the component will be collapsed.

addToRightWing(oWorkbenchComponent, sTitle, bCollapsed)

Adds a component to the right wing.

Parameters:
Name Type Description
oWorkbenchComponent WorkbenchComponent

The component to add.

sTitle String

The title to show for the component.

bCollapsed boolean

If true, the component will be collapsed.

center(eElement)

Centers the specified element so that it is evenly spaced between the 2 side panels.

Parameters:
Name Type Description
eElement DOMElement

The element (usually the workbench component element) to center.

See: