Packageat.modules
Classpublic class PresentationModule
InheritancePresentationModule Inheritance mx.containers.Canvas
ImplementsIHistoryManagerClient, INavigationManager, IPresentationModule

The PresentationModule uses many of eVE's features and integrates them into a Module to easily display and navigate content, typically Slide content. PreCallModule has items that are eligible for eVE Data Collections. You can collect data about the users usage of you eVE Application.

Default MXML PropertydataProvider

See also

at.datacollection.DataCollectionModule
at.display.Slide


Public Properties
 PropertyDefined by
  alertIcon : Class
The icon for Slide synchronization warnings.
PresentationModule
  allowOffShootNavigation : Boolean
Indicates if a jump to other slides will be permitted (i.e.
PresentationModule
  allowPathDeviation : Boolean
[read-only] Specifies whether deviating from the current slide in this call breaks the mustFollow business rule of the current content slide.
PresentationModule
  autoExitPresentationUponRemovedFromStage : Boolean = true
If set to true: when the PresentationModule is removed from the stage the exitPresentation method is automatically called (executed after the PresentationModule's Event.REMOVED_FROM_STAGE events fires).
PresentationModule
  brandID : int
Returns the current brand ID
PresentationModule
  brandTitle : String
[read-only] The title of the current brand.
PresentationModule
  callBookmarks : XMLList
[read-only] Returns the bookmarks associated with the current call.
PresentationModule
  callID : int
Returns the current call ID
PresentationModule
  callTitle : String
[read-only] The title of the current call.
PresentationModule
  callTitleAbbreviation : String
[read-only] The abbreviated title of the current call.
PresentationModule
  crumbManager : ApplicationCrumbManager
Reference to the eVE ApplicationCrumbManager/
PresentationModule
  currentIndex : int
[read-only] Implementation of the currentIndex for the INavigationManager interface.
PresentationModule
  dataProvider : XMLList
Returns the dataProvider for the Presentation Module which is normally set by setting the callID or indicationID
PresentationModule
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
PresentationModule
  historyManager : ApplicationHistoryManager
Reference to the eVE ApplicationHistoryManager.
PresentationModule
  indicationID : int
Returns the current indication ID
PresentationModule
  indicationTitle : String
[read-only] The title of the current indication.
PresentationModule
  loadedData : XMLList
[read-only] Returns the data loaded into the slideManager via the loadData method.
PresentationModule
  navigateHomeOnLoad : Boolean = true
When set to true the initial viewing of the PresentationModule will navigate to the SlideManager's specified home slide.
PresentationModule
  navLockable : Boolean
Indications wheather locking of navigation after a navigation change occurs for a specified duration is allowed.
PresentationModule
  overlayWindow : OverlayWindow
The window used to pop up the default SiteMapModule and the QuickViewModule.
PresentationModule
  quickViewModule : QuickViewModule
The default QuickViewModule.
PresentationModule
  slideManager : MultiPathSlideManager
Instance of the SlideManager that controls the navigation of the slides in the presentation.
PresentationModule
  useDefaultCrumbManagement : Boolean = true
Tells the PresentationModule to use its handle changes for a BreadcrumbDisplay.
PresentationModule
Protected Properties
 PropertyDefined by
  callSyncPropertyChanges : DBUpdateChanges
The data that has changed in the database after a remote database synchronization.
PresentationModule
Public Methods
 MethodDefined by
  
Constructor.
PresentationModule
  
exitPresentation(dispatchEvent:Boolean = true):void
Informs the Presentation Module that it is being exited, and dispatches an Event.EXITING event.
PresentationModule
  
getCurrentNode(byReference:Boolean = false):XML
Returns a copy of the MultiPathSlideManager's native dataProvider's (ignores offshoot above it) current node or a reference if specified.
PresentationModule
  
getDefaultNode(byReference:Boolean = false):XML
Returns a copy of the default slide node from the MultiPathSlideManager.
PresentationModule
  
getExitingEvent():String
Returns the constant type for the presentationExiting event.
PresentationModule
  
getNextNode(stayInTeir:Boolean = false, byReference:Boolean = false):XML
Returns the node in the MultiPathSlideManager that would be navigated to if calling the gotoNext method.
PresentationModule
  
getNodeById(dbid:String, byReference:Boolean = false):XML
Searches the MultiPathSlideManager's dataProvider's (not offshoots) naviagation structure for the first node having the dbid specified
PresentationModule
  
getPreviousNode(stayInTeir:Boolean = false, byReference:Boolean = false):XML
Returns the previous node in the MultiPathSlideManager that would be navigated to if the gotoPrev method were to be called.
PresentationModule
  
getState(stateName:String = null):Object
Retrieves the the current state of PresentationModule.
PresentationModule
  
gotoNext(stayInTeir:Boolean = false, ignoreValidation:Boolean = false):Boolean
Navigates to the next slide in a call in the MultiPathSlideManager.
PresentationModule
  
gotoPrev(stayInTeir:Boolean = false, ignoreValidation:Boolean = false):Boolean
Navigates to the next slide in a call in the MultiPathSlideManager.
PresentationModule
  
loadBrand(brandID:int):void
Loads a brand based on the specified brand ID.
PresentationModule
  
loadCall(callID:int):Boolean
Retreives call data from the DataInterface and updates the SlideManager's dataprovider with the results.
PresentationModule
  
loadDefaultCall(indicationId:int):void
Attempts to load the default call for the indication.
PresentationModule
  
loadIndication(indicationID:int, autoLoadDefaultCall:Boolean = false):void
Loads all data associated with an indication.
PresentationModule
  
loadState(state:Object):void
Handles any request from the HistoryManager to restore a point in history into the PresentationModule.
PresentationModule
  
navigateHome(ignoreValidation:Boolean = false):Boolean
Makes a request to the MultiPathSlideManager to destroy all offshoots and navigates to the default slide node.
PresentationModule
  
navigateTo(slide_dbid:String, ignoreValidation:Boolean = false):Boolean
Destroys all offshoots on the PresentationModule's MultiPathSlideManager employing the flex lifecycle to navigates to the first slide node with a matching dbid attribute or parent node with a title attribute matching slide_dbid_or_section_Title String.
PresentationModule
  
navigateToBookmark(bookmarkSlides:XMLList):Boolean
Makes a request to the MultiPathSlideManager to navigate to the XMLList of content slides provided, independant of the current dataprovider.
PresentationModule
  
navigateToOffShoot(slideList:XMLList, ignoreValidation:Boolean = false, displayMultipleSlideMessage:Boolean = true):Boolean
Makes a request to the MultiPathSlideManager to navigate to the XMLList of content slides provided, independant of the current dataprovider.
PresentationModule
  
navigateToSlideIndex(index:int, ignoreValidation:Boolean = false):Boolean
Makes a request to the MultiPathSlideManager to destroys all offshoots and employ the flex lifecycle to navigate to the slide node at the specified index within MultiPathSlideManager's native dataProvider.
PresentationModule
  
onQuickViewModuleItemClick(e:ItemClickEvent):void
Handles the click on a QuickViewModule item.
PresentationModule
  
onRemovedFromStage(e:Event):void
Event that fires when the a state containing the PresentationModule is left.
PresentationModule
  
Loads the MuliPathSlideManager's dataprovider instantly, before (instead of using) the Flex lifecyle's commit properties.
PresentationModule
  
refresh():void
Forces a refresh of data associated with the current brand, indication, and call by calling the DataInterface and updadating dependant dataproviders.
PresentationModule
  
reset():void
Resets the PresentationModule's MultiPathSlideManager to its initial state.
PresentationModule
  
saveState():Object
Calls the getState method.
PresentationModule
  
Pops up the QuickViewModule in an OverlayWindow with the current callID.
PresentationModule
Protected Methods
 MethodDefined by
  
PresentationModule
  
PresentationModule
  
onCallResetAlertClosed(e:CloseEvent):void
PresentationModule
  
Executed on a NAVIGATION_CHANGED event.
PresentationModule
  
onNavigationData(e:DataEvent):void
PresentationModule
  
PresentationModule
  
onNavigationLocked(e:DataEvent):void
PresentationModule
  
onSlidesRemovedAlertClosed(e:CloseEvent):void
PresentationModule
  
PresentationModule
Events
 EventSummaryDefined by
   Dispatched when a the brandID property has changed.PresentationModule
   Dispatched when a the callID property has changed.PresentationModule
   Dispatched after the SlideManager has loaded it's data, before defaults are set or any default navigation is executed.PresentationModule
   Dispatched after loadCall or loadDefaultCall is called and the selected or default call happens to have no slides in it.PresentationModule
   Dispatched when a the indicationID property has changed.PresentationModule
   Dispatched after the SlideManager has changed to the current slide in it's slide list.PresentationModule
   Dispatched after the SlideManager has determined the navigation request is valid, but before the change is made.PresentationModule
   Dispatched after the SlideManager has loaded it's data, before defaults are set or any default navigation is executed.PresentationModule
   Dispatched when a request to change content slides has been made to the SlideManager but the navigation has not been unlocked.PresentationModule
   Dispatched when a request to change content slides has been made to the SlideManager but before the request has been validated.PresentationModule
Styles
 StyleDescriptionDefined by
  
quickViewModuleStyleName
Type: String
The styleName for the QuickViewModule. The default value is "quickViewModuleStyle".
PresentationModule
  
quickViewOverlayWindowStyleName
Type: String
The styleName for the QuickViewModule's overlayWindow, which extends TitleWindow. The default value is "quickViewOverlayWindowStyle".
PresentationModule
  
quickViewOverlayWindowTitleStyleName
Type: String
The styleName for the QuickViewModule's overlayWindow's titleStyleName property. The default value is "quickViewOverlayTitleWindowStyle".
PresentationModule
Public Constants
 ConstantDefined by
  EMPTY_CALL_ERROR : String = "emptyCallError"
[static] Constant for the event indicating that a the call being changed to has no content slides in the call.
PresentationModule
  EXITING : String = "exiting"
[static] Constant for the event indicating the presentation module is closing
PresentationModule
Property detail
alertIconproperty
public var alertIcon:Class

The icon for Slide synchronization warnings.

The default value is at.display.EveDefaultImagery.CAUTION_ICON.

See also

allowOffShootNavigationproperty 
allowOffShootNavigation:Boolean  [read-write]

Indicates if a jump to other slides will be permitted (i.e. Via SiteMapModule)

This property can be used as the source for data binding.

Implementation
    public function get allowOffShootNavigation():Boolean
    public function set allowOffShootNavigation(value:Boolean):void
allowPathDeviationproperty 
allowPathDeviation:Boolean  [read-only]

Specifies whether deviating from the current slide in this call breaks the mustFollow business rule of the current content slide.

This property can be used as the source for data binding.

Implementation
    public function get allowPathDeviation():Boolean
autoExitPresentationUponRemovedFromStageproperty 
public var autoExitPresentationUponRemovedFromStage:Boolean = true

If set to true: when the PresentationModule is removed from the stage the exitPresentation method is automatically called (executed after the PresentationModule's Event.REMOVED_FROM_STAGE events fires). This unloads the call, indication, brand, and associated dataproviders and dispatches an Event of type Event.EXITING. NOTE: Flex dispatches the Event.REMOVED_FROM_STAGE event type twice upon loading the PresentationModule if any part of a DisplayObject in the same state is outside of the visible the application area. (i.e. a Button has an x value of -2). If DisplayObjects are in the same State and partially/entirely off the Application's visible stage dimensions, if may be desireable to leave this the default value of false, and execute the exitPresentation method manually, or wait to turn it on until the PresentationModule has finished loading.

The default value is true.

brandIDproperty 
brandID:int  [read-write]

Returns the current brand ID

This property can be used as the source for data binding.

Implementation
    public function get brandID():int
    public function set brandID(value:int):void
brandTitleproperty 
brandTitle:String  [read-only]

The title of the current brand.

The default value is "".

This property can be used as the source for data binding.

Implementation
    public function get brandTitle():String
callBookmarksproperty 
callBookmarks:XMLList  [read-only]

Returns the bookmarks associated with the current call.

This property can be used as the source for data binding.

Implementation
    public function get callBookmarks():XMLList
callIDproperty 
callID:int  [read-write]

Returns the current call ID

This property can be used as the source for data binding.

Implementation
    public function get callID():int
    public function set callID(value:int):void
callSyncPropertyChangesproperty 
callSyncPropertyChanges:DBUpdateChanges  [read-write]

The data that has changed in the database after a remote database synchronization.

Implementation
    protected function get callSyncPropertyChanges():DBUpdateChanges
    protected function set callSyncPropertyChanges(value:DBUpdateChanges):void

See also

at.data.DBUpdateChanges
callTitleproperty 
callTitle:String  [read-only]

The title of the current call.

The default value is "".

This property can be used as the source for data binding.

Implementation
    public function get callTitle():String
callTitleAbbreviationproperty 
callTitleAbbreviation:String  [read-only]

The abbreviated title of the current call.

The default value is "".

This property can be used as the source for data binding.

Implementation
    public function get callTitleAbbreviation():String
crumbManagerproperty 
public var crumbManager:ApplicationCrumbManager

Reference to the eVE ApplicationCrumbManager/

currentIndexproperty 
currentIndex:int  [read-only]

Implementation of the currentIndex for the INavigationManager interface.

The default value is -1.

Implementation
    public function get currentIndex():int
dataProviderproperty 
dataProvider:XMLList  [read-write]

Returns the dataProvider for the Presentation Module which is normally set by setting the callID or indicationID

Implementation
    public function get dataProvider():XMLList
    public function set dataProvider(value:XMLList):void
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.

historyManagerproperty 
public var historyManager:ApplicationHistoryManager

Reference to the eVE ApplicationHistoryManager.

indicationIDproperty 
indicationID:int  [read-write]

Returns the current indication ID

This property can be used as the source for data binding.

Implementation
    public function get indicationID():int
    public function set indicationID(value:int):void
indicationTitleproperty 
indicationTitle:String  [read-only]

The title of the current indication.

The default value is "".

This property can be used as the source for data binding.

Implementation
    public function get indicationTitle():String
loadedDataproperty 
loadedData:XMLList  [read-only]

Returns the data loaded into the slideManager via the loadData method.

Implementation
    public function get loadedData():XMLList
navigateHomeOnLoadproperty 
public var navigateHomeOnLoad:Boolean = true

When set to true the initial viewing of the PresentationModule will navigate to the SlideManager's specified home slide.

The default value is true.

navLockableproperty 
navLockable:Boolean  [read-write]

Indications wheather locking of navigation after a navigation change occurs for a specified duration is allowed.

Implementation
    public function get navLockable():Boolean
    public function set navLockable(value:Boolean):void

See also

overlayWindowproperty 
public var overlayWindow:OverlayWindow

The window used to pop up the default SiteMapModule and the QuickViewModule.

See also

quickViewModuleproperty 
public var quickViewModule:QuickViewModule

The default QuickViewModule.

See also

slideManagerproperty 
public var slideManager:MultiPathSlideManager

Instance of the SlideManager that controls the navigation of the slides in the presentation. It must load in and follow the XML data format outlined in the SlideManager class.

The default value is null.

This property can be used as the source for data binding.

See also

useDefaultCrumbManagementproperty 
public var useDefaultCrumbManagement:Boolean = true

Tells the PresentationModule to use its handle changes for a BreadcrumbDisplay.

The default value is true.

Constructor detail
PresentationModule()constructor
public function PresentationModule()

Constructor.

Method detail
dispatchEmptyCall()method
protected function dispatchEmptyCall():void
exitPresentation()method 
public function exitPresentation(dispatchEvent:Boolean = true):void

Informs the Presentation Module that it is being exited, and dispatches an Event.EXITING event. This does NOT unload any content, yet calling this method is necessary to get the most benefit out of Eve Application development. Example: In a button handler that leaves PresentationModule to go to PreCallModule, calling this method in the button handler allows Eve and other modules to know that the user is no longer in a call.

Parameters
dispatchEvent:Boolean (default = true)
getCurrentNode()method 
public function getCurrentNode(byReference:Boolean = false):XML

Returns a copy of the MultiPathSlideManager's native dataProvider's (ignores offshoot above it) current node or a reference if specified.

Parameters
byReference:Boolean (default = false) — If true, returns a reference of the return node, if false returns a copy of it.

Returns
XML — Copy of or reference to the current slide XML node.

See also

getDefaultNode()method 
public function getDefaultNode(byReference:Boolean = false):XML

Returns a copy of the default slide node from the MultiPathSlideManager.

Parameters
byReference:Boolean (default = false) — If true, returns a reference of the return node, if false returns a copy of it.

Returns
XML — Copy of or reference to the default slide XML node.

See also

getExitingEvent()method 
public function getExitingEvent():String

Returns the constant type for the presentationExiting event.

Returns
String — The String
getNextNode()method 
public function getNextNode(stayInTeir:Boolean = false, byReference:Boolean = false):XML

Returns the node in the MultiPathSlideManager that would be navigated to if calling the gotoNext method.

If in an offshoot: Returns the next node in the offshoot. If at the current node is last node in the current offshoot, returns the next offshoot's current position (before leaving it for the previous offshoot). If no other offshoot is above this offshoot and the current node is the last node in the offshoot, returns the underlying SlideManager's next node in it's native dataProvider.

Parameters
stayInTeir:Boolean (default = false) — if nodes are children of categories, specifies to return null if the node is the last in one of those categories, instead of returning the first node of the next category.
 
byReference:Boolean (default = false) — If true, returns a reference of the return node, if false returns a copy of it.

Returns
XMLXML of the current slide node.

See also

getNodeById()method 
public function getNodeById(dbid:String, byReference:Boolean = false):XML

Searches the MultiPathSlideManager's dataProvider's (not offshoots) naviagation structure for the first node having the dbid specified

Parameters
dbid:String — dbid attribute value of the node to return.

Note: If the same slide is in the list of slide nodes twice, for instance if wanting to summerize with a slide used earlier in the list, this method returns the first instance of the node in the list. When searching by reference, and if using the NavigateToNodeM/code> method remember that navigation would go to the first instance only. If wanting to navigate to the second instance of the same node, you must use the navigateToIndex method.

 
byReference:Boolean (default = false) — If true, returns a reference of the return node, if false returns a copy of it.

Returns
XML — Copy of or reference to the slide slide XML with the matching dbid attribute value.

See also

getPreviousNode()method 
public function getPreviousNode(stayInTeir:Boolean = false, byReference:Boolean = false):XML

Returns the previous node in the MultiPathSlideManager that would be navigated to if the gotoPrev method were to be called. If in an offshoot: Returns the previous node in the offshoot. If at the current node is first node in the offshoot, returns the previous offshoot's current position (before leaving it for the current offshoot). If no other offshoot is beneath this offshoot and the current node is the first node in the offshoot, returns the underlying SlideManager's previousNode in it's native dataProvider.

Parameters
stayInTeir:Boolean (default = false) — if nodes are children of categories, specifies to return null if in the node is the last in one of those categories, instead of returning the last node of the previous category.
 
byReference:Boolean (default = false) — If true, returns a reference of the return node, if false returns a copy of it.

Returns
XMLXML of the current slide node.

See also

getState()method 
public function getState(stateName:String = null):Object

Retrieves the the current state of PresentationModule. Primarily used internally by the HistoryManager although may be useful if wanting to return to a state. This can be overriden if desiring to save additional properties, add the properties to the object being returned after calling the super().

Parameters
stateName:String (default = null)

Returns
Object
gotoNext()method 
public function gotoNext(stayInTeir:Boolean = false, ignoreValidation:Boolean = false):Boolean

Navigates to the next slide in a call in the MultiPathSlideManager.

Parameters
stayInTeir:Boolean (default = false)
 
ignoreValidation:Boolean (default = false)

Returns
Boolean

See also

gotoPrev()method 
public function gotoPrev(stayInTeir:Boolean = false, ignoreValidation:Boolean = false):Boolean

Navigates to the next slide in a call in the MultiPathSlideManager.

Parameters
stayInTeir:Boolean (default = false)
 
ignoreValidation:Boolean (default = false)

Returns
Boolean

See also

loadBrand()method 
public function loadBrand(brandID:int):void

Loads a brand based on the specified brand ID.

Parameters
brandID:int — The brand id
loadCall()method 
public function loadCall(callID:int):Boolean

Retreives call data from the DataInterface and updates the SlideManager's dataprovider with the results.

Parameters
callID:int

Returns
Boolean — A boolean value wheter the call was successfully loaded.
loadDefaultCall()method 
public function loadDefaultCall(indicationId:int):void

Attempts to load the default call for the indication.

Parameters
indicationId:int
loadIndication()method 
public function loadIndication(indicationID:int, autoLoadDefaultCall:Boolean = false):void

Loads all data associated with an indication.

Parameters
indicationID:int — The id of the indication data to load
 
autoLoadDefaultCall:Boolean (default = false) — Loads the default call associated with an indication if true, otherwise loads all slides in the indication.
loadSlideManager()method 
protected function loadSlideManager():void

loadState()method 
public function loadState(state:Object):void

Handles any request from the HistoryManager to restore a point in history into the PresentationModule. Override to set additional custom properties after calling super.

Parameters
state:Object — object with the state's settings
navigateHome()method 
public function navigateHome(ignoreValidation:Boolean = false):Boolean

Makes a request to the MultiPathSlideManager to destroy all offshoots and navigates to the default slide node. This method follows the flex lifecyle. If a dataProvider has been set, the navigate home method will not run until commitProperties has run

Parameters
ignoreValidation:Boolean (default = false) — If true, forces the move to the default slide node even if doing so violates a business rule of the current slide node or the default slide node.

Returns
Boolean — returns true if the request to navigate home was successful, false otherwise. In the case when the dataProvider has changed but has not yet been updated via the commitProperties internal method, this will return false even if later the request is granted asynchornously. If using asyncrhonously (changing dataProvider, setting callID or indicationID before calling navigateHome and want the boolean result, listen for the DataEvent.DATA event and then navigateHome)

See also

navigateTo()method 
public function navigateTo(slide_dbid:String, ignoreValidation:Boolean = false):Boolean

Destroys all offshoots on the PresentationModule's MultiPathSlideManager employing the flex lifecycle to navigates to the first slide node with a matching dbid attribute or parent node with a title attribute matching slide_dbid_or_section_Title String. Note: If multiple slides may have the same dbid attribute and it is desired to visit one of these slide nodes beyond the first, consider using navigateToSlideIndex if navigating within the underlying SlideManager's dataProvider. within the dataProvider of the underlying SlideManager.

Parameters
slide_dbid:String
 
ignoreValidation:Boolean (default = false) — forces the navigation even if it violates a business rule in either the current node or the desintation node.

Returns
Boolean — true if navigation was successful, otherwise false.

See also

navigateToBookmark()method 
public function navigateToBookmark(bookmarkSlides:XMLList):Boolean

Makes a request to the MultiPathSlideManager to navigate to the XMLList of content slides provided, independant of the current dataprovider. Once the slides are navigated through, the offshoot is discarded, and the gotoNext and gotoPrevious methods will not return to the offshoot. If returning to the offshoot is desired, use the ApplicationHistoryManager's back method or the PresentationModule's reference to the ApplicationHistoryManager called historyManager.

Parameters
bookmarkSlides:XMLList — is the list of slide nodes to navigate through while deviating from the MultiPathSlideManager's dataProvider's slides.

Returns
Boolean — true if the navigation was successful, false otherwise.

Example
This is sample of the slideList parameter containing two content slides that will become two slides in an offshoot. Sending them causes an offshoot to be created, and navigation to the first slide in the list.
   <slide dbid="4" sectionID="1" slideFilename="/presentations/eveacore/slides/patient_caseStudy2.swf" slideThumbnailFilename="/presentations/eveacore/thumbnails/patient_caseStudy2_th.jpg" color="#b6544a" stateName="Patient - Case Study 2" id="Patient - Case Study 2" mustPrecede="" mustFollow="5" title="Patient - Case Study 2" />
   <slide dbid="5" sectionID="1" slideFilename="/presentations/eveacore/slides/patient_caseStudy2a.swf" slideThumbnailFilename="/presentations/eveacore/thumbnails/patient_caseStudy2a_th.jpg" color="#b6544a" stateName="Patient - Case Study 2a" id="Patient - Case Study 2a" mustPrecede="4" mustFollow="" title="Patient - Case Study 2a" />
   

navigateToOffShoot()method 
public function navigateToOffShoot(slideList:XMLList, ignoreValidation:Boolean = false, displayMultipleSlideMessage:Boolean = true):Boolean

Makes a request to the MultiPathSlideManager to navigate to the XMLList of content slides provided, independant of the current dataprovider. Once the slides are navigated through, the offshoot is discarded, and the gotoNext and gotoPrevious methods will not return to the offshoot. If returning to the offshoot is desired, use the ApplicationHistoryManager's back method or the PresentationModule's reference to the ApplicationHistoryManager called historyManager.

Parameters
slideList:XMLList — is the list of slide nodes to navigate through while deviating from the dataProvider's slides.
 
ignoreValidation:Boolean (default = false) — if true will bypass eVE Navigation Change validation.
 
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).

Returns
Boolean — true if the navigation was successful, false otherwise.

See also


Example
This is sample of the slideList parameter containing two content slides that will become two slides in an offshoot. Sending them causes an offshoot to be created, and navigation to the first slide in the list.
   <slide dbid="4" sectionID="1" slideFilename="/presentations/eveacore/slides/patient_caseStudy2.swf" slideThumbnailFilename="/presentations/eveacore/thumbnails/3D/patient_caseStudy2_smth.jpg" color="#b6544a" stateName="Patient - Case Study 2" id="Patient - Case Study 2" mustPrecede="" mustFollow="5" title="Patient - Case Study 2" />
   <slide dbid="5" sectionID="1" slideFilename="/presentations/eveacore/slides/patient_caseStudy2a.swf" slideThumbnailFilename="/presentations/eveacore/thumbnails/3D/patient_caseStudy2a_smth.jpg" color="#b6544a" stateName="Patient - Case Study 2a" id="Patient - Case Study 2a" mustPrecede="4" mustFollow="" title="Patient - Case Study 2a" />
   

navigateToSlideIndex()method 
public function navigateToSlideIndex(index:int, ignoreValidation:Boolean = false):Boolean

Makes a request to the MultiPathSlideManager to destroys all offshoots and employ the flex lifecycle to navigate to the slide node at the specified index within MultiPathSlideManager's native dataProvider.

Parameters
index:int — index within the dataProvider to navigate to.
 
ignoreValidation:Boolean (default = false) — forces the navigation even if it violates a business rule in either the current node or the node at the specified index.

Returns
Boolean — true if navigation was successful, otherwise false.

See also

onCallResetAlertClosed()method 
protected function onCallResetAlertClosed(e:CloseEvent):void

Parameters
e:CloseEvent
onNavigationChanged()method 
protected function onNavigationChanged(e:NavigationChangeEvent):void

Executed on a NAVIGATION_CHANGED event. This code gets the event's currentNode and based on that loads the template and slide.

Parameters
e:NavigationChangeEvent — event object
onNavigationData()method 
protected function onNavigationData(e:DataEvent):void

Parameters
e:DataEvent
onNavigationError()method 
protected function onNavigationError(e:NavigationErrorEvent):void

Parameters
e:NavigationErrorEvent
onNavigationLocked()method 
protected function onNavigationLocked(e:DataEvent):void

Parameters
e:DataEvent
onQuickViewModuleItemClick()method 
public function onQuickViewModuleItemClick(e:ItemClickEvent):void

Handles the click on a QuickViewModule item.

Parameters
e:ItemClickEvent — The item click event
onRemovedFromStage()method 
public function onRemovedFromStage(e:Event):void

Event that fires when the a state containing the PresentationModule is left.

Parameters
e:Event — The event
onSlidesRemovedAlertClosed()method 
protected function onSlidesRemovedAlertClosed(e:CloseEvent):void

Parameters
e:CloseEvent
preloadSlideManager()method 
public function preloadSlideManager():void

Loads the MuliPathSlideManager's dataprovider instantly, before (instead of using) the Flex lifecyle's commit properties. This works well if you wanted to preload the dataprovider before adding the presentation modole to its parent's display list.

refresh()method 
public function refresh():void

Forces a refresh of data associated with the current brand, indication, and call by calling the DataInterface and updadating dependant dataproviders.

Note: refreshing immediately after the setting dataProvider (or setting that modifies it) but before commitProperties runs will cause the dataProvider to re-load based on its old values. To refresh to the new ones after setting the dataProvider or a setter that calls it, call the preLoadSlideManager method. If it's necessary to call refresh() after that, it will refresh to the new dataProvider.

See also

preloadSlideManager()
reset()method 
public function reset():void

Resets the PresentationModule's MultiPathSlideManager to its initial state.

See also

saveState()method 
public function saveState():Object

Calls the getState method. Retrieves the the current state of PresentationModule. Primarily used internally by the HistoryManager although may be useful if wanting to return to a state. This can be overriden if desiring to save additional properties, add the properties to the object being returned after calling the super().

Returns
Object
showQuickView()method 
public function showQuickView():void

Pops up the QuickViewModule in an OverlayWindow with the current callID.

slideNavigateToIdHandler()method 
protected function slideNavigateToIdHandler(e:EveEvent):voidParameters
e:EveEvent
Event detail
brandChangeevent 
Event object type: at.events.EveDataChangeEvent

Dispatched when a the brandID property has changed.

callChangeevent  
Event object type: at.events.EveDataChangeEvent

Dispatched when a the callID property has changed.

dataevent  
Event object type: flash.events.DataEvent

Dispatched after the SlideManager has loaded it's data, before defaults are set or any default navigation is executed.

emptyCallErrorevent  
Event object type: flash.events.Event

Dispatched after loadCall or loadDefaultCall is called and the selected or default call happens to have no slides in it.

indicationChangeevent  
Event object type: at.events.EveDataChangeEvent

Dispatched when a the indicationID property has changed.

navigationChangedevent  
Event object type: at.events.NavigationChangeEvent

Dispatched after the SlideManager has changed to the current slide in it's slide list.

navigationChangingevent  
Event object type: at.events.NavigationChangeEvent

Dispatched after the SlideManager has determined the navigation request is valid, but before the change is made.

navigationErrorevent  
Event object type: at.events.NavigationErrorEvent

Dispatched after the SlideManager has loaded it's data, before defaults are set or any default navigation is executed.

navigationLockedevent  
Event object type: flash.events.Event

Dispatched when a request to change content slides has been made to the SlideManager but the navigation has not been unlocked. Unlocking occurs automatically after a set amount of millisenconds (lockTimeLimitMSec) IF lockNav

navigationRequestevent  
Event object type: at.events.NavigationChangeEvent

Dispatched when a request to change content slides has been made to the SlideManager but before the request has been validated.

Constant detail
EMPTY_CALL_ERRORconstant
public static const EMPTY_CALL_ERROR:String = "emptyCallError"

Constant for the event indicating that a the call being changed to has no content slides in the call.

EXITINGconstant 
public static const EXITING:String = "exiting"

Constant for the event indicating the presentation module is closing