Caplin Trader 5.1.0

Interface: module:ct-component/frame/DialogFrame

module:ct-component/frame/DialogFrame

Extends

Methods

addToMenu(oMenu)

Adds additional menu items to the container menu.

Parameters:
Name Type Description
oMenu module:ct-menu/model/Menu

The additions to the menu.
Inherited From:

close()

Removes the component from view.

Inherited From:

getComponent()

Returns a reference to the component being wrapped by this frame.

Inherited From:

getFrameManager() → {module:ct-component/frame/FrameManager}

Returns a reference to the top-level frame manager instance that can be used to display more frame items.

Inherited From:
Returns:

the frame manager for this component frame.

Type
module:ct-component/frame/FrameManager

getMenu()

Returns a container provided menu for this component.

Components that need to expose a menu of commands to the user may do so by using the container provided menu. Components that use decorators to augment their behaviour may be sharing access to the menu with other decorators that use this functionality.

Inherited From:

getTitleBarElement()

Access the HTML element that contains the title bar for this frame.

Inherited From:

resize(nWidth, nHeight)

Resize the dialog window.

Parameters:
Name Type Description
nWidth int

The new width of the dialog.
nHeight int

The new height of the dialog.

setClosable(bClosable)

Sets whether the dialog can be closed or not.

Parameters:
Name Type Description
bClosable boolean

True if the dialog can be closed, false otherwise.

setComponentModified(bIsModified)

Allows a component to indicate that it's has been modified, and requires persistence.

Components that initially require persistence, but later no longer require it (e.g. due to the use of the client undoing their previous actions) can indicate this by setting the bIsModified parameter to false.

Parameters:
Name Type Description
bIsModified boolean

Whether there has been a state change since the last invocation of the component's module:ct-component/Component#getSerializedState method.
Inherited From:

setHeading(sHeading)

Sets the heading text for the dialog frame.

Parameters:
Name Type Description
sHeading String

the text which heading will be set to.

setSubHeading(sSubHeading)

Sets the sub heading text for the dialog frame.

Parameters:
Name Type Description
sSubHeading String

the text which sub-heading will be set to.

setTitle(sTitle)

Set the title for the frame.

Parameters:
Name Type Description
sTitle String

The title to set for the component.
Inherited From: