| Package | mx.controls |
| Class | public class HTML |
| Inheritance | HTML  ScrollControlBase UIComponent FlexSprite flash.display.Sprite |
| Implements | IDataRenderer, IDropInListItemRenderer, IListItemRenderer, IFocusManagerComponent |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
You use the location property to specify the URL
of an HTML page whose content is displayed in the control, or you
can set the htmlText property to specify a String
containing HTML-formatted text that is rendered in the control.
Hide MXML SyntaxThe <mx:HTML> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<mx:HTML
Properties
data="null"
historyPosition="0"
htmlHost="null"
htmlLoaderFactory="mx.core.ClassFactory"
htmlText=""
listData="null"
location=""
paintsDefaultBackground="false"
runtimeApplicationDomain="null"
userAgent="null"
Styles
paddingBottom="0"
paddingLeft="0"
paddingRight="0"
paddingTop="0"
Events
complete="No default"
htmlDOMInitialize="No default"
htmlRender="No default"
locationChange="No default"
uncaughtScriptException="No default"
/>
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ScrollControlBase | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
 contentHeight : Number[read-only]
The height, in pixels, of the HTML content. | HTML | ||
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contentWidth : Number [read-only]
The width, in pixels, of the HTML content. | HTML | ||
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| data : Object
Lets you pass a value to the component
when you use it in an item renderer or item editor. | HTML | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| domWindow : Object [read-only]
The JavaScript window object
for the root frame of the HTML DOM inside this control. | HTML | ||
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| historyLength : int [read-only]
The overall length of the history list,
including back and forward entries. | HTML | ||
| historyPosition : int
The current position in the history list. | HTML | ||
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll
bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| horizontalScrollPosition : Number
The offset into the content from the left edge. | ScrollControlBase | |
| htmlHost : HTMLHost
The HTMLHost object is used to handle changes
to certain user interface elements in the HTML content,
such as the window.document.title property. | HTML | ||
| htmlLoader : HTMLLoader
The internal HTMLLoader object that renders
the HTML content for this control. | HTML | ||
| htmlLoaderFactory : IFactory
The IFactory that creates an HTMLLoader-derived instance
to use as the htmlLoader. | HTML | ||
| htmlText : String
Specifies an HTML-formatted String for display by the control. | HTML | ||
| id : String
ID of the component. | UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode. | HTML | ||
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the appropriate data from the List control. | HTML | ||
| liveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the
scrollbar thumb is moved
or the view is not updated until the thumb is released. | ScrollControlBase | |
| loaded : Boolean [read-only]
A flag which indicates whether the JavaScript load event
corresponding to the previous loading operation
has been delivered to the HTML DOM in this control. | HTML | ||
| location : String
The URL of an HTML page to be displayed by this control. | HTML | ||
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property. | ScrollControlBase | |
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property. | ScrollControlBase | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| MXMLDescriptor : Array [read-only] | UIComponent | |
| MXMLProperties : Array [read-only] | UIComponent | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| paintsDefaultBackground : Boolean
Whether this control's HTML content
has a default opaque white background or not. | HTML | ||
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| pdfCapability : int [static] [read-only]
The type of PDF support on the user's system,
defined as an integer code value. | HTML | ||
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| rotation : Number [override] | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
| UIComponent | |
| runtimeApplicationDomain : ApplicationDomain
The ApplicationDomain to use for HTML's window.runtime
scripting. | HTML | ||
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip. | ScrollControlBase | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged. | ScrollControlBase | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| userAgent : String
The user agent string to be used in content requests
from this control. | HTML | ||
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| verticalScrollPosition : Number
The offset into the content from the top edge. | ScrollControlBase | |
| viewMetrics : EdgeMetrics [read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible. | ScrollControlBase | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
| HTML()
Constructor. | HTML | ||
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
| callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | |
| cancelLoad():void
Cancels any load operation in progress. | HTML | ||
| clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | |
| contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
| contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | |
| createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | |
| createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | |
| createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | |
| drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
| effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | |
| effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | |
| endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | |
| executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
| finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | |
| generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | |
| generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | |
| getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | |
| getAutomationChildren():Array
Provides the automation object list . | UIComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | |
| getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
| getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
| getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
| getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | |
| getHistoryAt(position:int):HTMLHistoryItem
Returns the HTMLHistoryItem at the specified position
in this control's history list. | HTML | ||
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | |
| getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | |
| globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | |
| hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | |
| hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
| historyBack():void
Navigates back in this control's history list, if possible. | HTML | ||
| historyForward():void
Navigates forward in this control's history list, if possible. | HTML | ||
| historyGo(steps:int):void
Navigates the specified number of steps in this control's history list. | HTML | ||
| horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
| initialize():void
Initializes the internal structure of this component. | UIComponent | |
| initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
| invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
| invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | |
| matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
| measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
| measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
| move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | |
| notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | |
| owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
| parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
| prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | |
| regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
| registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
| reload():void
Reloads the HTML content from the current location. | HTML | ||
| removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | |
| replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | |
| resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | |
| resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
| setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | |
| setFocus():void
Sets the focus to this component. | UIComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | |
| setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setMXMLDescriptor(value:Array):void | UIComponent | |
| setMXMLProperties(value:Array):void | UIComponent | |
| setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | |
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
| toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
| transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
| validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | |
| validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
| validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
| validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
| validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
| verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched after the last loading operation caused by setting the location or htmlText property has completed. | HTML | |||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched after the HTML DOM has been initialized in response to a loading operation caused by setting the location or htmlText property. | HTML | |||
| Dispatched when this control's HTML content initially renders, and each time that it re-renders. | HTML | |||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the location property changes. | HTML | |||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the content is scrolled. | ScrollControlBase | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when an uncaught JavaScript exception occurs. | HTML | |||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | ScrollControlBase | ||
| Type: Number CSS Inheritance: no Theme: halo Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo Background color of a component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | ScrollControlBase | ||
| Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Theme: halo Scales the image specified by backgroundImage to different percentage sizes. | ScrollControlBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Number CSS Inheritance: no Theme: spark Alpha of the border. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Theme: halo Bounding box sides. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Bounding box style. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | ScrollControlBase | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Radius of component corners. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Color of the drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: halo Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields.See also flash.text.TextField flash.text.AntiAliasType | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Name of the font to use. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls.See also flash.text.TextField flash.text.GridFitType | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | ScrollControlBase | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: no Style name for horizontal scrollbar. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | ScrollControlBase | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes The locale of the text displayed by this component. | ScrollControlBase | ||
paddingBottom | Type: Number Format: Length CSS Inheritance: no The number of pixels between the bottom edge of this control and the bottom edge of its HTML content area. The default value is 0. | HTML | ||
paddingLeft | Type: Number Format: Length CSS Inheritance: no The number of pixels between the left edge of this control and the left edge of its HTML content area. The default value is 0. | HTML | ||
paddingRight | Type: Number Format: Length CSS Inheritance: no The number of pixels between the right edge of this control and the right edge of its HTML content area. The default value is 0. | HTML | ||
paddingTop | Type: Number Format: Length CSS Inheritance: no The number of pixels between the top edge of this control and the top edge of its HTML content area. The default value is 0. | HTML | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: no Theme: halo Direction of the drop shadow. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of the drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: no Style name for vertical scrollbar. | ScrollControlBase | ||
| contentHeight | property |
contentHeight:Number [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The height, in pixels, of the HTML content.
public function get contentHeight():Number| contentWidth | property |
contentWidth:Number [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The width, in pixels, of the HTML content.
public function get contentWidth():Number| data | property |
data:Object| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Lets you pass a value to the component
when you use it in an item renderer or item editor.
You typically use data binding to bind a field of the data
property to a property of this component.
When you use the control as a drop-in item renderer or drop-in
item editor, Flex automatically writes the current value of the item
to the text property of this control.
You cannot set this property in MXML.
The default value is null.
This property can be used as the source for data binding.
public function get data():Object public function set data(value:Object):voidSee also
| domWindow | property |
domWindow:Object [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The JavaScript window object
for the root frame of the HTML DOM inside this control.
This property is null until the
htmlDOMInitialize event has been dispatched.
The default value is null.
public function get domWindow():Object| historyLength | property |
historyLength:int [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The overall length of the history list,
including back and forward entries.
This property has the same value
as the window.history.length
JavaScript property of the the HTML content.
public function get historyLength():intSee also
| historyPosition | property |
historyPosition:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The current position in the history list.
The history list corresponds to the window.history
object of the HTML content.
Entries less than the current position are the "back" list;
entries greater are "forward."
Attempting to set the position beyond the end sets it to the end.
The default value is 0.
public function get historyPosition():int public function set historyPosition(value:int):void| htmlHost | property |
htmlHost:HTMLHost| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The HTMLHost object is used to handle changes
to certain user interface elements in the HTML content,
such as the window.document.title property.
To override default behaviors for the HTMLLoader, create a subclass of the HTMLHost class, override its member functions to handle various user interface changes in the HTML content, and set this property to an instance of your subclass.
The default value is null.
public function get htmlHost():HTMLHost public function set htmlHost(value:HTMLHost):void| htmlLoader | property |
public var htmlLoader:HTMLLoader| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The internal HTMLLoader object that renders the HTML content for this control.
| htmlLoaderFactory | property |
htmlLoaderFactory:IFactory| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The IFactory that creates an HTMLLoader-derived instance to use as the htmlLoader.
The default value is an IFactory for HTMLLoader.
This property can be used as the source for data binding.
public function get htmlLoaderFactory():IFactory public function set htmlLoaderFactory(value:IFactory):void| htmlText | property |
htmlText:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Specifies an HTML-formatted String for display by the control.
Setting this property has the side effect of setting
the location property to null,
and vice versa.
Content added via the htmlText property is put in the
application security sandbox. If an AIR application includes an HTML
control located in the application sandbox, and remote HTML code is
directly added into the control by setting the htmlText
property, any script contained in the HTML text is executed in the
application sandbox.
The default value is "".
This property can be used as the source for data binding.
public function get htmlText():String public function set htmlText(value:String):voidSee also
| imeMode | property |
imeMode:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies the IME (input method editor) mode. The IME enables users to enter text in Chinese, Japanese, and Korean. Flex sets the specified IME mode when the control gets the focus, and sets it back to the previous value when the control loses the focus.
The flash.system.IMEConversionMode class defines constants for the
valid values for this property.
You can also specify null to specify no IME.
The default value is null.
public function get imeMode():String public function set imeMode(value:String):voidSee also
| listData | property |
listData:BaseListData| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the appropriate data from the List control.
The component can then use the listData property
to initialize the data property of the drop-in
item renderer or drop-in item editor.
You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.
The default value is null.
This property can be used as the source for data binding.
public function get listData():BaseListData public function set listData(value:BaseListData):voidSee also
| loaded | property |
loaded:Boolean [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
A flag which indicates whether the JavaScript load event
corresponding to the previous loading operation
has been delivered to the HTML DOM in this control.
This property is true
before the complete event is dispatched.
It is possible that this property
never becomes true.
This happens in the same cases
in which the complete event is never dispatched.
The default value is false.
public function get loaded():Boolean| location | property |
location:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The URL of an HTML page to be displayed by this control.
Setting this property has the side effect of setting
the htmlText property to null,
and vice versa.
The default value is "".
This property can be used as the source for data binding.
public function get location():String public function set location(value:String):voidSee also
| paintsDefaultBackground | property |
paintsDefaultBackground:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Whether this control's HTML content has a default opaque white background or not.
If this property is false,
then the background specified for this Flex control, if any,
appears behind the HTML content.
However, if any HTML element has its own opaque background color (specified by style="background-color:gray", for instance), then that background appears behind that element.
The default value is false;.
public function get paintsDefaultBackground():Boolean public function set paintsDefaultBackground(value:Boolean):void| pdfCapability | property |
pdfCapability:int [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The type of PDF support on the user's system, defined as an integer code value.
An HTML object can display PDF content only if this property
evaluates to PDFCapability.STATUS_OK.
The PDFCapability class defines constants for possible values
of the pdfCapability property, as follows:
| PDFCapability constant | Meaning |
|---|---|
STATUS_OK | A sufficient version (8.1 or later) of Acrobat Reader
is detected and PDF content can be loaded in an HTML object.
Note: On Windows, if a Acrobat Acrobat
or Acrobat Reader version 7.x or above
is currently running on the user's system,
that version is used even if a later version
that supports loading PDF loaded in an HTML object is installed.
In this case, if the the value of the
|
ERROR_INSTALLED_READER_NOT_FOUND | No version of Acrobat Reader is detected. An HTML object cannot display PDF content. |
ERROR_INSTALLED_READER_TOO_OLD | Acrobat Reader has been detected, but the version is too old. An HTML object cannot display PDF content. |
ERROR_PREFERED_READER_TOO_OLD | A sufficient version (8.1 or later) of Acrobat Reader is detected, but the the version of Acrobat Reader that is setup to handle PDF content is older than Reader 8.1. An HTML object cannot display PDF content. |
public static function get pdfCapability():int| runtimeApplicationDomain | property |
runtimeApplicationDomain:ApplicationDomain| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The ApplicationDomain to use for HTML's window.runtime
scripting.
If this property is null, or if it specifies
an ApplicationDomain from a different security domain
than the HTML content, the HTML page uses a default
ApplicationDomain for the page's domain.
The default value is null.
public function get runtimeApplicationDomain():ApplicationDomain public function set runtimeApplicationDomain(value:ApplicationDomain):void| userAgent | property |
userAgent:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
The user agent string to be used in content requests from this control.
You can set the default user agent string used by all
HTML controls in an application domain by setting the
static URLRequestDefaults.userAgent property.
If no value is set for the userAgent property
(or if the value is set to null),
the user agent string is set to the value of
URLRequestDefaults.userAgent.
If neither the userAgent property
of this control nor for URLRequestDefaults.userAgent,
has a value set, a default value is used as the user agent string.
This default value varies depending on the runtime
operating system (such as Mac OS or Windows),
the runtime language, and the runtime version,
as in the following two examples:
"Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) AdobeAIR/1.0"
"Mozilla/5.0 (Windows; U; en) AppleWebKit/420+ (KHTML, like Gecko) AdobeAIR/1.0"
The default value is null.
public function get userAgent():String public function set userAgent(value:String):voidSee also
| HTML | () | Constructor |
public function HTML()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Constructor.
| cancelLoad | () | method |
public function cancelLoad():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Cancels any load operation in progress.
This method does nothing if it is called before this component's
internal HTMLLoader (the htmlLoader property) has been created.
| getHistoryAt | () | method |
public function getHistoryAt(position:int):HTMLHistoryItem| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Returns the HTMLHistoryItem at the specified position in this control's history list.
This method returns null if it is called before this
component's internal HTMLLoader (the htmlLoader property) has been created.
Parameters
position:int — The position in the history list.
|
HTMLHistoryItem — A HTMLHistoryItem object
for the history entry at the specified position.
|
See also
| historyBack | () | method |
public function historyBack():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Navigates back in this control's history list, if possible.
Calling this method of the HTMLLoader object
has the same effect as calling the back() method
of the window.history property in JavaScript
in the HTML content.
This method does nothing if it is called before this component's
internal HTMLLoader (the htmlLoader property) has been created.
See also
| historyForward | () | method |
public function historyForward():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Navigates forward in this control's history list, if possible.
Calling this method of the HTMLLoader object
has the same effect as calling the forward() method
of the window.history property in JavaScript
in the HTML content.
This function throws no errors.
This method does nothing if it is called before this component's
internal HTMLLoader (the htmlLoader property) has been created.
See also
| historyGo | () | method |
public function historyGo(steps:int):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Navigates the specified number of steps in this control's history list.
This method navigates forward if the number of steps
is positive and backward if it is negative.
Navigation by zero steps is equivalent
to calling reload().
This method is equivalent to calling the go() method
of the window.history property in JavaScript
in the HTML content.
This method does nothing if it is called before this component's
internal HTMLLoader (the htmlLoader property) has been created.
Parameters
steps:int — The number of steps in the history list
to move forward (positive) or backward (negative).
|
| reload | () | method |
public function reload():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Reloads the HTML content from the current location.
This method does nothing if it is called before this component's
internal HTMLLoader (the htmlLoader property) has been created.
| complete | Event |
flash.events.Eventflash.events.Event.COMPLETE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Dispatched after the last loading operation caused by
setting the location or htmlText
property has completed.
This event is always dispatched asynchronously,
after the JavaScript load event
has been dispatched in the HTML DOM.
An event handler for this event may call any method
or access any property of this control
or its internal htmlLoader.
See also
| htmlDOMInitialize | Event |
flash.events.Eventflash.events.Event.HTML_DOM_INITIALIZE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Dispatched after the HTML DOM has been initialized
in response to a loading operation caused by
setting the location or htmlText property.
When this event is dispatched,
no JavaScript methods have yet executed.
The domWindowand domWindow.document
objects exist, but other DOM objects may not.
You can use this event to set properties
onto the domWindow and domWindow.document
objects for JavaScript methods to later access.
A handler for this event should not set any properties or call any methods which start another loading operation or which affect the URL for the current loading operation; doing so causes either an ActionScript or a JavaScript exception.
See also
| htmlRender | Event |
flash.events.Eventflash.events.Event.HTML_RENDER| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Dispatched when this control's HTML content initially renders, and each time that it re-renders.
Because an HTML control can dispatch many of these events,
you should avoid significant processing in a render
handler that might negatively impact performance.
| locationChange | Event |
flash.events.Eventflash.events.Event.LOCATION_CHANGE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Dispatched when the location property changes.
This event is always dispatched asynchronously.
An event handler for this event may call any method
or access any property of this control
or its internal htmlLoader.
| uncaughtScriptException | Event |
flash.events.HTMLUncaughtScriptExceptionEventflash.events.HTMLUncaughtScriptExceptionEvent.UNCAUGHT_SCRIPT_EXCEPTION| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Dispatched when an uncaught JavaScript exception occurs.
This event is always dispatched asynchronously.
An event handler for this event may call any method
or access any property of this control
or its internal htmlLoader.