Packageat.utils
Classpublic class PreCallControl
InheritancePreCallControl Inheritance flash.events.EventDispatcher

This class handles basic functionality of the PreCallModule. It contains functions and events for saving, clearing and renaming calls. Every function contains an alert message before the action is preformed. Messages can be customized by replacing the values for the "Message Strings".


Example
  //Precall control has the ability to set up click handlers and enable/disable functionality
  //by simply passing a reference to a button.
  
  
  



Public Properties
 PropertyDefined by
  debugMode : Boolean = true
[static]
PreCallControl
  enableSaveAll : Boolean
[read-only] A bindable variable that can toggle visual element if you have any unsaved changes in your precall.
PreCallControl
  enableSaveBookmark : Boolean
[read-only] A bindable variable that can toggle visual element if you have any unsaved Bookmarks in your precall.
PreCallControl
  enableSaveCall : Boolean
[read-only] A bindable variable that can toggle visual element if you have any unsaved Calls in your precall.
PreCallControl
  messageClearBookmark : String = "{1} bookmark slides have been cleared."
Message that is displayed when the clearCurrentBookmark method is called.
PreCallControl
  messageClearBookmarkError : String = "{1} is not editable."
Message that is displayed when the clearCurrentBookmakr method is called and the current bookmark is not editable.
PreCallControl
  messageClearCall : String = "{1} call slides have been cleared."
Message that is displayed when the clearCurrentCall method is called.
PreCallControl
  messageClearCallError : String = "{1} is not editable."
Message that is displayed when the clearCurrentCall method is called and the current call is not editable.
PreCallControl
  messageQuickStart : String = "{1} is now set to Quick Start."
Message that is displayed when the saveCurrentCallAsQuickstart method is called.
PreCallControl
  messageRenameCall : String = "Please supply a new abbreviated title for this call."
Message that is displayed when renameCall method is called and there are no changes to be saved.
PreCallControl
  messageReset : String = "Your data has been reset to the last saved version."
Message that is displayed when the resetPrecall method is called.
PreCallControl
  messageSaveAll : String = "Your have unsaved changes. Do you wish to save changes?"
Message that is displayed wher there are unsaved Calls and Bookmarks.
PreCallControl
  messageSaveBookmarks : String = "Your Bookmarks contain unsaved changes. Do you wish to save changes?"
Message that is displayed when there are unsaved changes to Bookmarks
PreCallControl
  messageSaveCalls : String = "Your Calls contain unsaved changes. Do you wish to save changes?"
Message that is displayed when there are unsaved changes to your Calls.
PreCallControl
  messageSaveNone : String = "No changes have been made."
Message that is displayed when saveAll method is called and there are no changes to be saved.
PreCallControl
  precallModule : PreCallBase
[write-only]
PreCallControl
Public Methods
 MethodDefined by
  
Constructor()
PreCallControl
  
clearCurrentBookmark(displayAlert:Boolean = true):Alert
Removes the bookmark slides for the currently selected call.
PreCallControl
  
clearCurrentCall(displayAlert:Boolean = true):Alert
Removes the slides for the currently selected call leaving only must haves if any exist.
PreCallControl
  
clearCurrentCallAndBookmark(displayAlert:Boolean = true):void
Removes both the call slides and bookmark slides for the currently selected call.
PreCallControl
  
exitPrecall(displayAlert:Boolean = true):Alert
Prepares to exit precall module.
PreCallControl
  
renameCurrentCall(newName:String = null):OverlayWindow
Displays an OverlayWindow to allow the user to rename the abbreviated title of the currently selected call.
PreCallControl
  
resetPrecall(displayAlert:Boolean = true):Alert
This function will discard any changes made since the database has last been saved and restore the data back to its last saved version.
PreCallControl
  
saveAll(displayAlert:Boolean = true):Alert
Saves the calls and bookmarks for the currently selected indication.
PreCallControl
  
saveBookmarks(displayAlert:Boolean = true):Alert
Saves the bookmarks for the currently selected indication.
PreCallControl
  
saveCalls(displayAlert:Boolean = true):Alert
Saves the calls for the currently selected indication.
PreCallControl
  
saveCurrentCallAsQuickstart(displayAlert:Boolean = true):void
Set the currently selected call to the QuickStart Call.
PreCallControl
  
startCall(displayAlert:Boolean = true):Alert
Prepares to exit precall module and start a call.
PreCallControl
Events
 EventSummaryDefined by
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
    PreCallControl
Property detail
_clearAllDisplayAlertproperty
eve_internal var _clearAllDisplayAlert:Boolean = true

private

debugModeproperty 
public static var debugMode:Boolean = true
enableSaveAllproperty 
enableSaveAll:Boolean  [read-only]

A bindable variable that can toggle visual element if you have any unsaved changes in your precall.

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

Implementation
    public function get enableSaveAll():Boolean
enableSaveBookmarkproperty 
enableSaveBookmark:Boolean  [read-only]

A bindable variable that can toggle visual element if you have any unsaved Bookmarks in your precall.

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

Implementation
    public function get enableSaveBookmark():Boolean
enableSaveCallproperty 
enableSaveCall:Boolean  [read-only]

A bindable variable that can toggle visual element if you have any unsaved Calls in your precall.

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

Implementation
    public function get enableSaveCall():Boolean
_exitDisplayAlertproperty 
eve_internal var _exitDisplayAlert:Boolean = true

private

messageClearBookmarkproperty 
public var messageClearBookmark:String = "{1} bookmark slides have been cleared."

Message that is displayed when the clearCurrentBookmark method is called. If you include {1} in your message it will be replaced with the current call title.

messageClearBookmarkErrorproperty 
public var messageClearBookmarkError:String = "{1} is not editable."

Message that is displayed when the clearCurrentBookmakr method is called and the current bookmark is not editable. If you include {1} in your message it will be replaced with the current call title.

messageClearCallproperty 
public var messageClearCall:String = "{1} call slides have been cleared."

Message that is displayed when the clearCurrentCall method is called. If you include {1} in your message it will be replaced with the current call title.

messageClearCallErrorproperty 
public var messageClearCallError:String = "{1} is not editable."

Message that is displayed when the clearCurrentCall method is called and the current call is not editable. If you include {1} in your message it will be replaced with the current call title.

messageQuickStartproperty 
public var messageQuickStart:String = "{1} is now set to Quick Start."

Message that is displayed when the saveCurrentCallAsQuickstart method is called. If you include {1} in your message it will be replaced with the current call title.

messageRenameCallproperty 
public var messageRenameCall:String = "Please supply a new abbreviated title for this call."

Message that is displayed when renameCall method is called and there are no changes to be saved.

messageResetproperty 
public var messageReset:String = "Your data has been reset to the last saved version."

Message that is displayed when the resetPrecall method is called.

messageSaveAllproperty 
public var messageSaveAll:String = "Your have unsaved changes. Do you wish to save changes?"

Message that is displayed wher there are unsaved Calls and Bookmarks.

messageSaveBookmarksproperty 
public var messageSaveBookmarks:String = "Your Bookmarks contain unsaved changes. Do you wish to save changes?"

Message that is displayed when there are unsaved changes to Bookmarks

messageSaveCallsproperty 
public var messageSaveCalls:String = "Your Calls contain unsaved changes. Do you wish to save changes?"

Message that is displayed when there are unsaved changes to your Calls.

messageSaveNoneproperty 
public var messageSaveNone:String = "No changes have been made."

Message that is displayed when saveAll method is called and there are no changes to be saved.

precallModuleproperty 
precallModule:PreCallBase  [write-only]Implementation
    public function set precallModule(value:PreCallBase):void
renameCancelButtonproperty 
eve_internal var renameCancelButton:Button = null

private

renameOKButtonproperty 
eve_internal var renameOKButton:Button = null

private

renameOverlayproperty 
eve_internal var renameOverlay:OverlayWindow = null

private

renameTxtInputproperty 
eve_internal var renameTxtInput:TextInput = null

private

_startCallDisplayAlertproperty 
eve_internal var _startCallDisplayAlert:Boolean = true

private

Constructor detail
PreCallControl()constructor
public function PreCallControl()

Constructor()

Method detail
clearBookmarkComplete()method
eve_internal function clearBookmarkComplete(e:Event):void

private

Parameters
e:Event
clearCallComplete()method 
eve_internal function clearCallComplete(e:Event):void

private

Parameters
e:Event
clearCurrentBookmark()method 
public function clearCurrentBookmark(displayAlert:Boolean = true):Alert

Removes the bookmark slides for the currently selected call.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.

Returns
Alert
clearCurrentCall()method 
public function clearCurrentCall(displayAlert:Boolean = true):Alert

Removes the slides for the currently selected call leaving only must haves if any exist.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.

Returns
Alert
clearCurrentCallAndBookmark()method 
public function clearCurrentCallAndBookmark(displayAlert:Boolean = true):void

Removes both the call slides and bookmark slides for the currently selected call.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.
exitPrecall()method 
public function exitPrecall(displayAlert:Boolean = true):Alert

Prepares to exit precall module. If there are any unsaved calls or bookmarks the saving functions will be executed.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.

Returns
Alert
exitPrecallCompleteHandler()method 
eve_internal function exitPrecallCompleteHandler(e:Event = null):void

private

Parameters
e:Event (default = null)
renameCurrentCall()method 
public function renameCurrentCall(newName:String = null):OverlayWindow

Displays an OverlayWindow to allow the user to rename the abbreviated title of the currently selected call.

Parameters
newName:String (default = null) — If true, will show a default alert.

Returns
OverlayWindowOverlayWindow
renameCurrentCallCancelHandler()method 
eve_internal function renameCurrentCallCancelHandler(e:MouseEvent):void

private

Parameters
e:MouseEvent
renameCurrentCallCleanup()method 
eve_internal function renameCurrentCallCleanup():void

private

renameCurrentCallComplete()method 
eve_internal function renameCurrentCallComplete(e:Event = null):void

private

Parameters
e:Event (default = null)
renameCurrentCallOKClickHandler()method 
eve_internal function renameCurrentCallOKClickHandler(e:MouseEvent):void

private

Parameters
e:MouseEvent
renameTextInputHandler()method 
eve_internal function renameTextInputHandler(e:Event):void

private

Parameters
e:Event
resetPrecall()method 
public function resetPrecall(displayAlert:Boolean = true):Alert

This function will discard any changes made since the database has last been saved and restore the data back to its last saved version.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.

Returns
Alert
saveAll()method 
public function saveAll(displayAlert:Boolean = true):Alert

Saves the calls and bookmarks for the currently selected indication. If no changes have been made you will not be prompted to save.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.

Returns
Alert
saveAllBookmarks()method 
eve_internal function saveAllBookmarks():void

private

saveAllBookmarksCompleteHandler()method 
eve_internal function saveAllBookmarksCompleteHandler(e:Event = null):void

private

Parameters
e:Event (default = null)
saveAllCalls()method 
eve_internal function saveAllCalls():void

private

saveAllCallsCompleteHandler()method 
eve_internal function saveAllCallsCompleteHandler(e:Event = null):void

private

Parameters
e:Event (default = null)
saveAllHandler()method 
eve_internal function saveAllHandler(e:CloseEvent):void

private

Parameters
e:CloseEvent
saveBookmarks()method 
public function saveBookmarks(displayAlert:Boolean = true):Alert

Saves the bookmarks for the currently selected indication. If no changes have been made you will not be prompted to save.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.

Returns
Alert
saveBookmarksCompleteHandler()method 
eve_internal function saveBookmarksCompleteHandler(e:Event = null):void

private

Parameters
e:Event (default = null)
saveBookmarksHandler()method 
eve_internal function saveBookmarksHandler(e:CloseEvent):void

private

Parameters
e:CloseEvent
saveCalls()method 
public function saveCalls(displayAlert:Boolean = true):Alert

Saves the calls for the currently selected indication. If no changes have been made you will not be prompted to save.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.

Returns
Alert
saveCallsCompleteHandler()method 
eve_internal function saveCallsCompleteHandler(e:Event = null):void

private

Parameters
e:Event (default = null)
saveCallsHandler()method 
eve_internal function saveCallsHandler(e:CloseEvent):void

private

Parameters
e:CloseEvent
saveCurrentCallAsQuickstart()method 
public function saveCurrentCallAsQuickstart(displayAlert:Boolean = true):void

Set the currently selected call to the QuickStart Call.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.
startCall()method 
public function startCall(displayAlert:Boolean = true):Alert

Prepares to exit precall module and start a call. If there are any unsaved calls or bookmarks the saving functions will be executed.

Parameters
displayAlert:Boolean (default = true) — If true, will show a default alert.

Returns
Alert
startCallCompleteHandler()method 
eve_internal function startCallCompleteHandler(e:Event = null):void

private

Parameters
e:Event (default = null)
Event detail
bookmarksNotSavedevent 
Event object type: at.events.PreCallControlEvent

callRenamedCompleteevent  
Event object type: at.events.PreCallControlEvent

callsNotSavedevent  
Event object type: at.events.PreCallControlEvent

cancelCompleteevent  
Event object type: at.events.PreCallControlEvent

clearAllCompleteevent  
Event object type: at.events.PreCallControlEvent

clearBookmarkCompleteevent  
Event object type: at.events.PreCallControlEvent

clearCallCompleteevent  
Event object type: at.events.PreCallControlEvent

exitCompleteevent  
Event object type: at.events.PreCallControlEvent

resetCompleteevent  
Event object type: at.events.PreCallControlEvent

saveAllCompleteevent  
Event object type: at.events.PreCallControlEvent

saveBookmarksCompleteevent  
Event object type: at.events.PreCallControlEvent

saveCallsCompleteevent  
Event object type: at.events.PreCallControlEvent

saveQuickstartCompleteevent  
Event object type: at.events.PreCallControlEvent

startCallCompleteevent  
Event object type: at.events.PreCallControlEvent