Package | mx.core |
Class | public class FlexHTMLLoader |
Inheritance | FlexHTMLLoader HTMLLoader Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Implements | IFocusManagerComplexComponent, IIMESupport |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | AIR 1.1 |
toString()
method
to return a string indicating the location of the object
within the hierarchy of DisplayObjects in the application.
Property | Defined By | ||
---|---|---|---|
accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | ||
accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | ||
alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | ||
authenticate : Boolean
Specifies whether authentication requests should be handled (true)
or not (false) for HTTP requests issued by this object. | HTMLLoader | ||
blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | ||
blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | ||
buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | ||
cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | ||
cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | ||
cacheResponse : Boolean
Specifies whether successful response data should be cached for HTTP requests issued by this object. | HTMLLoader | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
contentHeight : Number [read-only]
The height, in pixels, of the HTML content. | HTMLLoader | ||
contentWidth : Number [read-only]
The width, in pixels, of the HTML content. | HTMLLoader | ||
contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | ||
doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | ||
dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | ||
enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | FlexHTMLLoader | ||
filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | ||
focusEnabled : Boolean
A flag that indicates whether the component can receive focus when selected. | FlexHTMLLoader | ||
focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | ||
graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | ||
hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | FlexHTMLLoader | ||
hasFocusableContent : Boolean [read-only]
Indicates whether any content in the HTMLLoader object is focusable. | HTMLLoader | ||
height : Number [override]
Specifies the height of the rectangle of the HTML canvas that is being rendered. | HTMLLoader | ||
historyLength : uint [read-only]
The overall length of the history list, including back and forward entries. | HTMLLoader | ||
historyPosition : uint
The current position in the history list. | HTMLLoader | ||
hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | ||
htmlHost : flash.html:HTMLHost
The HTMLHost object used to handle changes to certain user interface elements, such as the
window.document.title property of the HTMLLoader object. | HTMLLoader | ||
idleTimeout : Number
Specifies the idle timeout value (in milliseconds) for HTTP requests issued by this object. | HTMLLoader | ||
imeMode : String
This is just a stub to support the interface. | FlexHTMLLoader | ||
loaded : Boolean [read-only]
Indicates whether the JavaScript load event corresponding to the previous call to the
load() or loadString() method has been delivered to
the HTML DOM in the HTMLLoader object. | HTMLLoader | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
location : String [read-only]
The URL for the content loaded in the HTMLLoader object. | HTMLLoader | ||
manageCookies : Boolean
Specifies whether the HTTP protocol stack should manage cookies for this
object. | HTMLLoader | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | ||
metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | ||
mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | ||
mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | ||
mouseFocusEnabled : Boolean
Whether the component can receive focus when clicked on. | FlexHTMLLoader | ||
mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
name : String
Indicates the instance name of the DisplayObject. | DisplayObject | ||
navigateInSystemBrowser : Boolean
Specifies whether navigation of the root frame of the HTML content (such as when the user clicks a link, when the
window.location property is set, or when calling window.open()) results in
navigation in the HTMLLoader object (false) or in the default system web browser
(true). | HTMLLoader | ||
needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | ||
numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | ||
opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | ||
paintsDefaultBackground : Boolean
Specifies whether the background of the HTMLLoader document is opaque white (true) or
not (false). | HTMLLoader | ||
parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject | ||
placeLoadStringContentInApplicationSandbox : Boolean
Specifies whether content loaded via the loadString() method is put in
the application sandbox (true) or in a non-application sandbox
(false). | HTMLLoader | ||
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. | DisplayObject | ||
rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | ||
rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
runtimeApplicationDomain : ApplicationDomain
The application domain to use for the window.runtime object in JavaScript
in the HTML page. | HTMLLoader | ||
scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | ||
scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | DisplayObject | ||
scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scrollH : Number
The horizontal scroll position of the HTML content in the HTMLLoader object. | HTMLLoader | ||
scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | ||
scrollV : Number
The vertical scroll position of the HTML content in the HTMLLoader object. | HTMLLoader | ||
softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | ||
softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | ||
soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | ||
stage : Stage [read-only]
The Stage of the display object. | DisplayObject | ||
tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | ||
tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | ||
tabFocusEnabled : Boolean
A flag that indicates whether child objects can receive focus
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. | FlexHTMLLoader | ||
tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | ||
textEncodingFallback : String
The character encoding used by the HTMLLoader content if an HTML page does not specify
a character encoding. | HTMLLoader | ||
textEncodingOverride : String
The character encoding used by the HTMLLoader content, overriding any setting in the HTML page. | HTMLLoader | ||
textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | ||
transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | ||
useCache : Boolean
Specifies whether the local cache should be consulted before HTTP requests issued by this object
fetch data. | HTMLLoader | ||
useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | ||
userAgent : String
The user agent string to be used in any upcoming content requests from this HTMLLoader
object. | HTMLLoader | ||
visible : Boolean
Whether or not the display object is visible. | DisplayObject | ||
width : Number [override]
Specifies the width of the rectangle of the HTML canvas that is being rendered. | HTMLLoader | ||
window : Object [read-only]
The global JavaScript object for the content loaded into the HTML control. | HTMLLoader | ||
x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | ||
y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | ||
z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject |
Method | Defined By | ||
---|---|---|---|
Constructor. | FlexHTMLLoader | ||
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | ||
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. | EventDispatcher | ||
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | ||
Called by the FocusManager when the component receives focus. | FlexHTMLLoader | ||
Cancels any load operation in progress. | HTMLLoader | ||
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | ||
createRootWindow(visible:Boolean = true, windowInitOptions:NativeWindowInitOptions = null, scrollBarsVisible:Boolean = true, bounds:Rectangle = null):flash.html:HTMLLoader [static]
Creates a new NativeWindow object that contains an HTMLLoader object. | HTMLLoader | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Called by the FocusManager when the component receives focus. | FlexHTMLLoader | ||
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | ||
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | ||
Returns the child display object that exists with the specified name. | DisplayObjectContainer | ||
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | ||
Returns the history entry at the specified position. | HTMLLoader | ||
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | ||
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. | DisplayObject | ||
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | ||
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Navigates back in the browser history, if possible. | HTMLLoader | ||
Navigates forward in the browser history, if possible. | HTMLLoader | ||
Navigates the specified number of steps in the browser history. | HTMLLoader | ||
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | ||
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Loads the HTMLLoader object with data from the site specified by the urlRequestToLoad parameter. | HTMLLoader | ||
Loads the HTMLLoader object with the HTML content contained in the HTML string. | HTMLLoader | ||
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | ||
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Reloads the page from the current location. | HTMLLoader | ||
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | ||
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Raises a virtual keyboard. | InteractiveObject | ||
Changes the position of an existing child in the display object container. | DisplayObjectContainer | ||
Called by the FocusManager when the component receives focus. | FlexHTMLLoader | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Lets the user drag the specified sprite. | Sprite | ||
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | ||
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | ||
Ends the startDrag() method. | Sprite | ||
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | ||
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | ||
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
[override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexHTMLLoader | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
enableIME | property |
focusEnabled | property |
focusEnabled:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | AIR 1.1 |
A flag that indicates whether the component can receive focus when selected.
As an optimization, if a child component in your component
implements the IFocusManagerComponent interface, and you
never want it to receive focus,
you can set focusEnabled
to false
before calling addChild()
on the child component.
This will cause the FocusManager to ignore this component
and not monitor it for changes to the tabFocusEnabled
,
tabChildren
, and mouseFocusEnabled
properties.
This also means you cannot change this value after
addChild()
and expect the FocusManager to notice.
Note: It does not mean that you cannot give this object focus
programmatically in your setFocus()
method;
it just tells the FocusManager to ignore this IFocusManagerComponent
component in the Tab and mouse searches.
Implementation
public function get focusEnabled():Boolean
public function set focusEnabled(value:Boolean):void
hasFocusableChildren | property |
hasFocusableChildren:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | AIR 1.5 |
A flag that indicates whether child objects can receive focus.
Note: This property is similar to the tabChildren
property
used by Flash Player.
Use the hasFocusableChildren
property with Flex applications.
Do not use the tabChildren
property.
This property is usually false
because most components
either receive focus themselves or delegate focus to a single
internal sub-component and appear as if the component has
received focus.
For example, a TextInput control contains a focusable
child RichEditableText control, but while the RichEditableText
sub-component actually receives focus, it appears as if the
TextInput has focus. TextInput sets hasFocusableChildren
to false
because TextInput is considered the
component that has focus. Its internal structure is an
abstraction.
Usually only navigator components, such as TabNavigator and
Accordion, have this flag set to true
because they
receive focus on Tab but focus goes to components in the child
containers on further Tabs.
The default value is false
, except for the
spark.components.Scroller component.
For that component, the default value is true
.
The default value is false.
This property can be used as the source for data binding. When this property is modified, it dispatches the hasFocusableChildrenChange
event.
Implementation
public function get hasFocusableChildren():Boolean
public function set hasFocusableChildren(value:Boolean):void
imeMode | property |
imeMode:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | AIR 1.5 |
This is just a stub to support the interface. The parent mx.controls.HTML contains the conversionMode and applies it.
Implementation
public function get imeMode():String
public function set imeMode(value:String):void
mouseFocusEnabled | property |
mouseFocusEnabled:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | AIR 1.1 |
Whether the component can receive focus when clicked on.
If false
, focus will be transferred to
the first parent that is mouseFocusEnable
set to true
.
The default value is true.
Implementation
public function get mouseFocusEnabled():Boolean
public function set mouseFocusEnabled(value:Boolean):void
tabFocusEnabled | property |
tabFocusEnabled:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | AIR 1.5 |
A flag that indicates whether child objects can receive focus
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.
The default value is true.
This property can be used as the source for data binding. When this property is modified, it dispatches the tabFocusEnabledChange
event.
Implementation
public function get tabFocusEnabled():Boolean
public function set tabFocusEnabled(value:Boolean):void
FlexHTMLLoader | () | Constructor |
public function FlexHTMLLoader()
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | AIR 1.1 |
Constructor.
Sets the name
property to a string
returned by the createUniqueName()
method of the mx.utils.NameUtils class.
This string is the name of the object's class concatenated
with an integer that is unique within the application,
such as "FlexLoader13"
.
Related API Elements
mx.utils.NameUtils.createUniqueName()
assignFocus | () | method |
public function assignFocus(direction:String):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | AIR 1.1 |
Called by the FocusManager when the component receives focus.
The component may in turn set focus to an internal component.
The component's setFocus()
method will still be called when focused by
the mouse, but this method will be used when focus changes via the
keyboard.
Parameters
direction:String — one of flash.display.FocusDirection
|
drawFocus | () | method |
public function drawFocus(isFocused:Boolean):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | AIR 1.1 |
Called by the FocusManager when the component receives focus. The component should draw or hide a graphic that indicates that the component has focus.
Parameters
isFocused:Boolean — If true , draw the focus indicator,
otherwise hide it.
|
setFocus | () | method |
public function setFocus():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | AIR 1.1 |
Called by the FocusManager when the component receives focus. The component may in turn set focus to an internal component.
toString | () | method |
override public function toString():String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | AIR 1.1 |
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
This string, such as "MyApp0.HBox5.FlexLoader13"
,
is built by the displayObjectToString()
method
of the mx.utils.NameUtils class from the name
property of the object and its ancestors.
String — A String indicating the location of this object
within the DisplayObject hierarchy.
|
Related API Elements
mx.utils.NameUtils.displayObjectToString()
Wed Nov 21 2018, 06:34 AM -08:00