User Tools

Site Tools


cml_reference

CML Reference

Definitions

Term Definition
* All
Data Tag which is used to pass information to an object
Object Tag which creates an programming object
Display Object Tag which creates an object that is capable of being rendered on-screen
Interactive Display Object Tag which creates an object that is a display object and can be manipulated through mouse, touch, and gesture events

Description

Characteristic Definition
Type Tag type (e.g. Data, Object, Display Object, Interactive Display Object)
Category Object category (e.g. Component, Element, etc.)
Scope Context in which the tag is accessible
Position Nested position within the CML document tree
Parents Acceptable parent tags
Children Acceptable child tags
Gestures Compatible gestures
Attributes Acceptable attributes
Requirements List of requirements (attributes, parent, child, etc)

Components

Component Description
AlbumViewer The AlbumViewer component is primarily meant to display an Album element and its associated meta-data.
CollectionViewer The CollectionViewer component manages the display of components and elements.
Component The Component manages a group of elements to create a high-level interactive touch container.
FlickrViewer The FlickrViewer component is primarily meant to display a Flickr element and its associated meta-data.
GigapixelViewer The GigapixelViewer component is primarily meant to display a Gigapixel element and its associated meta-data.
ImageViewer The ImageViewer component is primarily meant to display an Image element and its associated meta-data.
LiveVideoViewer The LiveVideoViewer component is primarily meant to display a LiveVideo element and its associated meta-data.
MaskImageViewer The MaskImageViewer component is primarily meant to display a MaskContainer element and its associated meta-data.
MediaViewer The MediaViewer component is primarily meant to display a Media element and its associated meta-data.
ModestMapViewer The ModestMapViewer component is primarily meant to display a ModestMap element and its associated meta-data.
MP3Player The MP3Player component is primarily meant to display an MP3 element and its associated meta-data.
PanoramicViewer The PanoramicViewer component is primarily meant to display a Panoramic element and its associated meta-data.
VideoViewer The VideoViewer component is primarily meant to display a Video element and its associated meta-data.
WavPlayer The WAVPlayer component is primarily meant to display a WAV element and its associated meta-data.
YouTubeViewer The YouTubeViewer component is primarily meant to display a YouTube element and its associated meta-data.

Elements

Element Description
Album The Album element provides a list of display objects that can be scrolled horizontally or vertically using a drag gesture.
Button The Button hides or shows DisplayObjects on specified state events.
Camera The Camera element captures video from the client system's camera.
ColorPicker The ColorPicker element provides color selection capability by moving graphical indicators or adjusting color properties to select hue and color variants.
Container The Container element controls the layout characteristics of child components.
DatePicker The DatePicker element provides date selection capability.
Dial The Dial element provides a list of text elements in rotary selection tool.
DropDownMenu Drop down menu is used to create a simple menu from a text string of items.
Flickr The Flick element provides access to images stored on Flickr through the Flickr API.
Frame The Frame element create display object frames.
Gesture The Gesture class allows you to create gestures in CML.
GestureList The GestureList class allows you to create a group of gestures in CML.
Gigapixel The Gigapixel element loads a gigapixel image.
Graphic The graphic element can draw many types of graphic types.
Image The Image class loads and displays an external bitmap files.
ImageList The ImageList element create a set of images through and orderered list.
ImageSequence The ImageSequence element creates a list of images and contains a build-in sequencer.
Image Slideshow The ImageSlideshow element creates a list of images and contains a build-in sequencer with fade transitions.
Include The Include element allows one to nest CML files.
Key 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 The Layout sets the locations and orientations of a container's display objects. There is a different distribution for each layout type specified by the classRef attribute.
LiveVideo The LiveVideo element captures and displays live video input from a user’s camera and also captures audio from a microphone.
Magnifier 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 The MaskContainer element takes in one or multiple images and applies a mask designated in CML to all images in its child list.
Media The Media class is a wrapper for media elements including the ImageElement, VideoElement, and the MP3Element.
Menu The Menu element constructs a custom menu using nested Buttons(s).
Microphone Microphone capture audio from a microphone.
ModestMap The ModestMap element uses the ModestMaps API to generate an interactive map that can be touched and zoomed.
ModestMapMarker A ModestMapMarker is primarily a container for graphic objects that gives the latitude and longitude of map.
MP3 The MP3 element loads an .MP3 file and plays it, with the options to pause, stop, seek, and resume play.
OrbMenu The OrbMenu element creates a free-floating menu that optionally randomly floats around the stage in a screen-saver mode.
Panoramic The Panoramic element provides a touch-enabled, 3-Dimensional panorama using the Away3D 4 library.
RadioButtons The RadioButtons element represents a group of radio buttons generated from a user defined list of labels.
ScrollBar The Scrollbar element scrolls contained content and allows the user to set the location of scrollbar from vertical to horizontal or horizontal to vertical.
ScrollPane The ScrollPane element scrolls the text or image and allows the user to change the scrollbar location and set the path of image through the imageUrl attribute.
Slider The Slider element creates s horizontal or vertical slider that reponds touch and mouse input.
Slideshow 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.
Stack 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.
Stepper The Stepper element provides a graphical user interface tool to increment and decrement numbers.
SWC The SWC element displays an external class from a SWC library file.
SWF The SWF element displays an external class from a SWF library file that has been loaded through a LibraryKit.
Switch The Switch element is acts as a switch button.
Tab The Tab element is a container with a tab extension.
TabbedContainer The TabbedContainer element is a container that allows switching between a group of containers by selecting their associated tabs.
Text The Text element displays a text fields.
TLF The TLF element provides access to AS3's TLF system within CML.
Toggle The Toggle element acts as a toggle button.
TouchContainer TouchContainer can be used to create interative display containers.
TouchKeyboard The TouchKeyboard is a virtual keyboard providing an interface for a collection of Key objects and output management for key events.
Video The Video element loads a video and plays it, and provides access to play, pause, stop, and seek methods.
View The View element is touchable display container with its default size set to the stage.
Wav 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.
YouTube The YouTube element retrieves and streams a Youtube video using the Youtube API.

Kits

Kit Description
BackgroundKit The BackgroundKit resizes its children to the center of the stage.
ComponentKit The ComponentKit creates and manges components.
LayoutKit The LayoutKit stores global layouts that can be accessed throughout the CML file.
LibraryKit The LibraryKit stores global libray assets that can be accessed throughout the CML file.
StageKit The StageKit provides access to the stage from CML.
cml_reference.txt · Last modified: 2015/09/18 14:23 by glass