Packagecom.gestureworks.cml.elements
Classpublic class FlipBook
InheritanceFlipBook Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

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.



Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  backgroundColor : uint
The color seen if the page backgrounds are exposed.
FlipBook
 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
  cornerGlow : Boolean
Sets whether or not there is a glow with the corner indicators
FlipBook
  cornerGlowColor : uint
Sets the corner glow color
FlipBook
  cornerIndicators : Boolean
Sets whether or not to show cornerIndicators
FlipBook
  currentPage : Number
[read-only] Retrieves the current page.
FlipBook
 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] The height remains the same, but is used to also keep track of the page height for coding consistency.
FlipBook
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
  hitAreaSize : Number
The a percentage based on page-width that will determine how wide the hit area in the corners and edges will be.
FlipBook
 Inheritedid : String
Returns the object's id.
TouchContainer
  indicatorAlpha : Number
Sets the highest alpha of the corner indicators
FlipBook
  indicatorColor : uint
Sets the color of the corner indicators
FlipBook
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 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
  singlePageView : Boolean
Sets whether the flipbook is a spread (like a book), or a single page
FlipBook
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  transformParent : Boolean
A variation of targetParent, this is to inform the flipbook to target the parent for native transformations
FlipBook
  width : Number
[override] The width is overridden.
FlipBook
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
  pageContent : Array
FlipBook
Public Methods
 MethodDefined By
  
Constructor
FlipBook
 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
FlipBook
 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
  
init():void
[override] Initialization method
FlipBook
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 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
  
reset():void
FlipBook
 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
  
onRegularComplete(e:GWGestureEvent):void
FlipBook
  
onRegularDrag(e:GWGestureEvent):void
FlipBook
  
onRegularRotate(e:GWGestureEvent):void
FlipBook
  
onRegularScale(e:GWGestureEvent):void
FlipBook
Property Detail
backgroundColorproperty
backgroundColor:uint

The color seen if the page backgrounds are exposed.


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
cornerGlowproperty 
cornerGlow:Boolean

Sets whether or not there is a glow with the corner indicators


Implementation
    public function get cornerGlow():Boolean
    public function set cornerGlow(value:Boolean):void
cornerGlowColorproperty 
cornerGlowColor:uint

Sets the corner glow color


Implementation
    public function get cornerGlowColor():uint
    public function set cornerGlowColor(value:uint):void
cornerIndicatorsproperty 
cornerIndicators:Boolean

Sets whether or not to show cornerIndicators


Implementation
    public function get cornerIndicators():Boolean
    public function set cornerIndicators(value:Boolean):void
currentPageproperty 
currentPage:Number  [read-only]

Retrieves the current page. The page returned is the page on the right, not the left, and counting starts from 0, not 1. So if the _currentPage is 2, the page on the right is page 3 and the page on the left is page 2.


Implementation
    public function get currentPage():Number
heightproperty 
height:Number[override]

The height remains the same, but is used to also keep track of the page height for coding consistency.


Implementation
    public function get height():Number
    public function set height(value:Number):void
hitAreaSizeproperty 
hitAreaSize:Number

The a percentage based on page-width that will determine how wide the hit area in the corners and edges will be. For example, for a 200 px wide page (thus a 400 px wide Flipbook), a value of 0.2 will create an area 40 pixels wide x 40 pixels tall in the corners for hit, and 20 pixels wide along the edges between the corners. This property is set on initialization and changing it aftewards will not change the hit area size.


Implementation
    public function get hitAreaSize():Number
    public function set hitAreaSize(value:Number):void
indicatorAlphaproperty 
indicatorAlpha:Number

Sets the highest alpha of the corner indicators


Implementation
    public function get indicatorAlpha():Number
    public function set indicatorAlpha(value:Number):void
indicatorColorproperty 
indicatorColor:uint

Sets the color of the corner indicators


Implementation
    public function get indicatorColor():uint
    public function set indicatorColor(value:uint):void
pageContentproperty 
protected var pageContent:Array

singlePageViewproperty 
singlePageView:Boolean

Sets whether the flipbook is a spread (like a book), or a single page


Implementation
    public function get singlePageView():Boolean
    public function set singlePageView(value:Boolean):void
transformParentproperty 
transformParent:Boolean

A variation of targetParent, this is to inform the flipbook to target the parent for native transformations


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

The width is overridden. Any width given is assumed to be the "page" width for the desired content. The actual width of this container will be twice whatever is input.


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

Constructor

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

Destructor

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

Initialization method

onRegularComplete()method 
protected function onRegularComplete(e:GWGestureEvent):void

Parameters

e:GWGestureEvent

onRegularDrag()method 
protected function onRegularDrag(e:GWGestureEvent):void

Parameters

e:GWGestureEvent

onRegularRotate()method 
protected function onRegularRotate(e:GWGestureEvent):void

Parameters

e:GWGestureEvent

onRegularScale()method 
protected function onRegularScale(e:GWGestureEvent):void

Parameters

e:GWGestureEvent

reset()method 
public function reset():void