Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
xp.controls

class CommonDialogs

Object
  |
  +--xp.controls.CommonDialogs

Implemented Interfaces: ICommonDialogs
class CommonDialogs
extends Object

Common application dialogs


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com

Field Summary

public static
dialogs: CommonDialogs
The class singleton

Constructor

public
CommonDialogs ( )
Constructor - This should not be called directly.


Method Summary

public
alert ( message: String, title: String, listener: Object )
Displays a Alert dialog box with a message.

public
confirm ( message: String, title: String, listener: Object )
Display a confirm dialog box with OK and Cancel buttons.

public
prompt ( message: String, title: String, icon: String, prompt: String, listener: Object )
Displays a prompt dialog box with a text field for entering a value.

public
showAbout ( title: String, version: String, copyright: String, logo: String )
Displays the standard application about dialog

public
showLoader ( message: String, title: String, loader: Object, indeterminate: Boolean, listener: Object )
Displays the standard progress loader dialog

public
showMessage ( message: String, title: String, icon: String, btns: Number, listener: Object )
Displays the standard message dialog

public
showWait ( message: String, title: String, listener: Object )
Displays the standard wait dialog


Field Documentation

dialogs

public static var dialogs: CommonDialogs
The class singleton

Constructor Documentation

CommonDialogs

public function CommonDialogs()
Constructor - This should not be called directly.

This class is automatically instantiated and generally should be accessed via the Application object

Method Documentation

alert

public function alert(message: String,
 title: String,
 listener: Object)
Displays a Alert dialog box with a message.

Specified by:
alert in interface xp.system.ICommonDialogs

Parameters:
message
The message to display
title
The dialog caption
listener
A listener object tolisten for events raised by the dialog

confirm

public function confirm(message: String,
 title: String,
 listener: Object)
Display a confirm dialog box with OK and Cancel buttons.

Specified by:
confirm in interface xp.system.ICommonDialogs

Parameters:
message
The message to display
title
The dialog caption
listener
A listener object tolisten for events raised by the dialog

prompt

public function prompt(message: String,
 title: String,
 icon: String,
 prompt: String,
 listener: Object)
Displays a prompt dialog box with a text field for entering a value.

Specified by:
prompt in interface xp.system.ICommonDialogs

Parameters:
message
The message to display
title
The dialog caption
icon
The icon to display
prompt
The initial text to display in the prompt TextInput control
listener
A listener object tolisten for events raised by the dialog

showAbout

public function showAbout(title: String,
 version: String,
 copyright: String,
 logo: String)
Displays the standard application about dialog

Specified by:
showAbout in interface xp.system.ICommonDialogs

Parameters:
title
dialog box caption
version
version info to display in the dialog
copyright
copyright text to display in the dialog
logo
linkageId of logog to display in the about box

showLoader

public function showLoader(message: String,
 title: String,
 loader: Object,
 indeterminate: Boolean,
 listener: Object)
Displays the standard progress loader dialog

Specified by:
showLoader in interface xp.system.ICommonDialogs

Parameters:
message
The message to display
title
The dialog caption
loader
The icon to display
indeterminate
Controls whether the progress bar is indeterminate or not
listener
A listener object tolisten for events raised by the dialog

showMessage

public function showMessage(message: String,
 title: String,
 icon: String,
 btns: Number,
 listener: Object)
Displays the standard message dialog

Specified by:
showMessage in interface xp.system.ICommonDialogs

Parameters:
message
The message to display
title
The dialog caption
icon
The icon to display
btns
Controls which buttons to display
listener
A listener object tolisten for events raised by the dialog

showWait

public function showWait(message: String,
 title: String,
 listener: Object)
Displays the standard wait dialog

Specified by:
showWait in interface xp.system.ICommonDialogs

Parameters:
message
The message to display
title
The dialog caption
listener
A listener object to listen for events raised by the dialog

The documentation was generated from the following file:

Generated on 10/30/2005 9:34:02 PM by AS2Doc