Packagemx.core
Classpublic class FlexHTMLLoader
InheritanceFlexHTMLLoader Inheritance flash.html.HTMLLoader
Implements IFocusManagerComplexComponent, IIMESupport

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

FlexHTMLLoader is a subclass of the Player's HTMLLoader class used by the Flex HTML control. It overrides the toString() method to return a string indicating the location of the object within the hierarchy of DisplayObjects in the application.



Public Properties
 PropertyDefined By
  enableIME : Boolean
[read-only] A flag that indicates whether the IME should be enabled when the component receives focus.
FlexHTMLLoader
  AIR-only focusEnabled : Boolean
A flag that indicates whether the component can receive focus when selected.
FlexHTMLLoader
  AIR-only hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
FlexHTMLLoader
  AIR-only imeMode : String
This is just a stub to support the interface.
FlexHTMLLoader
  AIR-only mouseFocusEnabled : Boolean
Whether the component can receive focus when clicked on.
FlexHTMLLoader
  AIR-only 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
Public Methods
 MethodDefined By
  
Constructor.
FlexHTMLLoader
  
AIR-only assignFocus(direction:String):void
Called by the FocusManager when the component receives focus.
FlexHTMLLoader
  
AIR-only drawFocus(isFocused:Boolean):void
Called by the FocusManager when the component receives focus.
FlexHTMLLoader
  
AIR-only setFocus():void
Called by the FocusManager when the component receives focus.
FlexHTMLLoader
  
AIR-only toString():String
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexHTMLLoader
Property Detail
enableIMEproperty
enableIME:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

A flag that indicates whether the IME should be enabled when the component receives focus.


Implementation
    public function get enableIME():Boolean
AIR-only focusEnabledproperty 
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
AIR-only hasFocusableChildrenproperty 
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.


Implementation
    public function get hasFocusableChildren():Boolean
    public function set hasFocusableChildren(value:Boolean):void
AIR-only imeModeproperty 
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
AIR-only mouseFocusEnabledproperty 
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
AIR-only tabFocusEnabledproperty 
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.


Implementation
    public function get tabFocusEnabled():Boolean
    public function set tabFocusEnabled(value:Boolean):void
Constructor Detail
AIR-only 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".

See also

flash.display.DisplayObject.name
mx.utils.NameUtils.createUniqueName()
Method Detail
AIR-only 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

AIR-only 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.

AIR-only 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.

AIR-only 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.

Returns
String — A String indicating the location of this object within the DisplayObject hierarchy.

See also

flash.display.DisplayObject.name
mx.utils.NameUtils.displayObjectToString()