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.
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 specified type of UI and with the options provided
in
options . |
options
.
- Parameters:
- {String} ui
- The type of user interface to be shown. Currently
"list"
and"browser"
are supported. - {Object} options
- A map containing configuration options for the UI.
For a
"list"
user interface, the followingoptions
are supported:- columns
- span
var options = { 'columns': [ { 'title' : 'From', 'property' : 'from' }, { 'title' : 'When', 'property' : 'when' } ], 'span' : { 'rows' : 3, 'property' : 'summary' } };
The
columns
option is an array of column definitions. Each column definition consists of two values:title
(the column title) andproperty
(the column's identifier, used when adding values to the list). Thespan
option can be used to add a larger list entry that spans all the columns in the list. It consists of two values:rows
(the maximum number of rows spanned entries can occupy) andproperty
(the column's identifier, used when adding values to the list).For a
"browser"
user interface, nooptions
are required.
- Returns:
- An object representing the specified user interface:
- A MapListModel object for
"list"
user interfaces. - A BrowserModel object for
"browser"
user interfaces.
- A MapListModel object for