Packagecom.adobe.bridge
Classpublic class InspectorPanel
InheritanceInspectorPanel Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Your script defines what kind of related information to display, and how to display it. The panel serves as a frame and parent for subpanels that actually display the information. Subpanels are represented by members of the Panelette Base Class contained in this parent panel. Register a inspection panel that you create to make it available to Adobe Bridge, using app.registerInspectorPanel(). To turn the display of registered inspection panels on or off in a particular browser window, set Document.displayInspectorView.



Public Properties
 PropertyDefined By
  displayInInspector : Boolean
Whether to display this panel.
InspectorPanel
  displayTitle : String
[read-only] The localized title string to display in the panel's tab header.
InspectorPanel
  flyoutMenuId : String
[read-only] The unique menu identifier of a script-defined flyout menu for this panel.
InspectorPanel
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  minimized : Boolean
When true, the panel is minimized or iconified.
InspectorPanel
  panelettes : Array
[read-only] A collection of panelettes contained in this panel, in display order.
InspectorPanel
  sortPosition : Number
The preferred default position of this tabbed panel in the Inspector, relative to other panels.
InspectorPanel
  title : String
The title text of this panel, displayed in the tab header.
InspectorPanel
  visible : Boolean
[read-only] When true, the majority of this panel is visible on the screen.
InspectorPanel
  wide : Boolean
When true, this panel occupies the entire available horizontal space.
InspectorPanel
Public Methods
 MethodDefined By
  
InspectorPanel(title:String = null, displayTitle:String = null, isVisible:Boolean = false, isWide:Boolean = false, orderID:Number)
InspectorPanel
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
registerPanelette(panelette:Object):Boolean
Registers a script-defined panelette as a member of this panel, adding it to panelettes list.
InspectorPanel
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
unregisterPanelette(panelette:Object):Boolean
Removes a member panelette from this panel.
InspectorPanel
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
  
createWithArgs(args:Array):void
[override]
InspectorPanel
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
displayInInspectorproperty
displayInInspector:Boolean

Since : CS5

Whether to display this panel.


Implementation
    public function get displayInInspector():Boolean
    public function set displayInInspector(value:Boolean):void
displayTitleproperty 
displayTitle:String  [read-only]

Since : CS5

The localized title string to display in the panel's tab header.


Implementation
    public function get displayTitle():String
flyoutMenuIdproperty 
flyoutMenuId:String  [read-only]

Since : CS5

The unique menu identifier of a script-defined flyout menu for this panel.


Implementation
    public function get flyoutMenuId():String
minimizedproperty 
minimized:Boolean

Since : CS5

When true, the panel is minimized or iconified.


Implementation
    public function get minimized():Boolean
    public function set minimized(value:Boolean):void
panelettesproperty 
panelettes:Array  [read-only]

Since : CS5

A collection of panelettes contained in this panel, in display order.


Implementation
    public function get panelettes():Array
sortPositionproperty 
sortPosition:Number

Since : CS5

The preferred default position of this tabbed panel in the Inspector, relative to other panels.


Implementation
    public function get sortPosition():Number
    public function set sortPosition(value:Number):void
titleproperty 
title:String

Since : CS5

The title text of this panel, displayed in the tab header.


Implementation
    public function get title():String
    public function set title(value:String):void
visibleproperty 
visible:Boolean  [read-only]

Since : CS5

When true, the majority of this panel is visible on the screen.


Implementation
    public function get visible():Boolean
wideproperty 
wide:Boolean

Since : CS5

When true, this panel occupies the entire available horizontal space.


Implementation
    public function get wide():Boolean
    public function set wide(value:Boolean):void
Constructor Detail
InspectorPanel()Constructor
public function InspectorPanel(title:String = null, displayTitle:String = null, isVisible:Boolean = false, isWide:Boolean = false, orderID:Number)

Since : CS5

Parameters
title:String (default = null) — (String)
 
displayTitle:String (default = null) — (String)
 
isVisible:Boolean (default = false) — (Boolean)
 
isWide:Boolean (default = false) — (Boolean)
 
orderID:Number (default = NaN) — (Number)
Method Detail
createWithArgs()method
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array

registerPanelette()method 
public function registerPanelette(panelette:Object):Boolean

Since : CS5

Registers a script-defined panelette as a member of this panel, adding it to panelettes list.

Parameters

panelette:Object — (Object)

Returns
Boolean
unregisterPanelette()method 
public function unregisterPanelette(panelette:Object):Boolean

Since : CS5

Removes a member panelette from this panel.

Parameters

panelette:Object — (Object)

Returns
Boolean