Class PanelControl
Identifies a panel, and provides a UI construction facility.
Instances of this class are passed as arguments to the
panel-* events from content-studio.
It allows extensions to identify panel events, and to
initialize a UI inside a particular panel.
Defined in: builtins.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
This class is typically only instantiated by Content Studio.
|
| Field Attributes | Field Name and Description |
|---|---|
|
The (full) URI of the panel in question.
|
| Method Attributes | Method Name and Description |
|---|---|
|
show(ui, options)
Initialize the panel with the given type of UI with options provided
in
options. |
Field Detail
{String}
uri
The (full) URI of the panel in question. Used to distinguish
panel events from one another, and for cooperating extensions
that wish to share panels.
Method Detail
show(ui, options)
Initialize the panel with the given type of UI with options provided
in
options. Currently, only simple list UIs are
supported. The object returned from the method represents the UI
created, allowing further interaction with the UI.
- Parameters:
- {String} ui
- The type of user interface to be shown. Currently, only
"list"is supported. - {Object} options
- an object with configuration options for the UI.
- Returns:
- An object representing the UI.