Package | at.display |
Class | public dynamic class Slide |
Inheritance | Slide ![]() |
Slide
extends MovieClip
to offer some unique functionality and ease of use
when it comes to memory management and quick production of slides.
Property | Defined by | ||
---|---|---|---|
debugMode : Boolean = false
Outputs useful information for debugging this component for developers when
true . | Slide | ||
eveAudio : Boolean [read-only]
Holds the
eveAudio boolean value that can be read to determine
if the global audio is set to on (true) or off (false). | Slide | ||
eventList : Array
Holder for all of the events created for the slide to function.
| Slide |
Method | Defined by | ||
---|---|---|---|
Slide()
Constructor.
| Slide | ||
destroy():void
Called before the
Slide is unloaded. | Slide | ||
eveAudioHandler(msg:String):void
Method for processing the current audio setting based on the value received
from
incomingConn . | Slide | ||
navigateToOffshootById(id:int, ignoreValidation:Boolean = false, displayMultipleSlideMessage:Boolean = true):void
Allows the content slide make a request to an offshoot via the
dbid of the slide
that you would like to offshoot to. | Slide | ||
navigateToSlideById(id:int, ignoreValidation:Boolean = false):void
Allows the content slide to navigate to a slide instance in your Call by
dbid . | Slide |
Method | Defined by | ||
---|---|---|---|
broadcastEvent(event:Event):void
Dispatches requests from the
Slide to eVE to handle interaction. | Slide | ||
getEvent(target:Object, type:String):Event
Retrieves a specific event that has been registered with
registerEvent . | Slide | ||
registerEvent(obj:EventDispatcher, listenerType:String, handler:Function, event:Event = null):void
registerEvent is the best way to add events to the Slide and
MovieClips on the slide. | Slide | ||
slideReadyHandler(e:Event):void
Handler for the slide to execute update audio when it is first on screen.
| Slide | ||
updateAudio(e:Event = null):void
This function dispatches the appropriate eVE Global Audio ON/OFF events.
| Slide |
debugMode | property |
public var debugMode:Boolean = false
Outputs useful information for debugging this component for developers when true
.
The output is typically in the form of trace statements and Alert
s.
The default value is false
.
eveAudio | property |
eveAudio:Boolean
[read-only]
Holds the eveAudio
boolean value that can be read to determine
if the global audio is set to on (true) or off (false).
public function get eveAudio():Boolean
eventList | property |
public var eventList:Array
Holder for all of the events created for the slide to function. This allows for easy removal of slides before unloading, for memory managment purposes.
The default value is []
.
Slide | () | constructor |
public function Slide()
Constructor.
broadcastEvent | () | method |
protected function broadcastEvent(event:Event):void
Dispatches requests from the Slide
to eVE to handle interaction.
event:Event |
See also
destroy | () | method |
public function destroy():void
Called before the Slide
is unloaded.
This ensures that all events registered with the
registerEvent
method are removed so the
slide can be garbage collected.
Overridding this method will ensure any cleanup or audio/video
that needs to be stopped can be done before the Slide
is unloaded.
See also
eveAudioHandler | () | method |
public function eveAudioHandler(msg:String):void
Method for processing the current audio setting based on the value received
from incomingConn
.
The possible values are Sound On
or Sound Off
.
msg:String — The passed message
|
getEvent | () | method |
protected function getEvent(target:Object, type:String):Event
Retrieves a specific event that has been registered with registerEvent
.
target:Object |
|
type:String |
Event |
See also
navigateToOffshootById | () | method |
public function navigateToOffshootById(id:int, ignoreValidation:Boolean = false, displayMultipleSlideMessage:Boolean = true):void
Allows the content slide make a request to an offshoot via the dbid
of the slide
that you would like to offshoot to.
id:int — The database id of the slide you would like to offshoot to.
|
|
ignoreValidation:Boolean (default = false ) — If true , eVE navigation validation will be ignored and the
requested slide id will be displayed within the eVE application
|
|
displayMultipleSlideMessage:Boolean (default = true ) — If true will display a message warning the user that they will see the first slide in the provided group of slides (if slideList contains more than one slide).
|
navigateToSlideById | () | method |
public function navigateToSlideById(id:int, ignoreValidation:Boolean = false):void
Allows the content slide to navigate to a slide instance in your Call by dbid
.
id:int — The database id of the slide you would like to offshoot to.
|
|
ignoreValidation:Boolean (default = false ) — Optioinal. If true , eVE Navigation validation will be ignored and the
requested slide id will be displayed within the eVE Application.
|
registerEvent | () | method |
protected function registerEvent(obj:EventDispatcher, listenerType:String, handler:Function, event:Event = null):void
registerEvent
is the best way to add events to the Slide
and
MovieClips on the slide.
Using this method allows for collection and removal of the events before unloading of the swf. If the events are not removed, the class could waste system resources of the application.
To have a slide call a function defined in the swf when button_mc
is clicked on:
import flash.events.MouseEvent;
import flash.display.MovieClip;
function buttonHandler(e:MouseEvent):void {
trace("button click");
}
registerEvent(button_mc, MouseEvent.CLICK, buttonHandler);
To have a chart_mc
dispatch an OverlayEvent
to
pop up a larger version of the chart when it is clicked, you would enter
code similar to:
import at.events.OverlayEvent;
var oe:OverlayEvent = new OverlayEvent(OverlayEvent.OVERLAY_REQUEST,
"chart_big.swf");
registerEvent(chart_mc, MouseEvent.CLICK, broadcastEvent, oe);
obj:EventDispatcher — The EventDispatcher the listenerType is to be added to.
|
|
listenerType:String — The type of listener. e.g. a MovieClip click would need a MouseEvent.CLICK .
|
|
handler:Function — The name of the function to handle the event. If it is broadcastEvent it will dispatch
the event parameter.
|
|
event:Event (default = null ) — A new event to be dispatched. This is optional. Only used if the handler is
broadcastEvent .
|
slideReadyHandler | () | method |
protected function slideReadyHandler(e:Event):void
Handler for the slide to execute update audio when it is first on screen.
Parameterse:Event |
updateAudio | () | method |
protected function updateAudio(e:Event = null):void
This function dispatches the appropriate eVE Global Audio ON/OFF events.
Parameterse:Event (default = null )
|
See also