Packagede.mightypirates.megazine
Interfacepublic interface IPage extends flash.events.IEventDispatcher

Interface for the Page class, to be used in elements. Especially for external objects, to reduce file size (by only importing the interface and not the actual class with all the code). The actual class is not needed by external elements because they do not need to instantiate new Page objects.


Public Properties
 PropertyDefined by
  isStiff : Boolean
[read-only] Tells whether the page is a stiff or a normal page.
IPage
  pageEven : DisplayObjectContainer
[read-only] Get the even page part
IPage
  pageOdd : DisplayObjectContainer
[read-only] Get the odd page part
IPage
  state : String
[read-only] Gets the page's state
IPage
Public Methods
 MethodDefined by
  
getBackgroundColor(even:Boolean):uint
Get this page's background color
IPage
  
getNumber(even:Boolean):uint
Get the page's number.
IPage
  
getPageThumbnail(even:Boolean):Bitmap
Get the BitMap object that is used for rendering the thumbnail.
IPage
  
getPageVisible(even:Boolean):Boolean
Get whether the even or odd page is visible or not.
IPage
Events
 EventSummaryDefined by
  
invisible_even
Dispatched when the even part of the page becomes invisible (the one displayed on the right).IPage
  
invisible_odd
Dispatched when the odd part of the page becomes invisible (the one displayed on the left).IPage
  
page_complete
Dispatched when the page completes loading.IPage
  
status_change
Dispatched when the state of the page changes.IPage
  
visible_even
Dispatched when the even part of the page becomes visible (the one displayed on the right).IPage
  
visible_odd
Dispatched when the odd part of the page becomes visible (the one displayed on the left).IPage
Property detail
isStiffproperty
isStiff:Boolean  [read-only]

Tells whether the page is a stiff or a normal page.

Implementation
    public function get isStiff():Boolean
pageEvenproperty 
pageEven:DisplayObjectContainer  [read-only]

Get the even page part

Implementation
    public function get pageEven():DisplayObjectContainer
pageOddproperty 
pageOdd:DisplayObjectContainer  [read-only]

Get the odd page part

Implementation
    public function get pageOdd():DisplayObjectContainer
stateproperty 
state:String  [read-only]

Gets the page's state

Implementation
    public function get state():String
Method detail
getBackgroundColor()method
public function getBackgroundColor(even:Boolean):uint

Get this page's background color

Parameters
even:Boolean — For the even page, or for the odd one

Returns
uint — This page's background color
getNumber()method 
public function getNumber(even:Boolean):uint

Get the page's number. Not that this returns the indexed page number, i.e. the count starts at 0.

Parameters
even:Boolean

Returns
uint — The page number
getPageThumbnail()method 
public function getPageThumbnail(even:Boolean):Bitmap

Get the BitMap object that is used for rendering the thumbnail. This BitMap is updated automatically.

Parameters
even:Boolean

Returns
Bitmap — The BitMap with the thumbnail.
getPageVisible()method 
public function getPageVisible(even:Boolean):Boolean

Get whether the even or odd page is visible or not.

Parameters
even:Boolean — Even or odd page.

Returns
Boolean — Visible or nor.
Event detail
invisible_evenevent 
Event object type: de.mightypirates.megazine.events.MegaZineEvent
MegaZineEvent.type property = de.mightypirates.megazine.events.MegaZineEvent.INVISIBLE_EVEN

Dispatched when the even part of the page becomes invisible (the one displayed on the right).

Even page becomes invisible.

invisible_oddevent  
Event object type: de.mightypirates.megazine.events.MegaZineEvent

Dispatched when the odd part of the page becomes invisible (the one displayed on the left).

page_completeevent  
Event object type: de.mightypirates.megazine.events.MegaZineEvent
MegaZineEvent.type property = de.mightypirates.megazine.events.MegaZineEvent.PAGE_COMPLETE

Dispatched when the page completes loading.

Event dispatched when a page completes loading its elements.

status_changeevent  
Event object type: de.mightypirates.megazine.events.MegaZineEvent
MegaZineEvent.type property = de.mightypirates.megazine.events.MegaZineEvent.STATUS_CHANGE

Dispatched when the state of the page changes.

Dispatched when the status changes.

visible_evenevent  
Event object type: de.mightypirates.megazine.events.MegaZineEvent
MegaZineEvent.type property = de.mightypirates.megazine.events.MegaZineEvent.VISIBLE_EVEN

Dispatched when the even part of the page becomes visible (the one displayed on the right).

Dispatched page becomes visible.

visible_oddevent  
Event object type: de.mightypirates.megazine.events.MegaZineEvent
MegaZineEvent.type property = de.mightypirates.megazine.events.MegaZineEvent.VISIBLE_ODD

Dispatched when the odd part of the page becomes visible (the one displayed on the left).

Odd page becomes visible.