Interface: module:caplin/component/frame/ComponentFrame

Methods

addToMenu(oMenu)

Adds additional menu items to the container menu.

Parameters:

Name	Type	Description
oMenu	module:caplin/menu/model/Menu	The additions to the menu.

Implementations:

• module:caplin/presenter/view/knockout/ComponentPluginFrame~ComponentPluginFrame#addToMenu

close()

Removes the component from view.

getComponent()

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

Implementations:

• module:caplin/presenter/view/knockout/ComponentPluginFrame~ComponentPluginFrame#getComponent

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

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

Implementations:

• module:caplin/presenter/view/knockout/ComponentPluginFrame~ComponentPluginFrame#getFrameManager

Returns:

the frame manager for this component frame.

Type

module:caplin/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.

Implementations:

• module:caplin/presenter/view/knockout/ComponentPluginFrame~ComponentPluginFrame#getMenu

getTitleBarElement()

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

Implementations:

• module:caplin/presenter/view/knockout/ComponentPluginFrame~ComponentPluginFrame#getTitleBarElement

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:caplin/component/Component#getSerializedState method.

Implementations:

• module:caplin/presenter/view/knockout/ComponentPluginFrame~ComponentPluginFrame#setComponentModified

setTitle(sTitle)

Set the title for the frame.

Parameters:

Name	Type	Description
sTitle	String	The title to set for the component.

Implementations:

• module:caplin/presenter/view/knockout/ComponentPluginFrame~ComponentPluginFrame#setTitle