Packageat.modules
Classpublic class PreCallModule
InheritancePreCallModule Inheritance PreCallBase Inheritance mx.containers.VBox
Implementsmx.binding.IBindingClient



Public Properties
 PropertyDefined by
  alertIcon : Class
The icon for Slide syncronization warnings.
PreCallModule
 InheritedallChangesCommitted : Boolean
Value will be false if any bookmarks or Call items have been changed but not yet committed to the database.
PreCallBase
 InheritedbookmarkChangesCommitted : Boolean
Returns false if any bookmark items have been changed but the items have not yet been committed to the database, otherwise true
PreCallBase
 InheritedbrandID : int
The current brand id.
PreCallBase
  callButtons : Array
[read-only] This is an Array of all the call Buttons.
PreCallModule
 InheritedcallChangesCommitted : Boolean
Returns false if a change has been made to any call slides but not yet committed to the database, otherwise true.
PreCallBase
  callID : int
[write-only] Setter for current call.
PreCallModule
 InheritedclearCurrentBookmarkComponent : UIComponent
Returns the currently specified UIComponent for the clearCurrentBookmark() method.
PreCallBase
 InheritedclearCurrentCallAndBookmarkComponent : UIComponent
Returns the currently specified UIComponent for the clearCurrentCallAndBookmark() method.
PreCallBase
 InheritedclearCurrentCallComponent : UIComponent
Returns the currently specified UIComponent for the clearCurrentCall() method.
PreCallBase
 Inheritedcontrol : PreCallControl
Control contains routine helper functions and helper events for saving, reseting and clearing items in the PreCallModule.
PreCallBase
 InheritedcurrentBookmark : XML
The current bookmark in the currently selected call.
PreCallBase
 InheritedcurrentBookmarkEditable : Boolean
Value is true if the current bookmark is editable.
PreCallBase
 InheritedcurrentBookmarkItems : XMLList
The list of items belonging to the current bookmark.
PreCallBase
 InheritedcurrentBookmarks : XML
The bookmarks belonging to the all of the calls in the current indication.
PreCallBase
 InheritedcurrentBrandID : int
The id of the current Brand.
PreCallBase
 InheritedcurrentBrandTitle : String
The title of the current Brand.
PreCallBase
 InheritedcurrentCall : XMLList
The current call in the component.
PreCallBase
 InheritedcurrentCallEditable : Boolean
Determines if the current call is editible (true) or not.
PreCallBase
 InheritedcurrentCallID : int
The id of the current call.
PreCallBase
 InheritedcurrentCallIndex : int
The index of the current call of the current indication.
PreCallBase
 InheritedcurrentCalls : XMLList
All calls for the current indication.
PreCallBase
 InheritedcurrentCallSlides : XMLList
The child slides of the current call.
PreCallBase
 InheritedcurrentCallTitle : String
The title of the current call.
PreCallBase
 InheritedcurrentCallTitleAbbreviation : String
The title abbreviation of the current call from the titleAbbr property.
PreCallBase
 InheritedcurrentIndicationID : int
The id of the current indication.
PreCallBase
 InheritedcurrentIndicationSlides : XMLList
All of the slides in the current indication.
PreCallBase
 InheritedcurrentIndicationTitle : String
Returns the title of the current indication.
PreCallBase
 InheritedcurrentSection : XMLList
The currently selected Section.
PreCallBase
 InheritedcurrentSectionIndex : int
The index of the current Section within available in the current Indication.
PreCallBase
 InheritedcurrentSections : XMLList
All of the sections in the current indication.
PreCallBase
 InheritedcurrentSectionSlideList : XMLList
The slide list belonging to the current Section.
PreCallBase
 InheritedcustomCalls : XMLList
All calls for the current indication having a type attribute value of custom.
PreCallBase
 InheriteddebugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
PreCallBase
 InheriteddefaultCallID : int
This is the default call that is loaded to edit if one is not specified.
PreCallBase
 InheriteddefaultCalls : XMLList
All calls for the current indication having a type attribute value of default.
PreCallBase
 InheritedindicationID : int
The current indication id.
PreCallBase
 InheritedrenameCurrentCallComponent : UIComponent
Returns the currently specified UIComponent for the renameCurrentCall() method.
PreCallBase
 InheritedresetPrecallComponent : UIComponent
Returns the currently specified UIComponent for the resetPrecall() method.
PreCallBase
 InheritedsaveAllComponent : UIComponent
Returns the currently specified UIComponent for the saveAll() method.
PreCallBase
 InheritedsaveBookmarksComponent : UIComponent
Returns the currently specified UIComponent for the saveBookmarks() method.
PreCallBase
 InheritedsaveCallsComponent : UIComponent
Returns the currently specified UIComponent for the saveCall() method.
PreCallBase
 InheritedsaveCurrentCallAsQuickstartComponent : UIComponent
Returns the currently specified UIComponent for the saveCurrentCallAsQuickstart() method.
PreCallBase
Protected Properties
 PropertyDefined by
 InheritedcallSyncPropertyChanges : DBUpdateChanges
The data that has changed in the database after a remote database synchronization.
PreCallBase
 InheritedoverlayWindow : OverlayWindow
The window that pops up messages and the database commit progress.
PreCallBase
 InheritedprogressBar : ProgressBar
The visual display of the progress of transactions occuring with the database.
PreCallBase
Public Methods
 MethodDefined by
  
This handles the bookmark button click, and switches between the states of the module.
PreCallModule
 Inherited
commitAllCalls():CallTransaction
Saves uncommitted [customized] calls in memory to the database on disk.
PreCallBase
 Inherited
commitBookmarks():BookmarkTransaction
Saves the bookmarks in memory to the database on disk.
PreCallBase
 Inherited
deleteBookmarkSlideByIndex(bookmark:XML, index:int):void
Removes the slide at the specfied index from the given boomark
PreCallBase
 Inherited
Deletes an bookmark from the current bookmark list at the index provided.
PreCallBase
  
editCall():void
Transitions the PreCallModule to the Call editor.
PreCallModule
 Inherited
Forces an update to internal currentCall bindable variable setting it's children to the current value of currentCallSlides.
PreCallBase
 Inherited
getAllBookmarks():XMLList
Returns a list of all bookmarks associated with an Indication.
PreCallBase
 Inherited
getAllCalls():XMLList
Returns all Calls for the current Indication.
PreCallBase
 Inherited
getBookmarkByCallID(callID:int):XML
Returns a bookmark associated with a Call based on the callID provided.
PreCallBase
 Inherited
getCall(callID:int):XML
Returns the Call of the current Indication based on the id provided.
PreCallBase
 Inherited
getCallChangesCommitted(queryDatabase:Boolean = false):Boolean
Returns false if a change has been made to any call slides but not yet committed to the database, otherwise true
PreCallBase
 Inherited
getCallChildren(callID:int):XMLList
Returns a list of slides from the specified call.
PreCallBase
 Inherited
Returns all bookmarks that have the type attribute set to custom.
PreCallBase
 Inherited
Returns all Calls that have the type attribute set to custom.
PreCallBase
 Inherited
Returns all bookmarks that have the type attribute set to default.
PreCallBase
 Inherited
getDefaultCalls():XMLList
Returns all Calls that have the type atribute set to default.
PreCallBase
 Inherited
getIndications(brandID:int):XMLList
The list of Indications belonging to a brand.
PreCallBase
 Inherited
getUncommittedBookmarks(queryDatabase:Boolean = false, byReference:Boolean = false):XMLListCollection
Returns a XMLListCollection of of bookmarks that have changed since last committed to the database.
PreCallBase
 Inherited
getUncommittedCalls(queryDatabase:Boolean = false):XMLListCollection
Returns a XMLListCollection of of calls that have changed since last committed to the database.
PreCallBase
  
Moves the PreCallModule from the Call editor to the Bookmark editor
PreCallModule
  
Moves the PreCallModule from the Bookmark editor to the Call editor
PreCallModule
 Inherited
handleCallValidationError(message:String, dispatchValidationResultEvent:Boolean = false):ValidationResult
Handles call validation errors.
PreCallBase
 Inherited
isCall(callID:int):Boolean
Ensures the specified callID is in the current indication's list of Calls
PreCallBase
 Inherited
isValidCall(callSlides:XMLList = null, optimized__returnsFirstErrorOnly:Boolean = true, dispatchValidationResultEvent:Boolean = false):ValidationResult
Checks the specified call slide list for proper Slide ordering and ensures the correct Slides are in the list.
PreCallBase
 Inherited
loadState(state:Object):void
PreCallBase
 Inherited
renameCall(callID:int, title:String = null, titleAbbreviation:String = null):Boolean
Changes the title and title abbreviation (titleAbbr in the database) to the corresponding values provided of the Call with the specified callID.
PreCallBase
  
reset():void
PreCallModule
 Inherited
saveState():Object
PreCallBase
 Inherited
setBookmarkItems(bookmark:XML, items:XMLList):void
Sets all of bookmark data of the given bookmark
PreCallBase
 Inherited
setCurrentCallByID(callID:int):void
Sets the current Call to the Call with the id provided.
PreCallBase
  
setCurrentIndication(brandID:int, indicationID:int, onLoadComplete:Function = null, forceReload:Boolean = false):void
Sets the current indication for the pre-call module and updates all dataproviders.
PreCallModule
  
validBookmark(value:XML, ignore:BookmarkDrop = null):Boolean
Validates that the value of the slide node provided does not already exist in the bookmark list.
PreCallModule
Protected Methods
 MethodDefined by
  
addHandler(e:Event):void
Handles adding a slide from a PreCallModuleEvent.ADD_SLIDE with the data in the event.
PreCallModule
 Inherited
PreCallBase
  
callButtonHandler(e:ItemClickEvent):void
Handles the clicks from the defaultCallButtons and changes the currentCall.
PreCallModule
  
dragDropHandler(e:DragEvent):void
The handler for when a slide is dropped onto the SlideDropTarget.
PreCallModule
  
dragEnterHandler(e:DragEvent):void
Handles the dragging of a slide on the SlideDropTarget.
PreCallModule
  
dragExitHandler(e:DragEvent):void
Resets some settings when the drag is completed.
PreCallModule
  
dragOverHandler(e:DragEvent):void
Handles all the logic and validation when a slide is dragged over the SlideDropTarget.
PreCallModule
  
generateValidationTestData(value:Object):XMLListCollection
Generates an XMLListCollection to help the validation of the data in the drop.
PreCallModule
  
Helper to get the current section color.
PreCallModule
  
Handles the selection of the current call button, when the data is loaded.
PreCallModule
  
Handles the visibility of components based on the currentState, currentCallEditable, and currentBookmarkEditable> properties.
PreCallModule
  
invalidResultHandler(e:ValidationResultEvent):void
Handles when Slide rules are violated.
PreCallModule
 Inherited
Handles teh event when the bookmark changes.
PreCallBase
 Inherited
onCurrentCallChanged(e:Event):void
Handles teh event when the Call changes.
PreCallBase
 Inherited
Handles the event when the Indication changes.
PreCallBase
 Inherited
Handles the event when the Section changes.
PreCallBase
 Inherited
PreCallBase
 Inherited
PreCallBase
 Inherited
onProgress(e:ProgressEvent):void
Handles the progress of the commit to the database.
PreCallBase
 Inherited
onProgressComplete(e:Event):void
PreCallBase
  
Handles the removal of bookmarks from the BookmarkDrop components.
PreCallModule
 Inherited
saveAllClickHandler(e:Event):void
PreCallBase
  
Updates the currentBookmarkItems property with all of the current bookmarks in the display.
PreCallModule
 Inherited
saveCallsClickHandler(e:Event):void
PreCallBase
  
sectionChangeHandler(e:MouseEvent):void
Handles the click event from the sectionButtons.
PreCallModule
 Inherited
setCurrentCallIndex(index:int):void
Changes the current Call to the index provided.
PreCallBase
 Inherited
showProgressBar(source:Object, title:String = "Progress"):void
Shows the progressBar in an overlay window letting the user know the progress of the save to the database.
PreCallBase
  
stateChangeHandler(e:StateChangeEvent):void
Handles the event for the switch to the Call editor state and the bookmark editor state and back.
PreCallModule
  
Convenience function for displaying the bookmarks from the current bookmark data.
PreCallModule
  
Sets the selected property for the sectionButtons with the currentSectionIndex.
PreCallModule
  
validResultHandler(e:ValidationResultEvent):void
Traces a success message if the slide rules are all valid and debugMode is true.
PreCallModule
Events
 EventSummaryDefined by
    PreCallModule
    PreCallModule
    PreCallModule
    PreCallModule
    PreCallModule
 Inherited PreCall control event dispatched before bookmarks are saved if they in fact do need to be saved.PreCallBase
    PreCallModule
    PreCallModule
 Inherited Dispatched when all of the current calls have been changed or loaded.PreCallBase
 Inherited PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
 Inherited PreCall control event dispatched before calls are saved if they in fact do need to be saved.PreCallBase
 Inherited PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
 Inherited PreCall control event dispatched when the clearing of the currently selected call and it's bookmarks has completed.PreCallBase
 Inherited PreCall control event dispatched when the clearing of the currently selected call's bookmarks has completed.PreCallBase
 Inherited PreCall control event dispatched when the clearing of the currently selected call has completed.PreCallBase
 Inherited Dispatched when the current bookmarks have changed.PreCallBase
 Inherited Dispatched when the current call has changed.PreCallBase
 Inherited Dispatched when the current indication has changed.PreCallBase
    PreCallModule
 Inherited Dispatched when the current section has changed.PreCallBase
 Inherited Dispatched when the default call has changed.PreCallBase
 Inherited PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
    PreCallModule
    PreCallModule
 Inherited PreCall control event dispatched when PreCallControl.saveAll() is fired and PreCallBase
 Inherited PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
 Inherited PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
 Inherited PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
 Inherited PreCall control event dispatched when saving all calls and bookmarks has completed.PreCallBase
 Inherited PreCall control event dispatched when saving all bookmarks has completed.PreCallBase
 Inherited PreCall control event dispatched when saving all calls has completed.PreCallBase
 Inherited PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
    PreCallModule
    PreCallModule
 Inherited PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
    PreCallModule
Styles
 StyleDescriptionDefined by
  
bookmarkButtonStyleName
Type: String   CSS Inheritance: no
PreCallModule
  
bookmarkGap
Type: Number   CSS Inheritance: no
PreCallModule
  
bookmarkHeight
Type: Number   Format: Length   CSS Inheritance: no
PreCallModule
  
bookmarkWidth
Type: Number   Format: Length   CSS Inheritance: no
PreCallModule
  
callButtonStyleName
Type: String   CSS Inheritance: no
PreCallModule
 Inherited Type: String   CSS Inheritance: no
The styleName of the TitleWindow component that is popped up when the progress bar or Alert is displayed.
PreCallBase
 Inherited Type: String   CSS Inheritance: no
The titleStyleName property of the overlayWindowStyleName for the TitleWindow component that is popped up when the progress bar or Alert is displayed.
PreCallBase
 Inherited Type: String   CSS Inheritance: no
The styleName of the ProgressBar component that is displayed during database saves.
PreCallBase
  
sectionButtonStyleName
Type: String   CSS Inheritance: no
PreCallModule
  
slideDropTargetStyleName
Type: String   CSS Inheritance: no
PreCallModule
  
slideRepositoryTileListStyleName
Type: String   CSS Inheritance: no
PreCallModule
Property detail
alertIconproperty
public var alertIcon:Class

The icon for Slide syncronization warnings.

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

See also

callButtonsproperty 
callButtons:Array  [read-only]

This is an Array of all the call Buttons.

The buttons are in two separate components, this is a list of all Buttons across both components.

Implementation
    public function get callButtons():Array
callIDproperty 
callID:int  [write-only]

Setter for current call. Also updates current brand and indication if applicable.

Implementation
    public function set callID(value:int):void
Method detail
addHandler()method
protected function addHandler(e:Event):void

Handles adding a slide from a PreCallModuleEvent.ADD_SLIDE with the data in the event.

This handles the adding for the SlideDropTarget and the bookmarks.

Parameters
e:Event — The PreCallModuleEvent

See also

bookmarkButtonClickHandler()method 
public function bookmarkButtonClickHandler(e:Event):void

This handles the bookmark button click, and switches between the states of the module.

Parameters
e:Event — The event
callButtonHandler()method 
protected function callButtonHandler(e:ItemClickEvent):void

Handles the clicks from the defaultCallButtons and changes the currentCall.

Parameters
e:ItemClickEvent — The ItemClickEvent

See also

mx.events.ItemClickEvent
dragDropHandler()method 
protected function dragDropHandler(e:DragEvent):void

The handler for when a slide is dropped onto the SlideDropTarget.

Parameters
e:DragEvent — The DragEvent

See also

mx.events.DragEvent
dragEnterHandler()method 
protected function dragEnterHandler(e:DragEvent):void

Handles the dragging of a slide on the SlideDropTarget.

Parameters
e:DragEvent — The DragEvent

See also

mx.events.DragEvent
dragExitHandler()method 
protected function dragExitHandler(e:DragEvent):void

Resets some settings when the drag is completed.

Parameters
e:DragEvent — The DragEvent

See also

mx.events.DragEvent
dragOverHandler()method 
protected function dragOverHandler(e:DragEvent):void

Handles all the logic and validation when a slide is dragged over the SlideDropTarget.

Parameters
e:DragEvent — The DragEvent

See also

mx.events.DragEvent
editCall()method 
public function editCall():void

Transitions the PreCallModule to the Call editor.

generateValidationTestData()method 
protected function generateValidationTestData(value:Object):XMLListCollection

Generates an XMLListCollection to help the validation of the data in the drop.

Parameters
value:Object — The current data in the SlideDropTarget

Returns
XMLListCollection — A XMLListCollection of the data passed
getSectionColor()method 
protected function getSectionColor():uint

Helper to get the current section color.

Returns
uint — Returns 0xffffff if the color does not exist
Otherwise it returns the color
gotoBookmarkEditor()method 
public function gotoBookmarkEditor():void

Moves the PreCallModule from the Call editor to the Bookmark editor

gotoCallEditor()method 
public function gotoCallEditor():void

Moves the PreCallModule from the Bookmark editor to the Call editor

handleCallData()method 
protected function handleCallData(e:NavigationUIEvent):void

Handles the selection of the current call button, when the data is loaded.

Parameters
e:NavigationUIEvent — The NavigationUIEvent

See also

handleEditability()method 
protected function handleEditability():void

Handles the visibility of components based on the currentState, currentCallEditable, and currentBookmarkEditable> properties.

invalidResultHandler()method 
protected function invalidResultHandler(e:ValidationResultEvent):void

Handles when Slide rules are violated.

If debugMode is true output is traced.

Parameters
e:ValidationResultEvent — The result event
removeHandler()method 
protected function removeHandler(e:PreCallModuleEvent):void

Handles the removal of bookmarks from the BookmarkDrop components.

Parameters
e:PreCallModuleEvent — The PreCallModuleEvent

See also

reset()method 
public override function reset():void
saveBookmarks()method 
protected function saveBookmarks():void

Updates the currentBookmarkItems property with all of the current bookmarks in the display.

See also

sectionChangeHandler()method 
protected function sectionChangeHandler(e:MouseEvent):void

Handles the click event from the sectionButtons.

This handler changes the currentSection and sets the sectionColor for the SlideRepositoryTileList based off of the color attribute in the database.

Parameters
e:MouseEvent — The click event

See also

at.containers.SlideRepositoryTileList.
setCurrentIndication()method 
public override function setCurrentIndication(brandID:int, indicationID:int, onLoadComplete:Function = null, forceReload:Boolean = false):void

Sets the current indication for the pre-call module and updates all dataproviders.

Parameters
brandID:int — The database unique identifier for the brand
 
indicationID:int — The database unique identifier for the indication
 
onLoadComplete:Function (default = null) — The function that is called once data is loaded
 
forceReload:Boolean (default = false) — Setting to true forces reloading of the indication data from the database even if the indicationID and brandID haven't changed
stateChangeHandler()method 
protected function stateChangeHandler(e:StateChangeEvent):void

Handles the event for the switch to the Call editor state and the bookmark editor state and back.

Parameters
e:StateChangeEvent — The StateChangeEvent

See also

mx.events.StateChangeEvent
updateBookmarks()method 
protected function updateBookmarks():void

Convenience function for displaying the bookmarks from the current bookmark data.

updateBookmarksInternal()method 
eve_internal function updateBookmarksInternal():void
updateSectionButtons()method 
protected function updateSectionButtons():void

Sets the selected property for the sectionButtons with the currentSectionIndex.

validBookmark()method 
public function validBookmark(value:XML, ignore:BookmarkDrop = null):Boolean

Validates that the value of the slide node provided does not already exist in the bookmark list.

In the instance of a bookmark move, the ignore parameter specifies the instance of the BookmarkDrop to ignore during the check, otherwise the move will always fail (return false).

Parameters
value:XML — The XML node for the slide
 
ignore:BookmarkDrop (default = null) — The BookmarkDrop instance to not check against

Returns
Boolean — Returns true if the slide can be added as a bookmark

See also

validResultHandler()method 
protected function validResultHandler(e:ValidationResultEvent):void

Traces a success message if the slide rules are all valid and debugMode is true.

Parameters
e:ValidationResultEvent — The validation result event
Event detail
allBookmarksSavedevent 
Event object type: at.events.PreCallModuleEvent

allCallsSavedevent  
Event object type: at.events.PreCallModuleEvent

bookmarkAddedevent  
Event object type: at.events.PreCallModuleEvent

bookmarkDataChangedevent  
Event object type: at.events.PreCallModuleEvent

bookmarksClosedevent  
Event object type: at.events.PreCallModuleEvent

bookmarksOpenedevent  
Event object type: at.events.PreCallModuleEvent

callDataChangedevent  
Event object type: at.events.PreCallModuleEvent

currentSectionChangedevent  
Event object type: at.events.PreCallModuleEvent

invalidevent  
Event object type: mx.events.ValidationResultEvent

mustHaveSlidesMovedevent  
Event object type: at.events.PreCallModuleEvent

slideAddedevent  
Event object type: at.events.PreCallModuleEvent

slideRemovedevent  
Event object type: at.events.PreCallModuleEvent

validevent  
Event object type: mx.events.ValidationResultEvent