com.rubenswieringa.book.Book

	Property	Defined by
		autoFlipDuration : uint = 1000 The time (milliseconds) it takes to finish a pageflip performed by the gotoPage method.	Book
		currentPage : int Index of the current left-hand page (-1 if the Book is unopened).	PageManager
		easing : Number The precision with which the page-corner follows the mouse during a pageflip.	Book
		flipOnClick : Boolean = true Whether or not the page should be turned when a page corner is clicked.	Book
		hardCover : Boolean If true, the first and last Pages in this Book will be hard, regardless of the value of their own hard properties.	Book
		hardPerspective : uint = 45 Amount of perspective in a pageflip of a Page that has its hard property set to true.	Book
		hover : Boolean Set this property to false if the four outer page-corners should not display a subtle flip-effect on mouse-over.	Book
		liveBitmapping : Boolean = false Indicates whether or not this Book plays animation while flipping one of its Pages.	Book
		openAt : int Index of the Page at which the Book is opened at startup, can only be set once, and only at startup.	PageManager
		pages : ArrayCollection Array of all respective Pages in this Book instance.	PageManager
		regionSize : uint Size of the hit-regions in the pagecorners.	Book
		sideFlip : Boolean = true Whether or not the outer side of a Page can be used to let it flip.	Book
		snap : Boolean = false If true, no easing will be applied during pageflips.	Book
		status : String [write-only] Current status of the Book.	Book
		tearable : Boolean = false If true, all Pages will have tearing enabled.	Book

	Method	Defined by
		Book() Constructor.	Book
		addChild(child:DisplayObject):DisplayObject Adds a child Page instance to this PageManager instance.	PageManager
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child Page instance to this PageManager instance at the index position specified.	PageManager
		cancelGotoPage(finishFlip:Boolean = true):void Aborts a pageflip started by the gotoPage method.	Book
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the PageManager instance or the instance itself.	PageManager
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	PageManager
		getChildIndex(child:DisplayObject):int Returns the index position of a child Page instance.	PageManager
		getChildren():Array Returns an Array of Page objects consisting of the content children of the container.	PageManager
		getLastFlippedCorner():Point Returns a Point instance indicating the corner that was last flipped.	Book
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this PageManager instance.	PageManager
		gotoPage(page:*, cancelable:Boolean = true):void Performs a pageflip without the user having to drag the pagecorner.	Book
		nextPage():void Performs a pageflip to the next page, without the user having to drag the pagecorner.	Book
		owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this PageManager.	PageManager
		prevPage():void Performs a pageflip to the previous page, without the user having to drag the pagecorner.	Book
		removeAllChildren():void Removes all children (Page instances) from the child list of this container.	PageManager
		removeChild(child:DisplayObject):DisplayObject Removes a child Page from the child list of this Container.	PageManager
		removeChildAt(index:int):DisplayObject Removes a child Page from the child list of this Container at the specified index.	PageManager
		setChildIndex(child:DisplayObject, newIndex:int):void Changes the position of an existing child in the PageManager container.	PageManager
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the position of two Page instances in the PageManager.	Book
		swapChildrenAt(index1:int, index2:int):void Swaps the position of two Page instances in the PageManager at the specified indexes.	PageManager
		tearPage(page:*, fromTop:Boolean = true):void Tears a Page out of this Book instance.	Book

Summary	Defined by
bookClosed	Dispatched at the same time as the page-turned Event, when the Book was previously open, and the first or last Page was flipped successfully.	Book
bookOpened	Dispatched at the same time as the page-turned Event, when the Book was previously closed, and the first or last Page was flipped successfully.	Book
contentChanged	Dispatched when a page is added to or removed from the PageManager.	PageManager
hoverEnding	Dispatched when the corner of a page is rolled out of with the mouse.	Book
hoverFinished	Dispatched when a page falls back in place after being rolled over with the mouse.	Book
hoverStarted	Dispatched when the corner of a page is rolled over with the mouse.	Book
pageflipEnding	Dispatched when the user releases the corner of a page.	Book
pageflipFinished	Dispatched when a page falls in place after being flipped.	Book
pageflipStarted	Dispatched when the user picks up the corner of a page.	Book
pageNotTurned	Dispatched when a pageflip is not successful.	Book
pageTorn	Dispatched when a Page is torn out of its Book.	Book
pageTurned	Dispatched when a pageflip is successful.	Book
statusChanged	Dispatched at the same time as the page-turned Event, when the Book was previously open, and the first or last Page was flipped successfully.	Book

Property detail

autoFlipDuration

property

public var autoFlipDuration:uint = 1000

The time (milliseconds) it takes to finish a pageflip performed by the gotoPage method. The calculated speed will also be used for tearing out Pages.

The default value is 1000.

See also

Book.html#gotoPage()

easing

property

easing:Number [read-write]

The precision with which the page-corner follows the mouse during a pageflip. Values range from 0 (no easing) to 1 (heavy easing).

The default value is 0.7.

Implementation
public function get easing():Number
public function set easing(value:Number):void

flipOnClick

property

public var flipOnClick:Boolean = true

Whether or not the page should be turned when a page corner is clicked.

The default value is true.

hardCover

property

hardCover:Boolean [read-write]

If true, the first and last Pages in this Book will be hard, regardless of the value of their own hard properties.

The default value is true.

Implementation
public function get hardCover():Boolean
public function set hardCover(value:Boolean):void

hardPerspective

property

public var hardPerspective:uint = 45

Amount of perspective in a pageflip of a Page that has its hard property set to true. This value is used as the maximum with which the outer side of a page is extended on both sides (upper and lower) during a hard pageflip.

The default value is 45.

hover

property

hover:Boolean [read-write]

Set this property to false if the four outer page-corners should not display a subtle flip-effect on mouse-over. Note that Pages with their hard property set to true do not display hover-effects at all.

The default value is true.

Implementation
public function get hover():Boolean
public function set hover(value:Boolean):void

liveBitmapping

property

public var liveBitmapping:Boolean = false

Indicates whether or not this Book plays animation while flipping one of its Pages. When this property is set to true, all Page instances will return true from their liveBitmapping property. Note that enabling liveBitmapping may result in decreased performance.

The default value is false.

See also

Page.html#liveBitmapping

regionSize

property

regionSize:uint [read-write]

Size of the hit-regions in the pagecorners.

The default value is 150.

Implementation
public function get regionSize():uint
public function set regionSize(value:uint):void

sideFlip

property

public var sideFlip:Boolean = true

Whether or not the outer side of a Page can be used to let it flip.

The default value is true.

snap

property

public var snap:Boolean = false

If true, no easing will be applied during pageflips.

The default value is false.

See also

Book.html#easing

status

property

status:String [write-only]

Current status of the Book.

This property can be used as the source for data binding.

Implementation
public function set status(value:String):void

tearable

property

public var tearable:Boolean = false

If true, all Pages will have tearing enabled.

The default value is false.

See also

Page.html#tearable

Constructor detail

Book

()

constructor

public function Book()

Constructor.

Method detail

cancelGotoPage

()

method

public function cancelGotoPage(finishFlip:Boolean = true):void

Aborts a pageflip started by the gotoPage method.

Parameters

finishFlip:Boolean (default = true) — Boolean indicating whether or not to allow the auto-flip to finish. When true, the pageflip will finish. When false, the auto-flip will immediately stop, and the page corner will start sticking to the mouse.

See also

Book.html#gotoPage()

getLastFlippedCorner

()

method

public function getLastFlippedCorner():Point

Returns a Point instance indicating the corner that was last flipped.

Returns

Point — Point

gotoPage

()

method

public function gotoPage(page:*, cancelable:Boolean = true):void

Performs a pageflip without the user having to drag the pagecorner.

Parameters

	`page:*` — int/uint or Page, indicating the index or instance of a Page.

	`cancelable:Boolean` (default = `true`) — Indicates whether or not this auto-flip should allow cancelGotoPage to be called.

Throws

	— Gets thrown when the child parameter is not an instance of the Page class nor a int/uint.

	— Gets thrown when the child parameter is not a child of this Book.

()

method

public function nextPage():void

Performs a pageflip to the next page, without the user having to drag the pagecorner.

()

method

public function prevPage():void

Performs a pageflip to the previous page, without the user having to drag the pagecorner.

swapChildren

()

method

public override function swapChildren(child1:DisplayObject, child2:DisplayObject):void

Swaps the position of two Page instances in the PageManager.

Parameters

	`child1:DisplayObject` — The first child object.

	`child2:DisplayObject` — The second child object.

tearPage

()

method

public function tearPage(page:*, fromTop:Boolean = true):void

Tears a Page out of this Book instance. When called, this method will be executed regardless of the value of the Page its tearable property. Fails silently if the provided Page is not one of the currently visible Pages.

Parameters

	`page:*` — int/uint or Page, indicating the index or instance of a Page to be torn out of this Book.

	`fromTop:Boolean` (default = `true`) — If true, the Page will be torn out by its upper outer corner, if false by its lower outer corner.

Throws

— Gets thrown when page is an index-value and out of bounds.

Event detail

bookClosed

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched at the same time as the page-turned Event, when the Book was previously open, and the first or last Page was flipped successfully.

See also

BookEvent.html#PAGE_TURNED

bookOpened

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched at the same time as the page-turned Event, when the Book was previously closed, and the first or last Page was flipped successfully.

See also

BookEvent.html#PAGE_TURNED

hoverEnding

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched when the corner of a page is rolled out of with the mouse. Note that this Event is dispatched just before the page starts falling back in place. Only applicable if the hover property is set to true.

hoverFinished

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched when a page falls back in place after being rolled over with the mouse. Only applicable if the hover property is set to true.

hoverStarted

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched when the corner of a page is rolled over with the mouse. Only applicable if the hover property is set to true.

pageflipEnding

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched when the user releases the corner of a page. Note that this Event is dispatched just before the page starts falling in place.

See also

BookEvent.html#PAGEFLIP_FINISHED

pageflipFinished

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched when a page falls in place after being flipped. This Event is dispatched regardless of whether or not the page has been turned, or has fallen back into its original position.

See also

BookEvent.html#PAGE_TURNED

pageflipStarted

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched when the user picks up the corner of a page.

See also

BookEvent.html#PAGEFLIP_STARTED

pageNotTurned

event

Event object type: com.rubenswieringa.book.BookEvent

Dispatched when a pageflip is not successful.