| Package | widgetfactory.communication |
| Class | public class BaseSlideRoom |
| Inheritance | BaseSlideRoom  BaseRoom flash.events.EventDispatcher |
| Implements | ISlideRoom |
BaseSlideRoom works by tricking the WidgetManager into thinking that it is a widget
set to appear from the start to the end of the slide. The enterSlide() and exitSlide()
Template Methods are the equivalent of the enterRuntime() and exitRuntime()
Template Methods in the StaticWidget class. These template methods allow you to
load and unload the room depending on whether the Captivate Movie is currently on the appropriate slide.
To create a slide room, indicate that you wish to use the BaseSlideRoom class
(or a class that extends it) when joining the room with the WidgetRooms class.
WidgetRooms.joinRoom("SlideRoom", widgetSlide, memberObject, "Barry", BaseSlideRoom);
For more information on how widget rooms work, see the BaseRoom class.
BaseSlideRoom comes with a matching BaseSlideRoomProxy class for strong typing
between widget instances.
See also
| Property | Defined By | ||
|---|---|---|---|
 | isRoom : Boolean [read-only]
A property that WidgetRooms looks for when it is trying to locate a room object. | BaseRoom | |
| location : MovieClip [read-only]
The location where the room has been created. | BaseRoom | |
| name : String [read-only]
The name given to the room when it was created. | BaseRoom | |
| numMembers : int [read-only]
The number of members that are registered with the room. | BaseRoom | |
| slideNumber : int [read-only]
The number of the slide that this room is setup on. | BaseSlideRoom | ||
| Property | Defined By | ||
|---|---|---|---|
| allMembers : Array [read-only]
A list of all the members that have joined the room. | BaseRoom | |
| captivateMainTimeline : MovieClip
A reference to the Captivate Main Timeline. | BaseSlideRoom | ||
| delayEnterSlideOnFirstSlide : Boolean
Indicates whether the call to the enterSlide() method should be delayed by one frame if the room is on the first slide of the movie. | BaseSlideRoom | ||
| onNoMembersDeleteRoom : Boolean
Indicates whether this room should delete itself if all its members deregister. | BaseRoom | |
| Method | Defined By | ||
|---|---|---|---|
BaseSlideRoom(name:String, location:MovieClip)
Creates a new instance of the BaseSlideRoom class. | BaseSlideRoom | ||
| deregister(member:Object):void
Removes a member from the member list so that it can no longer be found with getMemberByName or getMembersByRole. | BaseRoom | |
| getMemberByName(memberName:String, role:String):Object
Returns the member object that matches the name and role that are passed in. | BaseRoom | |
| getMemberRole(member:Object):String
Takes the member object and finds what role it belongs it. | BaseRoom | |
| getMembersByRole(role:String):Array
Returns a list of all members that belong to a particular role. | BaseRoom | |
| register(member:Object, memberName:String, role:String):void
Registers a member with the room's member list. | BaseRoom | |
| Method | Defined By | ||
|---|---|---|---|
enterSlide():void
A Template Method which is called when the movie enters the slide that the room is attached to. | BaseSlideRoom | ||
exitSlide():void
A Template Method which is called when the movie exits the slide that the room is attached to. | BaseSlideRoom | ||
| captivateMainTimeline | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var captivateMainTimeline:MovieClipA reference to the Captivate Main Timeline.
See also
| delayEnterSlideOnFirstSlide | property |
delayEnterSlideOnFirstSlide:Boolean
Indicates whether the call to the enterSlide() method should be delayed by one frame if the room is on the first slide of the movie.
This allows time for all widgets to load and join the room (providing that they join the room in their
enterMovie() Template Method).
protected function get delayEnterSlideOnFirstSlide():Boolean protected function set delayEnterSlideOnFirstSlide(value:Boolean):voidSee also
| slideNumber | property |
slideNumber:int [read-only] The number of the slide that this room is setup on. (1 based)
public function get slideNumber():int| BaseSlideRoom | () | Constructor |
public function BaseSlideRoom(name:String, location:MovieClip)
Creates a new instance of the BaseSlideRoom class.
name:String — The name of the room.
| |
location:MovieClip — The place where the room is set up.
|
| enterSlide | () | method |
protected function enterSlide():voidA Template Method which is called when the movie enters the slide that the room is attached to.
| exitSlide | () | method |
protected function exitSlide():voidA Template Method which is called when the movie exits the slide that the room is attached to.