Packageat.modules
Interfacepublic interface IPresentationModule extends flash.events.IEventDispatcher
ImplementorsPresentationModule



Public Properties
 PropertyDefined by
  allowOffShootNavigation : Boolean
Indicates if a jump to other slides will be permitted (i.e.
IPresentationModule
  allowPathDeviation : Boolean
[read-only] Specifies whether deviating from the current slide in this call breaks the mustFollow business rule of the current content slide.
IPresentationModule
  brandID : int
Sets the current brand and loads all brand-related data.
IPresentationModule
  brandTitle : String
[read-only] The title of the current brand.
IPresentationModule
  callBookmarks : XMLList
[read-only] Returns the bookmarks associated with the current call.
IPresentationModule
  callID : int
Returns the current callId.
IPresentationModule
  callTitle : String
[read-only] The title of the current call.
IPresentationModule
  callTitleAbbreviation : String
[read-only] The abbreviated title of the current call.
IPresentationModule
  dataProvider : XMLList
Returns the dataProvider for the Presentation Module which is normally set by setting the callID or indicationID
IPresentationModule
  indicationID : int
Sets the current indication and loads all indication-related data.
IPresentationModule
  indicationTitle : String
[read-only] The title of the current indication.
IPresentationModule
  navLockable : Boolean
Indications wheather locking of navigation after a navigation change occurs for a specified duration is allowed.
IPresentationModule
Public Methods
 MethodDefined by
  
exitPresentation(arg1:Boolean = false):void
Informs the Presentation Module that it is being exited, and dispatches an Event.EXITING event.
IPresentationModule
  
getCurrentNode(arg1:Boolean = false):XML
Returns a copy of the MultiPathSlideManager's native dataProvider's (ignores offshoot above it) current node or a reference if specified.
IPresentationModule
  
getDefaultNode(arg1:Boolean = false):XML
Returns a copy of the default slide node from the MultiPathSlideManager.
IPresentationModule
  
getExitingEvent():String
Returns the constant type for the presentationExiting event.
IPresentationModule
  
getNextNode(arg1:Boolean = false, arg2:Boolean = false):XML
Returns the node in the MultiPathSlideManager that would be navigated to if calling the gotoNext method.
IPresentationModule
  
getNodeById(arg1:String, arg2:Boolean = false):XML
Searches the MultiPathSlideManager's dataProvider's (not offshoots) naviagation structure for the first node having the dbid specified
IPresentationModule
  
getPreviousNode(arg1:Boolean = false, arg2:Boolean = false):XML
Returns the previous node in the MultiPathSlideManager that would be navigated to if the gotoPrev method were to be called.
IPresentationModule
  
Returns an instance of the SlideManager that controls the navigation of the slides in the presentation.
IPresentationModule
  
getState(arg1:String = null):Object
Retrieves the the current state of PresentationModule.
IPresentationModule
  
gotoNext(arg1:Boolean = false, arg2:Boolean = false):Boolean
Navigates to the next slide in a call in the MultiPathSlideManager.
IPresentationModule
  
gotoPrev(arg1:Boolean = false, arg2:Boolean = false):Boolean
Navigates to the next slide in a call in the MultiPathSlideManager.
IPresentationModule
  
loadBrand(arg1:int):void
Sets the current brand and loads all brand-related data.
IPresentationModule
  
loadCall(arg1:int):Boolean
Retreives call data from the DataInterface and updates the SlideManager's dataprovider with the results.
IPresentationModule
  
loadIndication(arg1:int, arg2:Boolean = true):void
Loads all data associated with an indication.
IPresentationModule
  
loadState(arg1:Object):void
Handles any request from the HistoryManager to restore a point in history into the PresentationModule.
IPresentationModule
  
navigateHome(arg1:Boolean = false):Boolean
Makes a request to the MultiPathSlideManager to destroy all offshoots and navigates to the default slide node.
IPresentationModule
  
navigateTo(arg1:String, arg2: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.
IPresentationModule
  
navigateToBookmark(arg1:XMLList):Boolean
Makes a request to the MultiPathSlideManager to navigate to the XMLList of content slides provided, independant of the current dataprovider.
IPresentationModule
  
navigateToOffShoot(arg1: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.
IPresentationModule
  
navigateToSlideIndex(arg1:int, arg2: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.
IPresentationModule
  
onQuickViewModuleItemClick(arg1:ItemClickEvent):void
Handles the click on a QuickViewModule item.
IPresentationModule
  
onRemovedFromStage(arg1:Event):void
Event that fires when the a state containing the PresentationModule is left.
IPresentationModule
  
Loads the MuliPathSlideManager's dataprovider instantly, before (instead of using) the Flex lifecyle's commit properties.
IPresentationModule
  
refresh():void
Forces a refresh of data associated with the current brand, indication, and call by calling the DataInterface and updadating dependant dataproviders.
IPresentationModule
  
reset():void
Resets the PresentationModule's MultiPathSlideManager to its initial state.
IPresentationModule
  
saveState():Object
Calls the getState method.
IPresentationModule
  
Pops up the QuickViewModule in an OverlayWindow with the current callID.
IPresentationModule
Property detail
allowOffShootNavigationproperty
allowOffShootNavigation:Boolean  [read-write]

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

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.

Implementation
    public function get allowPathDeviation():Boolean
brandIDproperty 
brandID:int  [read-write]

Sets the current brand and loads all brand-related data. Data will be available once the commit properties function fires, or preloadSlideManager is called.

The default value is undefined.

Implementation
    public function get brandID():int
    public function set brandID(value:int):void

See also

brandTitleproperty 
brandTitle:String  [read-only]

The title of the current brand.

The default value is "".

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

Returns the bookmarks associated with the current call.

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

Returns the current callId.

Implementation
    public function get callID():int
    public function set callID(value:int):void
callTitleproperty 
callTitle:String  [read-only]

The title of the current call.

The default value is "".

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

The abbreviated title of the current call.

The default value is "".

Implementation
    public function get callTitleAbbreviation():String
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

See also

indicationIDproperty 
indicationID:int  [read-write]

Sets the current indication and loads all indication-related data. If no call is specified, loads the default call for the indication once the commit properties function fires, or preloadSlideManager is called.

The default value is undefined.

Implementation
    public function get indicationID():int
    public function set indicationID(value:int):void

See also

indicationTitleproperty 
indicationTitle:String  [read-only]

The title of the current indication.

The default value is "".

Implementation
    public function get indicationTitle():String
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

Method detail
exitPresentation()method
public function exitPresentation(arg1:Boolean = false):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
arg1:Boolean (default = false)
getCurrentNode()method 
public function getCurrentNode(arg1: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
arg1: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(arg1:Boolean = false):XML

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

Parameters
arg1: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
getNextNode()method 
public function getNextNode(arg1:Boolean = false, arg2: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
arg1: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.
 
arg2: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(arg1:String, arg2:Boolean = false):XML

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

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

 
arg2: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(arg1:Boolean = false, arg2: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
arg1: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.
 
arg2: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

getslideManager()method 
public function getslideManager():*

Returns an 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.

Returns
*

See also

getState()method 
public function getState(arg1: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
arg1:String (default = null)

Returns
Object
gotoNext()method 
public function gotoNext(arg1:Boolean = false, arg2:Boolean = false):Boolean

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

Parameters
arg1:Boolean (default = false)
 
arg2:Boolean (default = false)

Returns
Boolean

See also

gotoPrev()method 
public function gotoPrev(arg1:Boolean = false, arg2:Boolean = false):Boolean

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

Parameters
arg1:Boolean (default = false)
 
arg2:Boolean (default = false)

Returns
Boolean

See also

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

Sets the current brand and loads all brand-related data. Data will be available once the commit properties function fires, or preloadSlideManager is called.

Parameters
arg1:int

See also

loadCall()method 
public function loadCall(arg1:int):Boolean

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

Parameters
arg1:int

Returns
Boolean
loadIndication()method 
public function loadIndication(arg1:int, arg2:Boolean = true):void

Loads all data associated with an indication.

Parameters
arg1:int — The id of the indication data to load
 
arg2:Boolean (default = true) — Loads the default call associated with an indication if true, otherwise loads all slides in the indication.
loadState()method 
public function loadState(arg1: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
arg1:Object — object with the state's settings
navigateHome()method 
public function navigateHome(arg1: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
arg1: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(arg1:String, arg2: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
arg1:String
 
arg2: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(arg1: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
arg1: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" imageStackThumbnailFilename="null" slideTilerThumbnailFilename="null" preCallThumbnailFilename="/presentations/eveacore/thumbnails/patient_caseStudy2_th.jpg" siteMap3DThumbnailFilename="/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" imageStackThumbnailFilename="null" slideTilerThumbnailFilename="null" preCallThumbnailFilename="/presentations/eveacore/thumbnails/patient_caseStudy2a_th.jpg" siteMap3DThumbnailFilename="/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" />
   

navigateToOffShoot()method 
public function navigateToOffShoot(arg1: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
arg1:XMLList — is the list of slide nodes to navigate through while deviating from the dataProvider's slides.
 
ignoreValidation:Boolean (default = false) — 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).
 
displayMultipleSlideMessage:Boolean (default = true)

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(arg1:int, arg2: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
arg1:int — index within the dataProvider to navigate to.
 
arg2: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

onQuickViewModuleItemClick()method 
public function onQuickViewModuleItemClick(arg1:ItemClickEvent):void

Handles the click on a QuickViewModule item.

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

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

Parameters
arg1:Event
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.