Packageat.display
Classpublic dynamic class Slide
InheritanceSlide Inheritance flash.display.MovieClip

Defines common methods and properties for slides used within eVE. Slide extends MovieClip to offer some unique functionality and ease of use when it comes to memory management and quick production of slides.


Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined 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
Protected Methods
 MethodDefined 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
Property detail
debugModeproperty
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 Alerts.

The default value is false.

eveAudioproperty 
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).

Implementation
    public function get eveAudio():Boolean
eventListproperty 
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 [].

Constructor detail
Slide()constructor
public function Slide()

Constructor.

Method detail
broadcastEvent()method
protected function broadcastEvent(event:Event):void

Dispatches requests from the Slide to eVE to handle interaction.

Parameters
event:Event

See also

at.events.SlideEvent
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

registerEvent()
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.

Parameters
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.

Parameters
target:Object
 
type:String

Returns
Event

See also

registerEvent()
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.

Parameters
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.

Parameters
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);

Parameters
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.

Parameters
e:Event
updateAudio()method 
protected function updateAudio(e:Event = null):void

This function dispatches the appropriate eVE Global Audio ON/OFF events.

Parameters
e:Event (default = null)

See also

at.events.EveEvents



Copyright 2009 AbelsonTaylor