cp.apple.finalcutpro.inspector.BasePanel.md

docs » cp.apple.finalcutpro.inspector.BasePanel

---

A base class for the different panels in the Inspector.

Extends Element.

API Overview

• Constructors - API calls which return an object, typically one that offers API methods
• BasePanel
• Methods - API calls which can only be made on an object returned by a constructor
• doShow
• hide
• panelType
• show

API Documentation

Constructors

BasePanel

Signature	cp.apple.finalcutpro.inspector.BasePanel(parent, panelType) -> BasePanel
Type	Constructor
Description	Constructs the panel, initialising the parent and the UI.
Parameters	parent - The parent Element. panelType - The panel type string, as defined in Inspector.INSPECTOR_TABS.
Returns	The new BasePanel instance.

Methods

doShow

Signature	cp.apple.finalcutpro.inspector.BasePanel:doShow() -> cp.rx.go.Statment
Type	Method
Description	A Statement that hides the panel.
Parameters	None
Returns	The Statement, resolving to true if successful and sending an error if not.

hide

Signature	cp.apple.finalcutpro.inspector.BasePanel:hide() -> none
Type	Method
Description	Hides the panel.
Parameters	None
Returns	None

panelType

Signature	cp.apple.finalcutpro.inspector.BasePanel:panelType() -> string
Type	Method
Description	Gets the type of panel this is.
Returns	The panel type identifier.

show

Signature	cp.apple.finalcutpro.inspector.BasePanel:show() -> none
Type	Method
Description	Shows the panel.
Parameters	None
Returns	None