Packagecom.gestureworks.cml.elements
Classpublic class HTML
InheritanceHTML Inheritance Container Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The HTML loads and runs an HTMLLoader display object. By default Flash is hidden from the web pages after loading via javascript to prevent display bugs native to the HTMLLoader
                 
        
            var html:HTML = new HTML();
            html.load(
            addChild(html);

     



Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  baseURL : String
Get/Set the base URL.
HTML
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
  height : Number
[override] Sets the height.
HTML
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
  hideFlash : Boolean
Sets whether or not if Flash will be hidden (object/embed).
HTML
  hideFlashType : String
Sets the specific type flash embed.
HTML
  _horizontalScroll : ScrollBar
HTML
  html : HTMLLoader
[read-only] Returns html object
HTML
 Inheritedid : String
Returns the object's id.
TouchContainer
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
  lockBaseURL : Boolean
Locks base url.
HTML
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
  smooth : Boolean
Sets whether or not to smooth the rendered html page
HTML
 Inheritedsound : String
TouchContainer
  src : String
Sets the src URL and sends load request.
HTML
  srcString : String
HTML
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  _verticalScroll : ScrollBar
HTML
  width : Number
[override] Sets the width;
HTML
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
HTML
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
HTML
  
Smoothing Function
HTML
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
goBack():void
Go back in history
HTML
  
goForward():void
Go forward in history
HTML
  
init():void
[override] Initialisation method
HTML
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
  
loadURL(URL:String):void
Load url
HTML
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
  
onRender(event:Event):void
HTML
  
parseCML(cml:XMLList):XMLList
[override]
HTML
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Protected Methods
 MethodDefined By
  
onLocationChange(event:LocationChangeEvent):void
HTML location change event handler
HTML
  
onLocationChanging(event:LocationChangeEvent):void
HTML location currently changing event handler
HTML
  
onURLLoadComplete(event:*):void
HTML load complete event handler
HTML
  
onURLLoadError(event:*):void
HTML error event handler
HTML
Property Detail
_horizontalScrollproperty
public var _horizontalScroll:ScrollBar

_verticalScrollproperty 
public var _verticalScroll:ScrollBar

baseURLproperty 
baseURL:String

Get/Set the base URL. Initial URL loaded.

The default value is http://.


Implementation
    public function get baseURL():String
    public function set baseURL(value:String):void
heightproperty 
height:Number[override]

Sets the height.


Implementation
    public function get height():Number
    public function set height(value:Number):void
hideFlashproperty 
hideFlash:Boolean

Sets whether or not if Flash will be hidden (object/embed). hideFlashType = "display: none;" or "visibility:hidden;"

The default value is true.


Implementation
    public function get hideFlash():Boolean
    public function set hideFlash(value:Boolean):void
hideFlashTypeproperty 
hideFlashType:String

Sets the specific type flash embed. Options are "display: none;" or "visibility:hidden;

The default value is visibility:hidden.


Implementation
    public function get hideFlashType():String
    public function set hideFlashType(value:String):void
htmlproperty 
html:HTMLLoader  [read-only]

Returns html object


Implementation
    public function get html():HTMLLoader
lockBaseURLproperty 
lockBaseURL:Boolean

Locks base url. Set to true if you don't want users to be able to navigate awaw from http://www.xxxxxxx.xxx/

The default value is true.


Implementation
    public function get lockBaseURL():Boolean
    public function set lockBaseURL(value:Boolean):void
smoothproperty 
smooth:Boolean

Sets whether or not to smooth the rendered html page

The default value is true.


Implementation
    public function get smooth():Boolean
    public function set smooth(value:Boolean):void
srcproperty 
src:String

Sets the src URL and sends load request.


Implementation
    public function get src():String
    public function set src(value:String):void
srcStringproperty 
srcString:String


Implementation
    public function get srcString():String
    public function set srcString(value:String):void
widthproperty 
width:Number[override]

Sets the width;


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
HTML()Constructor
public function HTML()

Constructor

Method Detail
dispose()method
override public function dispose():void

Destructor

generateSmoothVersion()method 
public function generateSmoothVersion():void

Smoothing Function

goBack()method 
public function goBack():void

Go back in history

goForward()method 
public function goForward():void

Go forward in history

init()method 
override public function init():void

Initialisation method

loadURL()method 
public function loadURL(URL:String):void

Load url

Parameters

URL:String

onLocationChange()method 
protected function onLocationChange(event:LocationChangeEvent):void

HTML location change event handler

Parameters

event:LocationChangeEvent

onLocationChanging()method 
protected function onLocationChanging(event:LocationChangeEvent):void

HTML location currently changing event handler

Parameters

event:LocationChangeEvent

onRender()method 
public function onRender(event:Event):void

Parameters

event:Event

onURLLoadComplete()method 
protected function onURLLoadComplete(event:*):void

HTML load complete event handler

Parameters

event:*

onURLLoadError()method 
protected function onURLLoadError(event:*):void

HTML error event handler

Parameters

event:*

parseCML()method 
override public function parseCML(cml:XMLList):XMLList

Parameters

cml:XMLList

Returns
XMLList