Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.


 ClassPackageDescription
 Accordion
com.gestureworks.cml.elements The Accordion is an interactive container which holds display objects in a collapsible menu.
 Album
com.gestureworks.cml.elements The Album element provides a list of display objects that can be scrolled horizontally or vertically using a drag gesture.
 AlbumViewer
com.gestureworks.cml.components The AlbumViewer component is primarily meant to display an Album element and its associated meta-data.
 Attract
com.gestureworks.cml.elements The AttractKit creates an attract screen that is removed during touch and displayed after a timout period.
 Background
com.gestureworks.cml.elements The BackgroundKit resizes its children to the center of the stage.
 Bevel
com.gestureworks.cml.filters The Bevel class lets you add a bevel effect to display objects.
 Blur
com.gestureworks.cml.filters The Blur class lets you apply a blur visual effect to display objects.
 Button
com.gestureworks.cml.elements The Button hides or shows DisplayObjects on specified state events.
 CMLAir
com.gestureworks.cml.core The CMLAir class is the registry file for AIR-exclusive classes that are capable of being loaded by the CML Parser.
 CMLCore
com.gestureworks.cml.core The CMLCore class is the registry file for classes that are capable of being loaded by the CML Parser.
 CMLDisplay
com.gestureworks.cml.core The CMLDisplay class is the root container for a display generated by CML.
 CMLObject
com.gestureworks.cml.core The CMLObject is the base class for all CML Objects.
 CMLObjectList
com.gestureworks.cml.core The CMLObjectList class is the master list for all objects created through CML.
 CMLParser
com.gestureworks.cml.core The CMLParser class parses cml files for run-time object construction and modification.
 CollectionViewer
com.gestureworks.cml.components The CollectionViewer component manages the display of components and elements.
 ColorPicker
com.gestureworks.cml.elements The ColorPicker element provides color selection capability by moving graphical indicators or adjusting color properties to select hue and color variants.
 Component
com.gestureworks.cml.components The Component manages a group of elements to create a high-level interactive touch container.
 Container
com.gestureworks.cml.elements The Container element controls the layout characteristics of child components.
 CSSManager
com.gestureworks.cml.managers The CSSManager processes external CSS files.
 DatePicker
com.gestureworks.cml.elements The DatePicker element provides date selection capability.
 Dial
com.gestureworks.cml.elements The Dial element provides a list of text elements in rotary selection tool.
 DisplayManager
com.gestureworks.cml.managers The DisplayManager utlizes the CMLObjectList to make global updates to all of the CML objects.
 Dock
com.gestureworks.cml.elements Designed for the database version of the CollectionViewer, the Dock is a retractable control station intended to guide users through database query construction by vertically spinning a set of dials populated with predefined search terms.
 Drawer
com.gestureworks.cml.elements The Drawer is a container that animates down to conceal its contents (closed state) and animates up to reveal its contents (open state).
 DropDownMenu
com.gestureworks.cml.elements Drop down menu is used to create a simple menu from a text string of items.
 DropShadow
com.gestureworks.cml.filters The DropShadow class lets you add a drop shadow to display objects.
 FanLayout
com.gestureworks.cml.layouts The FanLayout positions the corners of the container's objects in the same location and rotates them individually around the corner.
 FileEvent
com.gestureworks.cml.events The FileEvent is dispatched during file loading operations.
 FileManager
com.gestureworks.cml.managers The FileManager handles the loading of all external files.
 Flickr
com.gestureworks.cml.elements The Flick element provides access to images stored on Flickr through the Flickr API.
 FlickrQuery
com.gestureworks.cml.elements The FlickQuery is designed to be used with the dock to set a query in CML that may be used in conjunction with searchFields and the dials to provide a way to search via groups, users, and tags.
 FlickrViewer
com.gestureworks.cml.components The FlickrViewer component is primarily meant to display a Flickr element and its associated meta-data.
 FlipBook
com.gestureworks.cml.elements The FlipBook element is designed to take a series of display objects, and arrange them to be sorted through with a "flip" animation for each one.
 FlipBookViewer
com.gestureworks.cml.components 
 FontManager
com.gestureworks.cml.managers The FontManager loads embedded fonts.
 Frame
com.gestureworks.cml.elements The Frame element create display object frames.
 Gesture
com.gestureworks.cml.elements The Gesture class allows you to create gestures in CML.
 GestureList
com.gestureworks.cml.elements The GestureList class allows you to create a group of gestures in CML.
 Gigapixel
com.gestureworks.cml.elements The Gigapixel element loads a gigapixel image.
 GigapixelViewer
com.gestureworks.cml.components The GigapixelViewer component is primarily meant to display a Gigapixel element and its associated meta-data.
 Glow
com.gestureworks.cml.filters The Glow class lets you apply a glow effect to display objects.
 Graphic
com.gestureworks.cml.elements The graphic element can draw many types of graphic types.
 GridLayout
com.gestureworks.cml.layouts The GridLayout positions the display objects in a grid.
 Hotspot
com.gestureworks.cml.elements A Hotspot is primarily a container for graphic objects that is set at an index local to a gigapixel scene.
 HTML
com.gestureworks.cml.elements The HTML loads and runs an HTMLLoader display object.
 HTMLViewer
com.gestureworks.cml.components The HTMLViewer used the HTMLElement to display a webpage/website on screen.
 ICML
com.gestureworks.cml.interfaces Implements CML compatibility.
 IContainer
com.gestureworks.cml.interfaces Implements CML display containers.
 ICSS
com.gestureworks.cml.interfaces Implements CSS compatibility.
 IDisplay
com.gestureworks.cml.interfaces Implements CML display objects.
 IIterator
com.gestureworks.cml.interfaces Implements an iterator.
 ILayout
com.gestureworks.cml.interfaces Implements container layouts.
 IList
com.gestureworks.cml.interfaces Implements lists.
 IListIterator
com.gestureworks.cml.interfaces Implements a 2-way iterator on Lists.
 Image
com.gestureworks.cml.elements The Image class loads and displays an external bitmap file.
 ImageViewer
com.gestureworks.cml.components The ImageViewer component is primarily meant to display an Image element and its associated meta-data.
 Include
com.gestureworks.cml.elements The Include element allows one to nest CML files.
 IObject
com.gestureworks.cml.interfaces Implements CML Objects.
 IPlay
com.gestureworks.cml.interfaces Implement media control methods
 IState
com.gestureworks.cml.interfaces Implement state API Requires property state array: private var state:Array;
 Key
com.gestureworks.cml.elements The key element simulates a key on a keyboard by dispatching a keyboard event, containing the assigned character and key unicode values, when touched.
 Layout
com.gestureworks.cml.layouts The Layout is the base class for all Layouts.
 LayoutKit
com.gestureworks.cml.layouts The LayoutKit stores global layouts that can be accessed throughout the CML file.
 LayoutManager
com.gestureworks.cml.managers The LayoutManager manages global layout definitions.
 ListLayout
com.gestureworks.cml.layouts The ListLayout positions the display objects in a list.
 LiveVideo
com.gestureworks.cml.elements The LiveVideo element captures and displays live video input from a user’s camera and also captures audio from a microphone.
 LiveVideoViewer
com.gestureworks.cml.components The LiveVideoViewer component is primarily meant to display a LiveVideo element and its associated meta-data.
 Magnifier
com.gestureworks.cml.elements The Magnifier element provides a touch enabled element with an optional graphical lens that will increase the magnification when placed over any display object on the stage.
 MaskContainer
com.gestureworks.cml.elements The MaskContainer element takes in one or multiple images and applies a mask designated in CML to all images in its child list.
 MaskImageViewer
com.gestureworks.cml.components The MaskImageViewer component is primarily meant to display a MaskContainer element and its associated meta-data.
 Media
com.gestureworks.cml.elements The Media class is a wrapper for media elements including the ImageElement, VideoElement, and the MP3Element.
 MediaViewer
com.gestureworks.cml.components The MediaViewer component is primarily meant to display a Media element and its associated meta-data.
 Menu
com.gestureworks.cml.elements The Menu element constructs a custom menu using nested Buttons(s).
 MenuAlbum
com.gestureworks.cml.elements ...
 Microphone
com.gestureworks.cml.elements CML wrapper for AS3 micrphone class package { import flash.display.Sprite; import flash.events.
 ModestMap
com.gestureworks.cml.elements The ModestMap element uses the ModestMaps API to generate an interactive map that can be touched and zoomed.
 ModestMapMarker
com.gestureworks.cml.elements A ModestMapMarker is primarily a container for graphic objects that gives the latitude and longitude of map.
 ModestMapViewer
com.gestureworks.cml.components The ModestMapViewer component is primarily meant to display a ModestMap element and its associated meta-data.
 MP3
com.gestureworks.cml.elements The MP3 element loads an .MP3 file and plays it, with the options to pause, stop, seek, and resume play.
 MP3Player
com.gestureworks.cml.components The MP3Player component is primarily meant to display an MP3 element and its associated meta-data.
 OrbMenu
com.gestureworks.cml.elements The OrbMenu element creates a free-floating menu that optionally randomly floats around the stage in a screen-saver mode.
 Paint
com.gestureworks.cml.elements ...
 PaintViewer
com.gestureworks.cml.components 
 PileLayout
com.gestureworks.cml.layouts The PileLayout positions the centers of the container's objects in the same location and rotates them individually around the center.
 PointLayout
com.gestureworks.cml.layouts The PointLayout positions the objects of a container based on a user defined list of xy coordinates.
 PopupMenu
com.gestureworks.cml.elements Popup menu is used to create a simple menu from a text string of items.
 Preloader
com.gestureworks.cml.elements 
 ProgressBar
com.gestureworks.cml.elements The ProgressBar provides a visual representation of the progress of a task over time.
 RadialSlider
com.gestureworks.cml.elements The RadialSlider element creates a circular progress bar that reponds touch and mouse input.
 RadioButtons
com.gestureworks.cml.elements The RadioButtons element represents a group of radio buttons generated from a user defined list of labels.
 RandomLayout
com.gestureworks.cml.layouts The RandomLayout positions display objects randomly about the x- and y-axes and applies a specified amount of random rotation.
 ResourceManager
com.gestureworks.cml.managers ...
 ScrollBar
com.gestureworks.cml.elements The ScrollBar creates an interactive scroll bar.
 ScrollPane
com.gestureworks.cml.elements The ScrollPane creates a masked viewing area of a display object and dynamically updates two scrollbars as that content is optionally dragged or scaled inside the viewing area.
 SlideMenu
com.gestureworks.cml.elements ...
 Slider
com.gestureworks.cml.elements The Slider element creates s horizontal or vertical slider that reponds touch and mouse input.
 Slideshow
com.gestureworks.cml.elements The Slideshow element takes a set of display objects to its childList and plays through them with a crossfade set through tis rate and fade duration.
 SlideshowViewer
com.gestureworks.cml.components The SlideshowViewer component is primarily meant to display a Slideshow element and its associated meta-data.
 Sound
com.gestureworks.cml.elements 
 SoundManager
com.gestureworks.cml.managers The sound manager only handles Sound elements attached to CML display objects for the purposes of accessibility.
 Stack
com.gestureworks.cml.elements The Stack element is a container that gathers its children into a stack, and allows the user to move through the list using a specified user input.
 StageKit
com.gestureworks.cml.elements The Stage provides access to the stage from CML.
 State
com.gestureworks.cml.elements State element
 StateEvent
com.gestureworks.cml.events The StateEvent is the primary message event for CML elements and compoenents.
 StateManager
com.gestureworks.cml.managers Manages the storage and loading of object states through the RenderKit or the State tag.
 Stepper
com.gestureworks.cml.elements The Stepper element provides a graphical user interface tool to increment and decrement numbers.
 SVG
com.gestureworks.cml.elements 
 SWC
com.gestureworks.cml.elements The SWC element displays an external class from a SWC library file.
 SWF
com.gestureworks.cml.elements The SWF element displays an external class from a SWF library file that has been loaded through a LibraryKit.
 Switch
com.gestureworks.cml.elements The Switch element is acts as a switch button.
 Tab
com.gestureworks.cml.elements The Tab element is a container with a tab extension.
 TabbedContainer
com.gestureworks.cml.elements The TabbedContainer element is a container that allows switching between a group of containers by selecting their associated tabs.
 Text
com.gestureworks.cml.elements The Text element displays a text field.
 TLF
com.gestureworks.cml.elements The TLF element provides access to AS3's TLF system within CML.
 Toggle
com.gestureworks.cml.elements The Toggle element acts as a toggle button.
 TouchContainer
com.gestureworks.cml.elements TouchContainer can be used to create interative display containers.
 TouchKeyboard
com.gestureworks.cml.elements The TouchKeyboard is a virtual keyboard providing an interface for a collection of Key objects and output management for key events.
 Video
com.gestureworks.cml.elements The Video element loads a video and plays it, and provides access to play, pause, stop, and seek methods.
 VideoCamera
com.gestureworks.cml.elements The Camera element captures video from the client system's camera.
 VideoViewer
com.gestureworks.cml.components The VideoViewer component is primarily meant to display a Video element and its associated meta-data.
 View
com.gestureworks.cml.elements The View element is touchable display container with its default size set to the stage.
 WAV
com.gestureworks.cml.elements The WAV element is an AIR required element that loads in a .WAV file and plays it, with the options to pause, stop, and resume play.
 WAVPlayer
com.gestureworks.cml.components The WavPlayer component is primarily meant to display a WAV element and its associated meta-data.
 Window
com.gestureworks.cml.elements Operating system window, CML proxy for AS3's NativeWindow class.
 WindowManager
com.gestureworks.cml.managers Window Manager, Singleton
 YouTube
com.gestureworks.cml.elements The YouTube element retrieves and streams a Youtube video using the Youtube API.
 YouTubeViewer
com.gestureworks.cml.components The YouTubeViewer component is primarily meant to display a YouTube element and its associated meta-data.