Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.workbench.ui

WorkbenchPanel

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

Constructor Summary

Attributes Name and Description
caplin.workbench.ui.WorkbenchPanel( String, int, boolean)

Method Summary

Attributes Name and Description
void add(caplin.workbench.ui.WorkbenchComponent oWorkbenchComponent, String sTitle, boolean bCollapsed)

Adds a caplin.workbench.ui.WorkbenchComponent to this panel.
String getComponentContainerId()

Returns the id of the element that represents the container which components will be added to within this WorkbenchPanel
int getHeightOffset()

Returns the offset height of this panel
int getOuterWidth()

Returns the outer width of this workbench panel.
int getWidth()

Returns the width of this panel.
void setWidth(int nWidth)

Sets the width of this panel.

Constructor Detail

► caplin.workbench.ui.WorkbenchPanel( String, int, boolean)

Parameters
String sOrientation Either "left" or "right"
int nWidth The width of the WorkbenchPanel in Pixels
boolean bXResizable If True, the panel will be resizable.

Method Detail

► void add(caplin.workbench.ui.WorkbenchComponent oWorkbenchComponent, String sTitle, boolean bCollapsed)

Adds a caplin.workbench.ui.WorkbenchComponent to this panel.

Parameters
caplin.workbench.ui.WorkbenchComponent oWorkbenchComponent The component to add.
String sTitle The title to display for the component.
boolean bCollapsed if True, the initial state of the component will be collapsed.

► String getComponentContainerId()

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

Returns
the container id

► int getHeightOffset()

Returns the offset height of this panel

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

► int getOuterWidth()

Returns the outer width of this workbench panel.

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

► int getWidth()

Returns the width of this panel.

Returns
nWidth The inner width of the WorkbenchPanel in pixels

► void setWidth(int nWidth)

Sets the width of this panel.

Parameters
int nWidth The width of the WorkbenchPanel in Pixels