Page Object: Difference between revisions

Latest revision as of 17:46, 10 July 2012

The Page Object is the object that stores a page in the flipbook.

Key	Type	Description	Sample value
acceleration	Boolean	The acceleration mode for this page	true
cornerSize	Number	Width and height in pixels of the each corner	100
next	Number	The page will turn to the number of page specified here	2
page	Number	The current page number	1
turn	jQuery Element	A reference to the current flipbook	$("#flipbook")
z-index	Number	The z position of this page	10

$("#flipbook").turn("start", function(event, pageObject, corner) {

	if (pageObject.page==1) {
		pageObject.next = 4;
	}
});

This example will skip the page 2 when turning the page from 1.

@@ Line 1: / Line 1: @@
 The Page Object is the object that stores a page in the flipbook.
-==Sample==
+{| class="wikitable"
+|-
+! scope="col"| Key
+! scope="col"| Type
+! scope="col"| Description
+! scope="col"| Sample value
+|-
+| acceleration
+| Boolean
+| The acceleration mode for this page
+| true
+|-
+| cornerSize
+| Number
+| Width and height in pixels of the each corner
+| 100
+|-
+| next
+| Number
+| The page will turn to the number of page specified here
+| 2
+|-
+| page
+| Number
+| The current page number
+| 1
+|-
+| turn
+| jQuery Element
+| A reference to the current flipbook
+| <pre class="javascript">$("#flipbook")</pre>
+|-
+| z-index
+| Number
+| The z position of this page
+| 10
+|}
+==Example==
 <pre class="javascript">
-{
+$("#flipbook").turn("start", function(event, pageObject, corner) {
-	acceleration: true
-	cornerSize: 100
+	if (pageObject.page==1) {
-	duration: 600
+		pageObject.next = 4;
-	gradients: true
+	}
-	next: 2
+});
-	page: 1
-	turn: $("#flipbook")
-	z-index: 24
-}
 </pre>
+This example will skip the page 2 when turning the page from 1.
+==See also==
+[[Event: start| Event: start]]
 <yambe:breadcrumb>API</yambe:breadcrumb>