Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Interface
caplin.component.frame

ComponentFrame

The class is still in Beta and is subject to API changes.
Instances of ComponentFrame are used to wrap components before they are displayed on the screen. These are created automatically when either caplin.component.frame.FrameManager#addPanelToLayout or caplin.component.frame.FrameManager#openDialog are invoked, but may also be created by composite components that embed other components within them.

Constructor Summary

Attributes Name and Description
caplin.component.frame.ComponentFrame()

Method Summary

Attributes Name and Description
void addToMenu(caplin.menu.model.Menu oMenu)

Adds additional menu items to the container menu.
void close()

Removes the component from view.
caplin.component.Component getComponent()

Returns a reference to the component being wrapped by this frame.
caplin.component.frame.FrameManager getFrameManager()

Returns a reference to the top-level frame manager instance that can be used to display more frame items.
caplin.menu.model.Menu getMenu()

Returns a container provided menu for this component.
DOMElement getTitleBarElement()

Access the HTML element that contains the title bar for this frame.
void setComponentModified(boolean bIsModified)

Allows a component to indicate that it's has been modified, and requires persistence.
void setTitle(String sTitle)

Set the title for the frame.

Constructor Detail

► caplin.component.frame.ComponentFrame()

Method Detail

► void addToMenu(caplin.menu.model.Menu oMenu)

Adds additional menu items to the container menu.

Parameters
caplin.menu.model.Menu oMenu The additions to the menu.

► void close()

Removes the component from view.

► caplin.component.Component getComponent()

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

► caplin.component.frame.FrameManager getFrameManager()

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

Returns
the frame manager for this component frame.

► caplin.menu.model.Menu 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.

► DOMElement getTitleBarElement()

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

► void setComponentModified(boolean 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
boolean bIsModified Whether there has been a state change since the last invocation of the component's caplin.component.Component#getSerializedState method.

► void setTitle(String sTitle)

Set the title for the frame.

Parameters
String sTitle The title to set for the component.