qnx.fuse.ui.dialog.PromptDialog

PromptDialog

Properties | Methods | Events


Packageqnx.fuse.ui.dialog
Classpublic class PromptDialog
InheritancePromptDialog Inheritance AlertDialog Inheritance DialogBase Inheritance qnx.fuse.ui.window.WindowedComponent

The PromptDialog class consists of the inherited elements of the AlertDialog and a prompt TextInput.

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
 InheritedcheckboxLabel : 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
  displayAsPassword : Boolean
Sets the displayAsPassword option for the input field on the dialog.
PromptDialog
 Inheritedicon : 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
  keyboardType : String
Sets the keyboard type from SoftKeyboardType
PromptDialog
  maxChars : int
Sets the max chars that can be input into the prompt input field.
PromptDialog
 Inheritedmessage : String
Sets the message text for the dialog.
AlertDialog
 InheritedmessageHasEmoticons : Boolean
[write-only] Indicates whether the message text has emoticons or not.
AlertDialog
  prompt : String
Sets the prompt text for the input field on the dialog.
PromptDialog
 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
  text : String
Sets the text for the input field on the dialog.
PromptDialog
 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
 Inheritedcheckbox : CheckBox
AlertDialog
 InheritedcheckboxContainer : 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
 InheritediconAndMessageLabelContainer : Container
AlertDialog
 InheritediconImage : Image
The icon.
AlertDialog
 InheritediconPath : String
AlertDialog
 InheritedmasterContent : Container
The container for the master content area
DialogBase
 InheritedmessageHTML : String
AlertDialog
 InheritedmessageLabel : Label
The message Label.
AlertDialog
  promptInput : TextInput
The prompt TextInput field.
PromptDialog
 InheritedtitleHTML : String
DialogBase

Public Methods

 MethodDefined By
  
Constructor for the PromptDialog class.
PromptDialog
 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
 Inherited
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
PromptDialog
 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
 Inherited
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
 Inherited
onIconLoaded(e:Event):void
AlertDialog
 Inherited
onIconLoadFailed(e:IOErrorEvent):void
AlertDialog
 Inherited
removeIcon():void
AlertDialog

Events

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

Protected Constants

 ConstantDefined By
 InheritedCHECKBOX_CHECKED : String = checkboxChecked
[static]
AlertDialog
 InheritedCHECKBOX_ENABLED : String = checkboxEnabled
[static]
AlertDialog
 InheritedCHECKBOX_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

displayAsPassword


displayAsPassword:Boolean

Sets the displayAsPassword option for the input field on the dialog.


Implementation

public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void

keyboardType


keyboardType:String

Sets the keyboard type from SoftKeyboardType


Implementation

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

maxChars


maxChars:int

Sets the max chars that can be input into the prompt input field.


Implementation

public function get maxChars():int
public function set maxChars(value:int):void

prompt


prompt:String

Sets the prompt text for the input field on the dialog.


Implementation

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

promptInput


protected var promptInput:TextInput

The prompt TextInput field.

text


text:String

Sets the text for the input field on the dialog.


Implementation

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

Constructor Detail

PromptDialog()


public function PromptDialog()

Constructor for the PromptDialog class.

Method Detail

createContent()


override protected function createContent(container:Container):void

Called to create the content area

Parameters

container:Container





comments powered by Disqus