Package | com.gestureworks.cml.elements |
Class | public class FlipBook |
Inheritance | FlipBook ![]() ![]() |
Property | Defined By | ||
---|---|---|---|
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
backgroundColor : uint
The color seen if the page backgrounds are exposed. | FlipBook | ||
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
![]() | cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
![]() | cmlIndex : 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 | ||
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | group : 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 | ||
![]() | heightPercent : 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 | ||
![]() | id : 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 | ||
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | TouchContainer | |
![]() | paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | TouchContainer | |
![]() | paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | TouchContainer | |
![]() | paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | TouchContainer | |
![]() | position : *
Sets the position
| TouchContainer | |
![]() | relativeX : Boolean
When set true this containers children's x position will be laid out relatively
to each other. | TouchContainer | |
![]() | relativeY : 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 | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | toBitmap : 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 | ||
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Property | Defined By | ||
---|---|---|---|
![]() | cmlGestureList : Object | TouchContainer | |
pageContent : Array | FlipBook |
Method | Defined By | ||
---|---|---|---|
FlipBook()
Constructor
| FlipBook | ||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
![]() | clone():*
Clone method
| TouchContainer | |
dispose():void [override]
Destructor
| FlipBook | ||
![]() | getElementById(id:String):*
Searches CML childList by id. | TouchContainer | |
![]() | getElementsByClassName(className:String):Array
Searches the CML childList by className. | TouchContainer | |
![]() | getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class. | TouchContainer | |
init():void [override]
Initialization method
| FlipBook | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
![]() | parseCML(cml:XMLList):XMLList
Parse cml for local layouts. | TouchContainer | |
![]() | postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine. | TouchContainer | |
![]() | querySelector(selector:String):*
Searches the CML childList by selector. | TouchContainer | |
![]() | querySelectorAll(selector:*):Array
Search the CML childList by selector. | TouchContainer | |
![]() | removeChild(child:DisplayObject):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildAt(index:int):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | 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 | ||
![]() | saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number. | TouchContainer | |
![]() | searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
![]() | updatePadding():void
Updates child padding within this container
| TouchContainer | |
![]() | updatePercentDim():void
Updates child percent dimensions within this container
| TouchContainer | |
![]() | updateProperties(state:* = 0):void
Updates properties from state. | TouchContainer | |
![]() | updateRelativePos():void
Updates child relative positions within this container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
onRegularComplete(e:GWGestureEvent):void | FlipBook | ||
onRegularDrag(e:GWGestureEvent):void | FlipBook | ||
onRegularRotate(e:GWGestureEvent):void | FlipBook | ||
onRegularScale(e:GWGestureEvent):void | FlipBook |
backgroundColor | property |
backgroundColor:uint
The color seen if the page backgrounds are exposed.
public function get backgroundColor():uint
public function set backgroundColor(value:uint):void
cornerGlow | property |
cornerGlow:Boolean
Sets whether or not there is a glow with the corner indicators
public function get cornerGlow():Boolean
public function set cornerGlow(value:Boolean):void
cornerGlowColor | property |
cornerGlowColor:uint
Sets the corner glow color
public function get cornerGlowColor():uint
public function set cornerGlowColor(value:uint):void
cornerIndicators | property |
cornerIndicators:Boolean
Sets whether or not to show cornerIndicators
public function get cornerIndicators():Boolean
public function set cornerIndicators(value:Boolean):void
currentPage | property |
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.
public function get currentPage():Number
height | property |
height:Number
[override] The height remains the same, but is used to also keep track of the page height for coding consistency.
public function get height():Number
public function set height(value:Number):void
hitAreaSize | property |
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.
public function get hitAreaSize():Number
public function set hitAreaSize(value:Number):void
indicatorAlpha | property |
indicatorAlpha:Number
Sets the highest alpha of the corner indicators
public function get indicatorAlpha():Number
public function set indicatorAlpha(value:Number):void
indicatorColor | property |
indicatorColor:uint
Sets the color of the corner indicators
public function get indicatorColor():uint
public function set indicatorColor(value:uint):void
pageContent | property |
protected var pageContent:Array
singlePageView | property |
singlePageView:Boolean
Sets whether the flipbook is a spread (like a book), or a single page
public function get singlePageView():Boolean
public function set singlePageView(value:Boolean):void
transformParent | property |
transformParent:Boolean
A variation of targetParent, this is to inform the flipbook to target the parent for native transformations
public function get transformParent():Boolean
public function set transformParent(value:Boolean):void
width | property |
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.
public function get width():Number
public function set width(value:Number):void
FlipBook | () | Constructor |
public function FlipBook()
Constructor
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