qnx.fuse.ui.dialog.ListDialog

ListDialog

Properties | Methods | Events


Packageqnx.fuse.ui.dialog
Classpublic class ListDialog
InheritanceListDialog Inheritance AlertDialog Inheritance DialogBase Inheritance qnx.fuse.ui.window.WindowedComponent



Class information:
BlackBerry 10 Version:   10.0.0



Public Properties

 PropertyDefined By
  allowDeselect : Boolean
Set allowDeselect to be on/off.
ListDialog
 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
  cancelOnSelection : Boolean
[write-only] Set cancelOnSelection to be on/off.
ListDialog
 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
 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
  items : Array
[write-only] Set the list items using array of strings
ListDialog
  list : Array
Set the list items using array of objects
ListDialog
  listDisabledIndices : Array
The list's disabled indices.
ListDialog
  listHeaderIndices : Array
The list's header indices.
ListDialog
  listSelectedIndex : int
The list's selected index.
ListDialog
  listSelectedIndices : Array
The list's selected indices.
ListDialog
  listSeparatorIndices : Array
The list's separator indices.
ListDialog
 Inheritedmessage : String
Sets the message text for the dialog.
AlertDialog
 InheritedmessageHasEmoticons : Boolean
[write-only] Indicates whether the message text has emoticons or not.
AlertDialog
  multiSelect : Boolean
Set multi-select to be on/off.
ListDialog
 InheritedreturnKeyType : String
Sets the return key type for input fields on the dialog.
DialogBase
  scrollToIndex : int
[write-only] Set scrollToIndex.
ListDialog
 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
  showBasicSelection : Boolean
Set the List to use the list default (CellRenderer) or the dialog default (ListDialogCellRenderer).
ListDialog
 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
  listCellRenderer : Class
[read-only] Returns the class of the cell renderer for the list.
ListDialog
 InheritedmasterContent : Container
The container for the master content area
DialogBase
 InheritedmessageHTML : String
AlertDialog
 InheritedmessageLabel : Label
The message Label.
AlertDialog
 InheritedtitleHTML : String
DialogBase

Public Methods

 MethodDefined By
  
ListDialog
 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
 Inherited
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
 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

allowDeselect


allowDeselect:Boolean

Set allowDeselect to be on/off.


Implementation

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

cancelOnSelection


cancelOnSelection:Boolean  [write-only]

Set cancelOnSelection to be on/off.


Implementation

public function set cancelOnSelection(value:Boolean):void

items


items:Array  [write-only]

Set the list items using array of strings


Implementation

public function set items(value:Array):void

list


list:Array

Set the list items using array of objects


Implementation

public function get list():Array
public function set list(value:Array):void

listCellRenderer


listCellRenderer:Class  [read-only]

Returns the class of the cell renderer for the list. p> ubclasses can override this method in order to provide a different renderer. /p>


Implementation

protected function get listCellRenderer():Class

listDisabledIndices


listDisabledIndices:Array

The list's disabled indices.


Implementation

public function get listDisabledIndices():Array
public function set listDisabledIndices(value:Array):void

listHeaderIndices


listHeaderIndices:Array

The list's header indices.


Implementation

public function get listHeaderIndices():Array
public function set listHeaderIndices(value:Array):void

listSelectedIndex


listSelectedIndex:int

The list's selected index.


Implementation

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

listSelectedIndices


listSelectedIndices:Array

The list's selected indices.


Implementation

public function get listSelectedIndices():Array
public function set listSelectedIndices(value:Array):void

listSeparatorIndices


listSeparatorIndices:Array

The list's separator indices.


Implementation

public function get listSeparatorIndices():Array
public function set listSeparatorIndices(value:Array):void

multiSelect


multiSelect:Boolean

Set multi-select to be on/off.


Implementation

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

scrollToIndex


scrollToIndex:int  [write-only]

Set scrollToIndex.


Implementation

public function set scrollToIndex(value:int):void

showBasicSelection


showBasicSelection:Boolean

Set the List to use the list default (CellRenderer) or the dialog default (ListDialogCellRenderer).


Implementation

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

Constructor Detail

ListDialog()


public function ListDialog()







comments powered by Disqus