PanelView.md

Import :

const PanelView = brackets.getModule("view/PanelView")

Panel

Kind: global class

• Panel
  • new Panel($panel, id, [title])
  • .$panel : jQueryObject
  • .isVisible() ⇒ boolean
  • .registerCanBeShownHandler(canShowHandlerFn) ⇒ boolean
  • .canBeShown() ⇒ boolean
  • .show()
  • .hide()
  • .setVisible(visible)
  • .setTitle(newTitle)
  • .destroy()
  • .getPanelType() ⇒ string

new Panel($panel, id, [title])

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 panel identifier.
[title]	string	Optional display title for the tab bar.

panel.$panel : jQueryObject

Dom node holding the rendered panel

Kind: instance property of Panel

panel.isVisible() ⇒ boolean

Determines if the panel is visible

Kind: instance method of Panel
Returns: boolean - true if visible, false if not

panel.registerCanBeShownHandler(canShowHandlerFn) ⇒ boolean

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.

panel.canBeShown() ⇒ boolean

Returns true if th panel can be shown, else false.

Kind: instance method of Panel

panel.show()

Shows the panel

Kind: instance method of Panel

panel.hide()

Hides the panel

Kind: instance method of Panel

panel.setVisible(visible)

Sets the panel's visibility state

Kind: instance method of Panel

Param	Type	Description
visible	boolean	true to show, false to hide

panel.setTitle(newTitle)

Updates the display title shown in the tab bar for this panel.

Kind: instance method of Panel

Param	Type	Description
newTitle	string	The new title to display.

panel.destroy()

Destroys the panel, removing it from the tab bar, internal maps, and the DOM. After calling this, the Panel instance should not be reused.

Kind: instance method of Panel

panel.getPanelType() ⇒ string

gets the Panel's type

Kind: instance method of Panel

_panelMap : Object.<string, Panel>

Maps panel ID to Panel instance

Kind: global variable

_$container : jQueryObject

The single container wrapping all bottom panels

Kind: global variable

_$tabBar : jQueryObject

The tab bar inside the container

Kind: global variable

_$tabsOverflow : jQueryObject

Scrollable area holding the tab elements

Kind: global variable

_openIds : Array.<string>

Ordered list of currently open (tabbed) panel IDs

Kind: global variable

_activeId : string | null

The panel ID of the currently visible (active) tab

Kind: global variable

EVENT_PANEL_HIDDEN : string

Event when panel is hidden

Kind: global constant

EVENT_PANEL_SHOWN : string

Event when panel is shown

Kind: global constant

PANEL_TYPE_BOTTOM_PANEL : string

type for bottom panel

Kind: global constant

init($container, $tabBar, $tabsOverflow)

Initializes the PanelView module with references to the bottom panel container DOM elements. Called by WorkspaceManager during htmlReady.

Kind: global function

Param	Type	Description
$container	jQueryObject	The bottom panel container element.
$tabBar	jQueryObject	The tab bar element inside the container.
$tabsOverflow	jQueryObject	The scrollable area holding tab elements.

getOpenBottomPanelIDs() ⇒ Array.<string>

Returns a copy of the currently open bottom panel IDs in tab order.

Kind: global function

hideAllOpenPanels() ⇒ Array.<string>

Hides every open bottom panel tab in a single batch

Kind: global function Returns: Array.<string> - The IDs of panels that were open (useful for restoring later).