Caplin Trader 5.1.0

Interface: module:ct-component/frame/FrameManager

module:ct-component/frame/FrameManager

The FrameManager interface allows module:ct-component/Component instances to be viewed within the application. While the end-developer may wish to write or configure their own Component instances, it is the frame managers responsibility to create the implementations of module:ct-component/frame/PanelFrame and module:ct-component/frame/DialogFrame that these components must be placed within, before they can be viewed and interacted with by the user on screen.

Methods

addPanelToLayout(oComponent, sCaption, oFrameCreationListener)

Display a component as part of the main page or application.

Parameters:
Name Type Description
oComponent module:ct-component/Component

The component to be added.

sCaption String

The caption for the new panel.

oFrameCreationListener module:ct-component/frame/FrameCreationListener

A listener that will be provided with a reference to the module:ct-component/frame/DialogFrame that will wrap this component.

openDialog(oComponent, sCaption, nWidth, nHeight, oFrameCreationListener)

Display a component within a floating dialog on screen.

Parameters:
Name Type Description
oComponent module:ct-component/Component

The component to be displayed.

sCaption String

The caption for the floating dialog window.

nWidth int

The initial width of the dialog.

nHeight int

The initial height of the dialog.

oFrameCreationListener module:ct-component/frame/FrameCreationListener

A listener that will be provided with a reference to the module:ct-component/frame/DialogFrame that will wrap this component.