Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.
| Class | Package | Description | |
|---|---|---|---|
| AbstractOverlay
| de.mightypirates.megazine.plugins.overlays.realizations | Base class to element overlays, as well as home to the factory functions createOverlay and createOverlays (for creating multiple overlays at once). | |
| AbstractPlugin
| de.mightypirates.megazine.plugins | "Abstract" superclass for all plugins, providing common functionality. | |
| AliasBundle
| de.mightypirates.utils.loading | The AliasBundle is a resource bundle that performs no loading of its own, but instead can be used to reroute requests to different URLs. | |
| AlphaTween
| de.mightypirates.tween |
Class for alpha value tweening of DisplayObjects. |
|
| Anchors
| de.mightypirates.megazine.plugins.anchors | This plugin provides the functionality to define anchors for chapters and pages. | |
| Area
| de.mightypirates.megazine.elements |
Area (area) elements can be used to genereate tooltips and links
anywhere on a page. |
|
| AsulFactory
| de.mightypirates.asul | This class serves as a utility class for generating ASUL objects defined in an external definition file. | |
| AsulObject
| de.mightypirates.megazine.elements | Element allowing the use of ASUL objects as page elements. | |
| AsulStyleAdapter
| de.mightypirates.asul | Style adapter implementation for ASUL objects. | |
| BackgroundSoundHandler
| de.mightypirates.megazine.plugins.backgroundsounds |
This class is instantiated by the BackgroundSound plugin
whenever it needs to create a background sound for an object. |
|
| BackgroundSounds
| de.mightypirates.megazine.plugins.backgroundsounds | Allows the user to define background sounds for chapters and pages. | |
| BatchPages
| de.mightypirates.megazine.plugins.batchpages |
This plugin is responsible for resolving the pages attribute
of chapters by creating pages from the batch definition. |
|
| BitmapDataPool
| de.mightypirates.utils | BitmapData pooling class. | |
| Bookmark
| de.mightypirates.megazine.plugins.bookmarks | This class represents single bookmarks. | |
| Bookmarks
| de.mightypirates.megazine.plugins.bookmarks | ||
| Box
| de.mightypirates.asul.components | A simple box. | |
| Button
| de.mightypirates.asul.components | A basic button. | |
| CachingLoader
| de.mightypirates.utils.loading |
Used by the FileSystemBundle to load images and SWFs. |
|
| ChapterEvent
| de.mightypirates.megazine.events |
This event is dispatched by the MegaZine class. |
|
| Console
| de.mightypirates.megazine.plugins.console | This plugin provides a console which can be used to display log messages and offers some basic commands. | |
| Console
| de.mightypirates.utils | Simple console class allowing for output by either simply appending text, or appending text and adding a newline after it. | |
| Constants
| de.mightypirates.megazine.interfaces |
This class just holds some constants used in the MegaZine and
Page classes, to make them available when using the interfaces
only. |
|
| CrossdomainLoader
| de.mightypirates.utils.loading | Utility class for loading a crossdomain.xml policy file from the server with a given URL. | |
| Cursor
| de.mightypirates.asul | Handles cursor display (allows for different cursor images in a centralized fashion). | |
| Definition
| de.mightypirates.utils |
Return type for the parseDefinitions() function StringUtils. |
|
| Dependency
| de.mightypirates.megazine.plugins | This class is used to represent dependencies between plugins. | |
| DragAreaEvent
| de.mightypirates.megazine.events |
This class is used by the DragHandler and the
MegaZine classes to propagate the event that the cursor has
entered or left the draggable region. |
|
| Dummy
| de.mightypirates.megazine.plugins.dummy | This plugin doesn't do anything at all. | |
| ElementIds
| de.mightypirates.megazine.plugins.elementids | Allows to access page elements using names set in the book definition. | |
| EmbeddedBundle
| de.mightypirates.utils.loading | Instances of this resource bundle implementation may be used to make embedded data available in a transparent fashion. | |
| FileSystemBundle
| de.mightypirates.utils.loading | A resource bundle using the actual file system to load resources. | |
| FlipStateChangeEvent
| de.mightypirates.megazine.events |
This class is used by the MegaZine class to propagate state
changes of its flip state. |
|
| FLVPlaybackClean
| de.mightypirates.video | This class provides a dispose() method which performs all necessary steps to make the FLVPlayback component garbage collection friendly. | |
| FPS
| de.mightypirates.utils | For easy frames per second measuring | |
| Gallery
| de.mightypirates.megazine.plugins.gallery | This adds the gallery functionality to the book, i.e. | |
| GalleryEvent
| de.mightypirates.megazine.plugins.gallery |
Event dispatched by the Gallery plugin when the currently
displayed element changes. |
|
| Gestures
| de.mightypirates.megazine.plugins.gestures | This plugin adds listeners to gesture events to add some gesture functionality to the engine. | |
| Gif
| de.mightypirates.megazine.elements | A loader for animated GIFs. | |
| GoogleAnalytics
| de.mightypirates.megazine.plugins.googleanalytics | This plugin adds functionality for tracking links using Google Analytics. | |
| GoogleAnalyticsJS
| de.mightypirates.megazine.plugins.googleanalyticsjs | This plugin adds functionality for tracking links using Google Analytics. | |
| Help
| de.mightypirates.megazine.plugins.help | adds a help window to display usage information regarding the engine. | |
| HorizontalFlowLayout
| de.mightypirates.asul.layouts | A simple horizontal flow layout. | |
| IAnchors
| de.mightypirates.megazine.plugins.anchors |
Interface for the Anchors plugin. |
|
| IAsulFactory
| de.mightypirates.asul.interfaces |
Interface for the AsulFactory class. |
|
| IAsulObject
| de.mightypirates.asul.interfaces | Interface for all ASUL objects. | |
| IBookmarks
| de.mightypirates.megazine.plugins.bookmarks |
Interface to the Bookmarks class (bookmarks plugin). |
|
| IButton
| de.mightypirates.asul.interfaces |
Interface for the Button class. |
|
| IChapter
| de.mightypirates.megazine.interfaces | Interface for the chapter class, representing chapters in the book. | |
| IDisposable
| de.mightypirates.utils.interfaces | Objects implementing this interface can be safely cleaned up for garbage collection. | |
| IElement
| de.mightypirates.megazine.interfaces |
Interface for all page elements, primarily the AbstractElement
class. |
|
| IElementIds
| de.mightypirates.megazine.plugins.elementids |
Interface for the ElementIds plugin. |
|
| IElementProxy
| de.mightypirates.megazine.interfaces | Interface for the element proxy class. | |
| IExternalInterfaceEnabled
| de.mightypirates.megazine.plugins.javascript |
This interface must be implemented by plugins that wish to use the
ExternalInterface via the JavaScript plugin. |
|
| IGallery
| de.mightypirates.megazine.plugins.gallery |
Interface to the Gallery plugin. |
|
| IGoogleAnalytics
| de.mightypirates.megazine.plugins.googleanalytics |
Interface for the GoogleAnalytics class. |
|
| IGoogleAnalyticsJS
| de.mightypirates.megazine.plugins.googleanalyticsjs |
Interface for the GoogleAnalyticsJS class. |
|
| IImg
| de.mightypirates.megazine.interfaces |
Interface for the Img class (the <img> element). |
|
| IIndex
| de.mightypirates.megazine.plugins.index |
Interface for the Index plugin. |
|
| ILayout
| de.mightypirates.asul.interfaces | Interface for base class for layouts. | |
| ILinks
| de.mightypirates.megazine.plugins.links |
Interface for the Links plugin. |
|
| ILocalizer
| de.mightypirates.utils.interfaces |
Interface for the Localizer class. |
|
| IMegaZine
| de.mightypirates.megazine.interfaces |
Interface to the MegaZine class. |
|
| Img
| de.mightypirates.megazine.elements |
The Img element provides a loader for images and flash
movies. |
|
| INavigationBar
| de.mightypirates.megazine.plugins.navigationbar |
Interface for the NavigationBar plugin. |
|
| Index
| de.mightypirates.megazine.plugins.index | ||
| IOverlays
| de.mightypirates.megazine.plugins.overlays |
Interface for the Overlays plugin. |
|
| IPage
| de.mightypirates.megazine.interfaces | Interface for the Page class, to be used in elements. | |
| IPageSide
| de.mightypirates.megazine.interfaces |
Interface for the PageSide class. |
|
| IPlugin
| de.mightypirates.megazine.interfaces | This interface describes functionality that has to be provided by plugins to be successfully loaded and registered with the main engine. | |
| IPluginManager
| de.mightypirates.megazine.interfaces |
Interface to the PluginManager class. |
|
| IPrint
| de.mightypirates.megazine.plugins.print |
Interface to the Print plugin. |
|
| IProgressBar
| de.mightypirates.asul.interfaces |
Interface for the ProgressBar class. |
|
| IResourceBundle
| de.mightypirates.utils.interfaces | Interface common to all resource bundles. | |
| IResourceLoader
| de.mightypirates.utils.interfaces | Interface to a resource loader implementation. | |
| IResourceProvider
| de.mightypirates.utils.interfaces |
Interface to the ResourceProvider class. |
|
| IScrollBar
| de.mightypirates.asul.interfaces |
Interface for the ScrollBar class. |
|
| IScrollPane
| de.mightypirates.asul.interfaces |
Interface for the ScrollPane component. |
|
| IScrollPaneControl
| de.mightypirates.asul.interfaces | ||
| ISearch
| de.mightypirates.megazine.plugins.search |
Interface for the Search class. |
|
| ISettings
| de.mightypirates.utils.interfaces |
Interface for the Settings class. |
|
| ISidebar
| de.mightypirates.megazine.plugins.sidebar |
Interface for the Sidebar plugin. |
|
| ISlideshow
| de.mightypirates.megazine.plugins.slideshow |
Interface for the Slideshow plugin. |
|
| IStyleAdapter
| de.mightypirates.asul.style | Interface for style adapters. | |
| IStyleSheet
| de.mightypirates.asul.style |
Interface for the StyleSheet class. |
|
| IText
| de.mightypirates.asul.interfaces |
Interface for the Text class. |
|
| IToggleButton
| de.mightypirates.asul.interfaces |
Interface for the ToggleButton class. |
|
| ITooltip
| de.mightypirates.asul.interfaces |
Interface to the Tooltip class. |
|
| ITween
| de.mightypirates.tween | Interface for tweening classes. | |
| ITxt
| de.mightypirates.megazine.interfaces |
Interface for the Txt class (the <txt> element). |
|
| IVid
| de.mightypirates.megazine.interfaces |
Interface for the Vid class (the <vid> element). |
|
| JavaScript
| de.mightypirates.megazine.plugins.javascript | This plugin is used to allow JavaScript interaction with the engine and its plugins. | |
| KeyBoardNavigation
| de.mightypirates.megazine.plugins.keyboardnavigation | This plugin enables the user to use his keyboard to navigate through the book. | |
| KeyState
| de.mightypirates.utils | Utility class to check state for single keys, not triggered through a KeyboardEvent. | |
| LECUtil
| de.mightypirates.utils.events | Default auto removal group for destroyable (IDestroyable) using an event controller (LEC). | |
| LinkedList
| de.mightypirates.utils | A linked list into which new objects can be pushed or unshifted and current ones can be popped or shifted. | |
| Links
| de.mightypirates.megazine.plugins.links | This plugin allows users to put links behind page elements, and allows the definition of handlers for different protocols. | |
| LoaderExt
| de.mightypirates.utils.loading |
This class extends the normal Loader class, adding some more
functionality. |
|
| LoadStateChangeEvent
| de.mightypirates.megazine.events |
This class is used by the MegaZine class to propagate state
changes of its loading state. |
|
| Localizer
| de.mightypirates.utils | Used for localization purposes. | |
| LocalizerEvent
| de.mightypirates.utils.events | Event fired by the Localizer class when the language is changed or a new language is added. | |
| Logger
| de.mightypirates.utils | May be used for centralized logging when trace is not an option (not debugging). | |
| LoggerEvent
| de.mightypirates.utils.events | Event used to propagate messages from the Logger class to listeners | |
| Main
| de.mightypirates.megazine | Main class for building the containing swf... | |
| MainFat
| de.mightypirates.megazine | Main class for building the containing swf... | |
| MegaZine
| de.mightypirates.megazine.flex | This is a small wrapper class for easier integration of MegaZine3 book instances into Flex applications. | |
| MegaZine
| de.mightypirates.megazine | Represents a book with all it's pages and settings and so on. | |
| MouseState
| de.mightypirates.utils |
Similar to the KeyState class, this class is used to track the
state of the mouse, especially whether the cursor is currently over the stage
or not. |
|
| MuteEvent
| de.mightypirates.megazine.events |
Used by the MegaZine class to propagate changes in the muting
state, i.e. |
|
| Nav
| de.mightypirates.megazine.elements | The navigation element is meant to be used to create table of contents in an easy to use fashion. | |
| NavigationBar
| de.mightypirates.megazine.plugins.navigationbar | This plugin adds a navigation bar to the book, allowing quick navigation between pages and enabling other options. | |
| NumberExpression
| de.mightypirates.utils | This class can be used to generate an operation tree from a term writtin in infix notation. | |
| NumericPropertyTween
| de.mightypirates.tween | Tween for tweening general numeric properties of objects. | |
| Options
| de.mightypirates.megazine.plugins.options | This plugin allows the user to change some basic settings by displaying a small dialog window. | |
| Overlays
| de.mightypirates.megazine.plugins.overlays | Adds the possibility to add overlays to elements (e.g. | |
| PageChangeEvent
| de.mightypirates.megazine.events | This class is used to propagate page changes in the book. | |
| PageEvent
| de.mightypirates.megazine.events |
This event is dispatched by the MegaZine class. |
|
| Password
| de.mightypirates.megazine.plugins.password | Adds a password form where users have to enter a password before seeing the book. | |
| PdfLinks
| de.mightypirates.megazine.plugins.pdflinks |
This plugin listens to TextEvents fired by loaded SWFs. |
|
| PluginData
| de.mightypirates.megazine.plugins | A data structure used to store data for plugins, which is used when constructing a plugin. | |
| PluginManager
| de.mightypirates.megazine.plugins |
The PluginManager class is used by the MegaZine 3 engine to
load an handle plugins. |
|
| PositionTween
| de.mightypirates.tween |
Class for tweening the position of a DisplayObject, i.e. |
|
| Print
| de.mightypirates.megazine.plugins.print | This plugin adds print functionality to the engine. | |
| PrintPdf
| de.mightypirates.megazine.plugins.printpdf |
This plugin does pretty much the same as the Print plugin,
except that it puts the results in a PDF file which can then be saved by the
user, instead of printing the pages. |
|
| ProgressBar
| de.mightypirates.asul.components | A simple progressbar. | |
| ResourceBundle
| de.mightypirates.utils.loading | ||
| ResourceErrorEvent
| de.mightypirates.utils.events |
Error event used when a ResourceLoader fails. |
|
| ResourceLoader
| de.mightypirates.utils.loading | Convenience base class for resource loaders. | |
| ResourceProvider
| de.mightypirates.utils.loading | This class can be used for centralized asset management, loading data from whatever resource bundles are given. | |
| ResourceType
| de.mightypirates.utils.loading |
A list of possible resource types that be me queried from the
ResourceProvider class. |
|
| ScaleTween
| de.mightypirates.tween |
Class for tweening the scale of a DisplayObject, i.e. |
|
| ScrollBar
| de.mightypirates.asul.components | A simple scroll bar, with a value between 0 and 1. | |
| ScrollPane
| de.mightypirates.asul.components | ||
| ScrollPaneControl
| de.mightypirates.asul.components | This utility component represents a small visible representation of a scroll pane, showing a thumbnail with an overlaying rectangle indicating the currently visible area of the scrollpane. | |
| ScrollPaneMouseModeChangeEvent
| de.mightypirates.asul.events |
Fired by the ScrollPane class whenever its mousemode is changed
(i.e. |
|
| Search
| de.mightypirates.megazine.plugins.search | This plugin provides search functionality for the engine. | |
| SearchEvent
| de.mightypirates.megazine.plugins.search |
Event class for the Search plugin. |
|
| Settings
| de.mightypirates.utils | General class for managing settings, based on string names. | |
| Sidebar
| de.mightypirates.megazine.plugins.sidebar | This plugin adds a sidebar to the book which can contain ASUL elements. | |
| SizeTween
| de.mightypirates.tween |
Class for tweening the size of a DisplayObject, i.e. |
|
| Slideshow
| de.mightypirates.megazine.plugins.slideshow | This plugin provides a slideshow functionality to the engine, i.e. | |
| SlideshowEvent
| de.mightypirates.megazine.plugins.slideshow |
Event used by the Slideshow plugin to signal starting or
stopping of the slideshow. |
|
| Snd
| de.mightypirates.megazine.elements |
The Snd class is used to load sounds into pages. |
|
| StateChangeEvent
| de.mightypirates.utils.events | This class is used whenever an object changes it's state. | |
| StyleSheet
| de.mightypirates.asul.style | This class provides management and evaluation of styles. | |
| SwfAddress
| de.mightypirates.megazine.plugins.swfaddress | This plugin introduces SWFAddress functionality to the engine, i.e. | |
| Text
| de.mightypirates.asul.components | A text box, either to be used for input or just as a label. | |
| TileBitmap
| de.mightypirates.utils | Utility Bitmap wrapper that takes another bitmap and renders it in either tiled or normal (stretched) mode). | |
| Timeout
| de.mightypirates.utils |
This is basically a setTimeout implementation, using an object
orientated approach and a Timer object. |
|
| TimeoutLoader
| de.mightypirates.utils.loading | Base class for loaders of some bundles. | |
| Titles
| de.mightypirates.megazine.plugins.titles | Allows defining titles (tool tips) for page elements. | |
| ToggleButton
| de.mightypirates.asul.components |
A basic toggle button, based on two Buttons. |
|
| ToggleButtonEvent
| de.mightypirates.asul.events |
Event fired by the ToggleButton class when its toggle state
changes. |
|
| ToolTip
| de.mightypirates.utils | The ToolTop class allows for a simple creation of tooltips for any object supporting the MouseEvent.MOUSE_MOVE, MouseEvent.MOUSE_OVER and MouseEvent.MOUSE_OUT events. | |
| TooltipFactory
| de.mightypirates.asul | Allows the creation of tooltips, with custom settings based on a reference object. | |
| TUIO
| de.mightypirates.megazine.plugins.tuio | The TUIO plugin automatically sets up a TuioManager to propagate received TUIO events as native touch / gesture events. | |
| TweenFunctions
| de.mightypirates.tween | This class defines some tween functions. | |
| Txt
| de.mightypirates.megazine.elements | The text element can be used to display blocks of text. | |
| URLLoaderExt
| de.mightypirates.utils.loading |
This class extends the normal Loader class, adding some more
functionality. |
|
| Vector2D
| de.mightypirates.utils | Vector class for two dimensional vectors. | |
| VerticalFlowLayout
| de.mightypirates.asul.layouts | A simple vertical flow layout. | |
| Vid
| de.mightypirates.megazine.elements | The video element can be used to load and play videos. | |
| VisibilityEvent
| de.mightypirates.utils.events | This event is dispatched when a display object changes its visibility. | |
| WeakRef
| de.mightypirates.utils | Utility class for using weak references. | |
| Window
| de.mightypirates.asul.components | A window which can have an optional dragging bar and a close button. | |
| ZipBundle
| de.mightypirates.utils.loading | This bundle provides data inside a ZIP file. | |
| Zoom
| de.mightypirates.megazine.plugins.zoom | This plugin adds a small GUI block which allows control and gives visible feedback regarding book zoom. | |
| ZoomChangeEvent
| de.mightypirates.megazine.events |
This event is used by the MegaZine class to signal scaling
changes of the page container (thus the display size of the pages). |