Methods
add
Adds additional menu items to the container menu.
Parameters:
| Name | Type | Description |
|---|---|---|
oMenu |
module:ct-menu |
The additions to the menu. |
close()
Removes the component from view.
get
Returns a reference to the component being wrapped by this frame.
get
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.
get
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.
get
Access the HTML element that contains the title bar for this frame.
set
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 |
set
Set the title for the frame.
Parameters:
| Name | Type | Description |
|---|---|---|
sTitle |
String | The title to set for the component. |