Packagecom.rubenswieringa.book
Classpublic class BookEvent
InheritanceBookEvent Inheritance flash.events.Event

Event class specifying type property values for Events broadcasted by the Book class.

See also

Book

Public Properties
 PropertyDefined by
  book : Book
[read-only] Returns the Book instance associated with this BookEvent (actually the PageManager instance casted to a Book type).
BookEvent
  page : Page
[read-only] Returns the Page instance associated with this BookEvent.
BookEvent
  pageManager : PageManager
[read-only] Returns the PageManager instance associated with this BookEvent.
BookEvent
Public Methods
 MethodDefined by
  
BookEvent(type:String, book:PageManager, page:Page = null, bubbles:Boolean = false, cancelable:Boolean = false)
Creates a BookEvent object to pass as a parameter to event listeners.
BookEvent
Public Constants
 ConstantDefined by
  BOOK_CLOSED : String = "bookClosed"
[static] Dispatched at the same time as the page-turned, when the Book was previously open, and the first or last Page was flipped successfully.
BookEvent
  BOOK_OPENED : String = "bookOpened"
[static] Dispatched at the same time as the page-turned, when the Book was previously closed, and the first or last Page was flipped successfully.
BookEvent
  CONTENT_CHANGED : String = "contentChanged"
[static] Dispatched when a page is added to or removed from the PageManager.
BookEvent
  HOVER_ENDING : String = "hoverEnding"
[static] Dispatched when the corner of a page is rolled out of with the mouse.
BookEvent
  HOVER_FINISHED : String = "hoverFinished"
[static] Dispatched when a page falls back in place after being rolled over with the mouse.
BookEvent
  HOVER_STARTED : String = "hoverStarted"
[static] Dispatched when the corner of a page is rolled over with the mouse.
BookEvent
  NOT_FLIPPING : String = "notFlipping"
[static] Book state indicating that no pageflip is currently being executed.
BookEvent
  PAGEFLIP_ENDING : String = "pageflipEnding"
[static] Dispatched when the corner of a page is released.
BookEvent
  PAGEFLIP_FINISHED : String = "pageflipFinished"
[static] Dispatched when a page falls back in place after being flipped.
BookEvent
  PAGEFLIP_STARTED : String = "pageflipStarted"
[static] Dispatched when the the corner of a page is picked up.
BookEvent
  PAGE_NOT_TURNED : String = "pageNotTurned"
[static] Dispatched when a pageflip is not successful.
BookEvent
  PAGE_TORN : String = "pageTorn"
[static] Dispatched when a Page is torn out of its Book.
BookEvent
  PAGE_TURNED : String = "pageTurned"
[static] Dispatched when a pageflip is successful.
BookEvent
  STATUS_CHANGED : String = "statusChanged"
[static] Dispatched when the status of the Book changes.
BookEvent
Property detail
bookproperty
book:Book  [read-only]

Returns the Book instance associated with this BookEvent (actually the PageManager instance casted to a Book type).

Implementation
    public function get book():Book

See also

BookEvent.html#pageManager
pageproperty 
page:Page  [read-only]

Returns the Page instance associated with this BookEvent.

Implementation
    public function get page():Page
pageManagerproperty 
pageManager:PageManager  [read-only]

Returns the PageManager instance associated with this BookEvent.

Implementation
    public function get pageManager():PageManager

See also

BookEvent.html#book
Constructor detail
BookEvent()constructor
public function BookEvent(type:String, book:PageManager, page:Page = null, bubbles:Boolean = false, cancelable:Boolean = false)

Creates a BookEvent object to pass as a parameter to event listeners.

Parameters
type:String — The type of the event, accessible as BookEvent.type.
 
book:PageManager — Determines whether the BookEvent object participates in the bubbling stage of the event flow.
 
page:Page (default = null) — Determines whether the BookEvent object can be canceled.
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
Constant detail
BOOK_CLOSEDconstant
public static const BOOK_CLOSED:String = "bookClosed"

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

See also

BookEvent.PAGE_TURNED
BOOK_OPENEDconstant 
public static const BOOK_OPENED:String = "bookOpened"

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

See also

BookEvent.PAGE_TURNED
CONTENT_CHANGEDconstant 
public static const CONTENT_CHANGED:String = "contentChanged"

Dispatched when a page is added to or removed from the PageManager.

See also

PageManager.pages
CURRENTPAGE_CHANGEDconstant 
limited static const CURRENTPAGE_CHANGED:String = "currentPageChanged"

Dispatched when the value of a PageManager its currentPage property changes.

See also

PageManager.currentPage
HOVER_ENDINGconstant 
public static const HOVER_ENDING:String = "hoverEnding"

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 of the accompanying Book instance is set to true.

See also

Book.hover
BookEvent.HOVER_FINISHED
HOVER_FINISHEDconstant 
public static const HOVER_FINISHED:String = "hoverFinished"

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

See also

Book.hover
HOVER_STARTEDconstant 
public static const HOVER_STARTED:String = "hoverStarted"

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

See also

Book.hover
NOT_FLIPPINGconstant 
public static const NOT_FLIPPING:String = "notFlipping"

Book state indicating that no pageflip is currently being executed.

PAGEFLIP_ENDINGconstant 
public static const PAGEFLIP_ENDING:String = "pageflipEnding"

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

See also

BookEvent.PAGEFLIP_FINISHED
PAGEFLIP_FINISHEDconstant 
public static const PAGEFLIP_FINISHED:String = "pageflipFinished"

Dispatched when a page falls back 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.PAGE_TURNED
PAGEFLIP_STARTEDconstant 
public static const PAGEFLIP_STARTED:String = "pageflipStarted"

Dispatched when the the corner of a page is picked up.

PAGE_NOT_TURNEDconstant 
public static const PAGE_NOT_TURNED:String = "pageNotTurned"

Dispatched when a pageflip is not successful.

See also

BookEvent.PAGE_TURNED
PAGE_TORNconstant 
public static const PAGE_TORN:String = "pageTorn"

Dispatched when a Page is torn out of its Book.

PAGE_TURNEDconstant 
public static const PAGE_TURNED:String = "pageTurned"

Dispatched when a pageflip is successful.

See also

BookEvent.PAGE_NOT_TURNED
STATUS_CHANGEDconstant 
public static const STATUS_CHANGED:String = "statusChanged"

Dispatched when the status of the Book changes.

See also

Book.status