| Package | ga.model |
| Interface | public interface IPanelItem extends IUIComponent , IStyleClient , IFlexDisplayObject , ISimpleStyleClient , IBitmapDrawable , IEventDispatcher |
| Implementors | PanelItem |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
IPanelItem interface is implemented by components that are passed as inputs
into the LayoutTemplate class.
Each panel layout is a component created in Flex Builder that is available in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0. Panel layouts are based on the Layout Template class, support scripting, and are passed an array of panel items, each of which supports this interface, as inputs. Each panel item represents an object specified in the Guide tree.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | IFlexDisplayObject | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | IFlexDisplayObject | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | IUIComponent | |
| baseReferenceChain : BaseReferenceChain
Get chain of binding references for parent containers
| IPanelItem | ||
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | IFlexDisplayObject | |
| boundData : Object
The object in the data model to which this item is bound. | IPanelItem | ||
| boundName : String [read-only]
The name of the data object to which this item is bound. | IPanelItem | ||
| boundText : String
The value of the data object as a string. | IPanelItem | ||
| boundValue : Object
The value of the data object to which this item is bound. | IPanelItem | ||
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | IFlexDisplayObject | |
| caption : String
The caption or description of this item. | IPanelItem | ||
| className : String [read-only]
The name of the component class. | IStyleClient | |
| dataRef : String
The reference or address of the data node to which to bind this item. | IPanelItem | ||
| document : Object
A reference to the document object associated with this component. | IUIComponent | |
| enabled : Boolean
Whether the component can accept user interaction. | IUIComponent | |
| explicitHeight : Number
The explicitly specified height for the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMaxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMaxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMinHeight : Number [read-only]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMinWidth : Number [read-only]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitWidth : Number
The explicitly specified width for the component,
in pixels, as the component's coordinates. | IUIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | IFlexDisplayObject | |
| focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing the focus indicator. | IUIComponent | |
| height : Number
Indicates the height of the display object, in pixels. | IFlexDisplayObject | |
| helpText : String
The help text for this item. | IPanelItem | ||
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | IUIComponent | |
| inheritingStyles : Object
An object containing the inheritable styles for this component. | IStyleClient | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | IUIComponent | |
| keepWithPrevious : Boolean
Whether to keep this item with the previous item
| IPanelItem | ||
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | IFlexDisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | IFlexDisplayObject | |
| maxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| maxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| measuredHeight : Number [read-only]
The measured height of this object. | IFlexDisplayObject | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | IUIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | IUIComponent | |
| measuredWidth : Number [read-only]
The measured width of this object. | IFlexDisplayObject | |
| minHeight : Number [read-only]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| minWidth : Number [read-only]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | IFlexDisplayObject | |
| nonInheritingStyles : Object
An object containing the noninheritable styles for this component. | IStyleClient | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | IFlexDisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | IUIComponent | |
| parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | IFlexDisplayObject | |
| percentHeight : Number
Number that specifies the height of a component as a
percentage of its parent's size. | IUIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a
percentage of its parent's size. | IUIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | IFlexDisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | IFlexDisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | IFlexDisplayObject | |
| scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | IFlexDisplayObject | |
| scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | IFlexDisplayObject | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | IFlexDisplayObject | |
| speak : String
The speak text or accessibility text for this item. | IPanelItem | ||
| stage : Stage [read-only]
The Stage of the display object. | IFlexDisplayObject | |
| styleDeclaration : CSSStyleDeclaration
The style declaration that holds the inline styles declared by this
object. | IStyleClient | |
| styleName : Object
The source of this object's style values. | ISimpleStyleClient | |
| systemManager : ISystemManager
A reference to the SystemManager object for this component. | IUIComponent | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | IFlexDisplayObject | |
| tweeningProperties : Array
Used by EffectManager. | IUIComponent | |
| visible : Boolean
Whether or not the display object is visible. | IFlexDisplayObject | |
| width : Number
Indicates the width of the display object, in pixels. | IFlexDisplayObject | |
| x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | IFlexDisplayObject | |
| y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | IFlexDisplayObject | |
Public Methods
Property Detail
baseReferenceChain | property |
baseReferenceChain:BaseReferenceChain| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Get chain of binding references for parent containers
Implementation
public function get baseReferenceChain():BaseReferenceChain public function set baseReferenceChain(value:BaseReferenceChain):voidboundData | property |
boundData:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The object in the data model to which this item is bound. This allows the bound object to be
determined using Flex binding instead of using a dataRef expression.
Implementation
public function get boundData():Object public function set boundData(value:Object):voidboundName | property |
boundText | property |
boundText:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The value of the data object as a string. If the data model supports data formatting, this method returns the bound value as a formatted string.
Implementation
public function get boundText():String public function set boundText(value:String):voidboundValue | property |
boundValue:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The value of the data object to which this item is bound.
Implementation
public function get boundValue():Object public function set boundValue(value:Object):voidcaption | property |
caption:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The caption or description of this item. If no caption or description is specified, the caption for this item is bound to the caption of the data model. If the data model does not specify a caption, the default label is used.
Implementation
public function get caption():String public function set caption(value:String):voiddataRef | property |
dataRef:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The reference or address of the data node to which to bind this item.
Implementation
public function get dataRef():String public function set dataRef(value:String):voidhelpText | property |
helpText:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The help text for this item.
Implementation
public function get helpText():String public function set helpText(value:String):voidkeepWithPrevious | property |
keepWithPrevious:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Whether to keep this item with the previous item
Implementation
public function get keepWithPrevious():Boolean public function set keepWithPrevious(value:Boolean):voidspeak | property |
speak:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The speak text or accessibility text for this item.
Implementation
public function get speak():String public function set speak(value:String):voidMon Nov 28 2011, 06:48 AM -08:00