qnx.fuse.ui.dialog.AlertDialog

AlertDialog

Properties | Methods | Events | Constants


Packageqnx.fuse.ui.dialog
Classpublic class AlertDialog
InheritanceAlertDialog Inheritance DialogBase Inheritance qnx.fuse.ui.window.WindowedComponent
Subclasses ListDialog, LoginDialog, PromptDialog

The AlertDialog class consists of a label to display information in as many lines as necessary.

Class information:
BlackBerry 10 Version:   10.0.0



Public Properties

 PropertyDefined By
 InheritedallowEmptyResponse : Boolean
Determines whether the dialog enables the default button when input fields are empty or not.
DialogBase
 InheritedbuttonCount : int
[read-only] Read-only property reflecting the number of buttons in the dialog.
DialogBase
 InheritedbuttonLimit : int
Sets the limit for the number of buttons that can appear in the footer on the dialog.
DialogBase
 InheritedcancelRequired : Boolean
DialogBase
  checkboxLabel : String
The text for the checkbox label on the dialog.
AlertDialog
 InheritedcontentSelectable : Boolean
Gets or Sets flag indicating the main content container is selectable.
DialogBase
 InheriteddefaultButtonIndex : int
Gets or sets the default button index value used to determine what button to automatically select in the event that the user hits the return key.
DialogBase
  icon : String
Sets the icon based on absolute path
AlertDialog
 InheritedisBusy : Boolean
Determines whether the dialog should allow the activity indicator to the user or not.
DialogBase
  message : String
Sets the message text for the dialog.
AlertDialog
  messageHasEmoticons : Boolean
[write-only] Indicates whether the message text has emoticons or not.
AlertDialog
 InheritedreturnKeyType : String
Sets the return key type for input fields on the dialog.
DialogBase
 InheritedselectedIndex : int
[read-only] Read-only property which defines the index of the button selected to close the dialog, or -1 of no button was selected.
DialogBase
 InheritedtextInputOptions : int
Sets the text input options for input fields on the dialog.
DialogBase
 Inheritedtitle : String
Sets the text for the dialog title.
DialogBase

Protected Properties

 PropertyDefined By
  checkbox : CheckBox
AlertDialog
  checkboxContainer : Container
The always show this message (or whatever) checkbox.
AlertDialog
 Inheritedcontent : Container
The container for the dialog content area
DialogBase
 InheritedcssID : String
[override] [read-only] Returns the CSS ID of the component.
DialogBase
 InheriteddialogContainer : Container
The outer-most container for the dialog
DialogBase
 Inheritedfooter : Container
The container for the dialog footer area
DialogBase
 Inheritedheader : Container
The container for the dialog header area
DialogBase
  iconAndMessageLabelContainer : Container
AlertDialog
  iconImage : Image
The icon.
AlertDialog
  iconPath : String
AlertDialog
 InheritedmasterContent : Container
The container for the master content area
DialogBase
  messageHTML : String
AlertDialog
  messageLabel : Label
The message Label.
AlertDialog
 InheritedtitleHTML : String
DialogBase

Public Methods

 MethodDefined By
  
Constructor for the AlertDialog class.
AlertDialog
 Inherited
addButton(label:String):int
Adds a button to the dialog.
DialogBase
 Inherited
cancel():void
[override] Cancels the on-screen dialog.
DialogBase
 Inherited
[override] Called by the WindowManager class to request that the window control object immediately cancel the window.
DialogBase
 Inherited
getButtonPropertyAt(prop:String, index:int):Object
Gets the value of a property, given the property name and property object index.
DialogBase
 Inherited
getItemAt(index:int):Object
Returns the button at the given index, or null if the index is out of range.
DialogBase
 Inherited
onTransition(state:String):void
[override]
DialogBase
 Inherited
removeButtonAt(index:int):void
Removes the button from the dialog at the specified index.
DialogBase
 Inherited
setButtonPropertyAt(prop:String, value:Object, index:int):void
Sets a button property given a property name, a property value, and the index of a button property object.
DialogBase
 Inherited
show():void
[override] Shows the dialog on the screen.
DialogBase
 Inherited
update():void
[override] Updates the on-screen dialog to reflect its current attributes.
DialogBase
 Inherited
[override]
DialogBase

Protected Methods

 MethodDefined By
  
applyLocaleUpdates(data:Object, translate:Function):void
[override]
AlertDialog
 Inherited
This function is called whenever the textInputOptions have changed for the dialog.
DialogBase
 Inherited
createButton(position:String):LabelButton
Called to create a dialog button (must be derived from LabelButton)
DialogBase
  
createContent(container:Container):void
[override] Called to create the content area
AlertDialog
 Inherited
createDialog(container:Container):void
Called to create the dialog area
DialogBase
 Inherited
createFooter(container:Container):void
Called to create the footer area
DialogBase
 Inherited
createHeader(container:Container):void
Called to populate the header area
DialogBase
  
createIcon():void
AlertDialog
 Inherited
Called to create the content area
DialogBase
 Inherited
Called to create the button content area
DialogBase
 Inherited
Ensures the given component is properly destroyed.
DialogBase
 Inherited
The disableActionButton method disables the action button if there is more than one button, if it is not currently disabled and if defaultButtonIndex is set.
DialogBase
 Inherited
The enableActionButton method enables the action button if it was disabled.
DialogBase
  
onIconLoaded(e:Event):void
AlertDialog
  
onIconLoadFailed(e:IOErrorEvent):void
AlertDialog
  
removeIcon():void
AlertDialog

Events

 Event Summary Defined By
 InheritedDispatched when a button in the dialog has been clicked.DialogBase

Protected Constants

 ConstantDefined By
  CHECKBOX_CHECKED : String = checkboxChecked
[static]
AlertDialog
  CHECKBOX_ENABLED : String = checkboxEnabled
[static]
AlertDialog
  CHECKBOX_LABEL : String = checkboxLabel
[static]
AlertDialog
 InheritedCONTENT_SELECTED_INDEX : int = -2
[static] Selected index assigned when selectable content is pressed
DialogBase
 InheritedDIALOG_CHECKBOX : String = dialogCheckBox
[static]
DialogBase
 InheritedID_ALIGN_RIGHT : String = dialogAlignRight
[static] Id tag assigned to labels or text fields that want to inherit CSS right alignment formatting.
DialogBase

Property Detail

checkbox


protected var checkbox:CheckBox

checkboxContainer


protected var checkboxContainer:Container

The always show this message (or whatever) checkbox.

checkboxLabel


checkboxLabel:String

The text for the checkbox label on the dialog. If not set, the checkbox will not be visible.


Implementation

public function get checkboxLabel():String
public function set checkboxLabel(value:String):void

icon


icon:String

Sets the icon based on absolute path


Implementation

public function get icon():String
public function set icon(value:String):void

iconAndMessageLabelContainer


protected var iconAndMessageLabelContainer:Container

iconImage


protected var iconImage:Image

The icon.

iconPath


protected var iconPath:String

message


message:String

Sets the message text for the dialog.


Implementation

public function get message():String
public function set message(value:String):void

messageHasEmoticons


messageHasEmoticons:Boolean  [write-only]

Indicates whether the message text has emoticons or not.

In order for the emoticons to render correctly, you must ensure that the emoticon graphics are included as part of your application. To do so simply create a variable with the type qnx.fuse.ui.text.Emoticons.

If the emoticon graphics cannot be found, the following trace state will appear. "Could not find emoticons. Did you import the qnx.fuse.ui.text.Emoticons class in your app?"


Implementation

public function set messageHasEmoticons(value:Boolean):void

messageHTML


messageHTML:String


Implementation

protected function get messageHTML():String
protected function set messageHTML(value:String):void

messageLabel


protected var messageLabel:Label

The message Label.

Constructor Detail

AlertDialog()


public function AlertDialog()

Constructor for the AlertDialog class.

Method Detail

applyLocaleUpdates()


override protected function applyLocaleUpdates(data:Object, translate:Function):void

Parameters

data:Object
translate:Function

createContent()


override protected function createContent(container:Container):void

Called to create the content area

Parameters

container:Container

createIcon()


protected function createIcon():void

onIconLoaded()


protected function onIconLoaded(e:Event):void

Parameters

e:Event

onIconLoadFailed()


protected function onIconLoadFailed(e:IOErrorEvent):void

Parameters

e:IOErrorEvent

removeIcon()


protected function removeIcon():void

Constant Detail

CHECKBOX_CHECKED


protected static const CHECKBOX_CHECKED:String = checkboxChecked

CHECKBOX_ENABLED


protected static const CHECKBOX_ENABLED:String = checkboxEnabled

CHECKBOX_LABEL


protected static const CHECKBOX_LABEL:String = checkboxLabel





comments powered by Disqus