const PluginPanelView = brackets.getModule("view/PluginPanelView")Kind: global class
- Panel
- new Panel($panel, id, $toolbarIcon, [minWidth], [initialSize])
- .$panel :
jQueryObject - .isVisible() ⇒
boolean - .registerCanBeShownHandler(canShowHandlerFn) ⇒
boolean - .canBeShown() ⇒
boolean - .show()
- .hide()
- .setVisible(visible)
- .getPanelType() ⇒
string
Represents a panel below the editor area (a child of ".content").
| Param | Type | Description |
|---|---|---|
| $panel | jQueryObject |
The entire panel, including any chrome, already in the DOM. |
| id | string |
Unique id for this panel. Use package-style naming, e.g. "myextension.panelname". will overwrite an existing panel id if present. |
| $toolbarIcon | jQueryObject |
An icon that should be present in main-toolbar to associate this panel to. The panel will be shown only if the icon is visible on the toolbar and the user clicks on the icon. |
| [minWidth] | number |
Minimum width of panel in px. |
| [initialSize] | number |
Optional Initial size of panel in px. If not given, panel will use minsize or current size. |
Dom node holding the rendered panel
Kind: instance property of Panel
Determines if the panel is visible
Kind: instance method of Panel
Returns: boolean - true if visible, false if not
Registers a call back function that will be called just before panel is shown. The handler should return true if the panel can be shown, else return false and the panel will not be shown.
Kind: instance method of Panel
Returns: boolean - true if visible, false if not
| Param | Type | Description |
|---|---|---|
| canShowHandlerFn | function | null |
function that should return true of false if the panel can be shown/not. or null to clear the handler. |
Returns true if th panel can be shown, else false.
Kind: instance method of Panel
Shows the panel
Kind: instance method of Panel
Hides the panel
Kind: instance method of Panel
Sets the panel's visibility state
Kind: instance method of Panel
| Param | Type | Description |
|---|---|---|
| visible | boolean |
true to show, false to hide |
gets the Panel's type
Kind: instance method of Panel
EVENT_PANEL_HIDDEN : string
Event when panel is hidden
Event when panel is shown
type for plugin panel
Kind: global constant