Packagecom.adobe.bridge
Classpublic class TabbedPalette
InheritanceTabbedPalette Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Allows a script to define and add a tabbed palette to a browser window. A script-defined palette is displayed in addition to the default palettes such as Favorites, Folders, Preview, Filter, Keywords, and Metadata. A script-defined palette can display a user interface defined in ScriptUI, or it can display HTML. You can add a palette to an existing browser window at any time (as long as the identifier is unique), and you can use the create document event to add your palette to new browser windows on creation. The name of a script-defined palette is automatically added to all relevant menus. You can specify where the tab goes, or move it programmatically. When it is shown, it can be dragged and dropped like the default palettes; scripts cannot query the current position.. You can show and hide individual palettes using this object's properties. A list of all defined palettes for a browser, including default palettes, is available in app.document.palettes.



Public Properties
 PropertyDefined By
  content : Object
[read-only] When type is script, the ScriptUI Window object to display.
TabbedPalette
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : String
A non-localized unique identifier for the palette.
TabbedPalette
  showMenuItem : Boolean
TabbedPalette
  title : String
The localized string to display as the palette title.
TabbedPalette
  type : String
[read-only] The type of content displayed in the palette; script (ScriptUI) or web (HTML).
TabbedPalette
  url : String
When type is web, the path to the page to display.
TabbedPalette
  visible : Boolean
When true, this palette is visible, when false it is hidden.
TabbedPalette
Public Methods
 MethodDefined By
  
TabbedPalette(document:Document = null, title:String = null, id:String = null, type:String = null, url:String = null)
TabbedPalette
 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
  
remove():void
Removes this palette from the list of available palettes and destroys it.
TabbedPalette
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
Moves this palette to a specific docking location in the browser.
TabbedPalette
 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]
TabbedPalette
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
contentproperty
content:Object  [read-only]

Since : CS5

When type is script, the ScriptUI Window object to display.


Implementation
    public function get content():Object
idproperty 
id:String

Since : CS5

A non-localized unique identifier for the palette.


Implementation
    public function get id():String
    public function set id(value:String):void
showMenuItemproperty 
showMenuItem:Boolean

Since : CS5


Implementation
    public function get showMenuItem():Boolean
    public function set showMenuItem(value:Boolean):void
titleproperty 
title:String

Since : CS5

The localized string to display as the palette title.


Implementation
    public function get title():String
    public function set title(value:String):void
typeproperty 
type:String  [read-only]

Since : CS5

The type of content displayed in the palette; script (ScriptUI) or web (HTML).


Implementation
    public function get type():String
urlproperty 
url:String

Since : CS5

When type is web, the path to the page to display.


Implementation
    public function get url():String
    public function set url(value:String):void
visibleproperty 
visible:Boolean

Since : CS5

When true, this palette is visible, when false it is hidden.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Constructor Detail
TabbedPalette()Constructor
public function TabbedPalette(document:Document = null, title:String = null, id:String = null, type:String = null, url:String = null)

Since : CS5

Parameters
document:Document (default = null) — (Document)
 
title:String (default = null) — (String)
 
id:String (default = null) — (String)
 
type:String (default = null) — (String)
 
url:String (default = null) — (String)
Method Detail
createWithArgs()method
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array

remove()method 
public function remove():void

Since : CS5

Removes this palette from the list of available palettes and destroys it.

setLocation()method 
public function setLocation():void

Since : CS5

Moves this palette to a specific docking location in the browser.