Caplin Trader 5.0.0

Class: module:br-workbench/ui/WorkbenchPanel

module:br-workbench/ui/WorkbenchPanel(String, int, boolean)

A WorkbenchPanel is the main container for displaying components within a workbench. Workbench panels can be added to a WorkbenchPanel, either to the left or right side of the screen.

Constructor

new module:br-workbench/ui/WorkbenchPanel(String, int, boolean)

Parameters:
Name Type Description
String

sOrientation Either "left" or "right"
int

nWidth The width of the WorkbenchPanel in Pixels
boolean

bXResizable If True, the panel will be resizable.

Methods

add(workbenchComponent, title, collapsed)

Adds a module:br-workbench/ui/WorkbenchComponent to this panel.

Parameters:
Name Type Description
workbenchComponent WorkbenchPanelComponent

The component to add.
title String

The title to display for the component.
collapsed boolean

if True, the initial state of the component will be collapsed.

getComponentContainerId()

Returns the id of the element that represents the container which components will be added to within this WorkbenchPanel.

Returns:

the container id

getHeightOffset() → {int}

Returns the offset height of this panel

Returns:

The total height of the WorkbenchPanel including padding and borders in pixels.

Type
int

getOuterWidth() → {int}

Returns the outer width of this workbench panel.

Returns:

The total width of the WorkbenchPanel including padding and borders in pixels

Type
int

getWidth() → {int}

Returns the width of this panel.

Returns:

The inner width of the WorkbenchPanel in pixels

Type
int

setWidth(width)

Sets the width of this panel.

Parameters:
Name Type Description
width int

The width of the WorkbenchPanel in Pixels.