PanelManager class

The PanelManager class is used to manage a panel for such things as loading a panel, changing a panel state, and destroying a panel.

Example:

require(["jimu/ PanelManager "], function(PanelManager) { 
  var pm = PanelManager.getInstance();
});

Methods

getInstance()

A static method that returns the singleton object.

Return type: No return.

showPanel (widgetJson/groupJson)

Loads and opens a panel depending on the widget or group configuration.

Parameters:

widgetJson/groupJson: The widget or group JSON object configured in the app’s config.json file.

Return type: Deferred object. When the load succeeds, the panel object is resolved.

openPanel

Opens a loaded panel. It changes the panel state to open and calls the panel onOpen method. If the panel does not load, it does nothing.

Parameters:

panelID or panel instance object.

Return type: No return.

closePanel

Closes a loaded panel. It changes the panel state to closed and calls the panel onClose method. If the panel does not load, it does nothing.

Parameters:

panelID or panel instance object.

Return type: No return.

minimizePanel

Minimizes a loaded panel. It changes the panel state to minimized and calls the panel onMinimize method. If the panel does not load, it does nothing.

Parameters:

panelID or panel instance object.

Return type: No return.

maximizePanel

Maximizes a loaded panel. It changes the panel state to maximized and calls the panel onMaximize method. If the panel does not load, it does nothing.

Parameters:

panelID or panel instance object.

Return type: No return.

normalizePanel

Normalizes a loaded panel. It changes the panel state to normal and calls the panel onNormalize method. If the panel does not load, it does nothing.

Parameters:

panelID or panel instance object.

Return type: No return.

getPanelById(panelId)

Returns the panel identified by the panel ID. If the panel does not load, it returns undefined.

Parameters:

panelId: The panel ID.

Return type: Panel object.

destroyPanel(panel)

Destroys the panel.

Parameters:

panelID or panel instance object.

Return type: No return.

destroyAllPanels

Destroys all loaded panels.

Return type: No return.

In this topic
  1. Methods
We'd love to hear your feedback

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.