qnx.fuse.ui.dialog.ToastBase

ToastBase

Properties | Methods | Events


Packageqnx.fuse.ui.dialog
Classpublic class ToastBase
InheritanceToastBase Inheritance DialogBase Inheritance qnx.fuse.ui.window.WindowedComponent
Subclasses IconToast



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
 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
 InheritedisBusy : Boolean
Determines whether the dialog should allow the activity indicator to the user or not.
DialogBase
  message : String
The message text for the toast.
ToastBase
  messageHasEmoticons : Boolean
[write-only] Indicates whether the message text has emoticons or not.
ToastBase
  position : String
The position of the toast on screen.
ToastBase
 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
 Inheritedcontent : Container
The container for the dialog content area
DialogBase
  cssID : String
[override] [read-only] Returns the CSS ID of the component.
ToastBase
 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
 InheritedmasterContent : Container
The container for the master content area
DialogBase
  selectableContentFocus : Boolean
[override] [write-only]
ToastBase
 InheritedtitleHTML : String
DialogBase

Public Methods

 MethodDefined By
  
ToastBase
 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
  
destroy():void
[override] Call this method when you want to have your object collected by the garbage collector.
ToastBase
 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
  
show():void
[override] Shows the dialog on the screen.
ToastBase
 Inherited
update():void
[override] Updates the on-screen dialog to reflect its current attributes.
DialogBase
 Inherited
[override]
DialogBase

Protected Methods

 MethodDefined By
 Inherited
This function is called whenever the textInputOptions have changed for the dialog.
DialogBase
  
createButton(position:String):LabelButton
[override] Called to create a dialog button (must be derived from LabelButton)
ToastBase
  
createContent(container:Container):void
[override] Called to create the content area
ToastBase
  
createDialog(container:Container):void
[override] Called to create the dialog area
ToastBase
  
createFooter(container:Container):void
[override] Called to create the footer area
ToastBase
  
createHeader(container:Container):void
[override] Called to populate the header area
ToastBase
  
[override] Called to create the content area
ToastBase
 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
  
init():void
[override]
ToastBase
  
updateSize():void
[override]
ToastBase

Events

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

Protected Constants

 ConstantDefined By
 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

cssID


cssID:String  [read-only]
[override]

Returns the CSS ID of the component. The CSS ID is used for identifying the type of component in CSS.

The default value is Toast.


Implementation

protected function get cssID():String

message


message:String

The message text for the toast.


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

position


position:String

The position of the toast on screen.


Implementation

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

See also

ToastPosition

selectableContentFocus


selectableContentFocus:Boolean  [write-only]
[override]


Implementation

protected function set selectableContentFocus(value:Boolean):void

Constructor Detail

ToastBase()


public function ToastBase()



Method Detail

applyDataUpdates()


override qnx_internal function applyDataUpdates(data:Object, changed:Object, translate:Function):void

Parameters

data:Object
changed:Object
translate:Function

createButton()


override protected function createButton(position:String):LabelButton

Called to create a dialog button (must be derived from LabelButton)

Parameters

position:String

Returns

LabelButton

createContent()


override protected function createContent(container:Container):void

Called to create the content area

Parameters

container:Container

createDialog()


override protected function createDialog(container:Container):void

Called to create the dialog area

Parameters

container:Container

createFooter()


override protected function createFooter(container:Container):void

Called to create the footer area

Parameters

container:Container

createHeader()


override protected function createHeader(container:Container):void

Called to populate the header area

Parameters

container:Container

createMasterContent()


override protected function createMasterContent(container:Container):void

Called to create the content area

Parameters

container:Container

destroy()


override public function destroy():void

Call this method when you want to have your object collected by the garbage collector.

NOTE: This method does not remove the object from memory. Instead, it enables your instance to clean up after itself internally so that it can be garbage-collected.

init()


override protected function init():void

show()


override public function show():void

Shows the dialog on the screen.

updateSize()


override protected function updateSize():void





comments powered by Disqus