IPanelText - Adobe ActionScript® 3 (AS3 ADEP Guides) API Reference

Package	ga.model
Interface	public interface IPanelText extends IPanelItem , IUIComponent , IStyleClient , IFlexDisplayObject , ISimpleStyleClient
Implementors	PanelRichText, PanelText

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

The IPanelText interface represents the text in panel as a string or HTML formatted string.

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
		htmlText : String An HTML-formatted string for display in a panel.	IPanelText
		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
		text : String The current string representing the text in a panel.	IPanelText
		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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	IEventDispatcher
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	IStyleClient
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	IEventDispatcher
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	IFlexDisplayObject
		getClassStyleDeclarations():Array Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.	IStyleClient
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	IUIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	IUIComponent
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	IFlexDisplayObject
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	IStyleClient
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	IFlexDisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	IEventDispatcher
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	IFlexDisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	IFlexDisplayObject
		initialize():void Initialize the object.	IUIComponent
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	IFlexDisplayObject
		move(x:Number, y:Number):void Moves this object to the specified x and y coordinates.	IFlexDisplayObject
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children of this component.	IStyleClient
		owns(displayObject:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent.	IUIComponent
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	IUIComponent
		regenerateStyleCache(recursive:Boolean):void Sets up the internal style cache values so that the getStyle() method functions.	IStyleClient
		registerEffects(effects:Array):void Registers the EffectManager as one of the event listeners for each effect event.	IStyleClient
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	IEventDispatcher
		setActualSize(newWidth:Number, newHeight:Number):void Sets the actual size of this object.	IFlexDisplayObject
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	IStyleClient
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes.	IUIComponent
		styleChanged(styleProp:String):void Called when the value of a style property is changed.	ISimpleStyleClient
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	IEventDispatcher

Property Detail

htmlText

property

htmlText:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

An HTML-formatted string for display in a panel.

Implementation
public function get htmlText():String
public function set htmlText(value:String):void

text

property

text:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

The current string representing the text in a panel.

Implementation
public function get text():String
public function set text(value:String):void

IPanelText - AS3 ADEP Guides

Classes x

htmlText

text

ga.model IPanelText - AS3 ADEP Guides		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples