qnx.fuse.ui.core.DeleteAction

DeleteAction

Properties | Methods | Events


Packageqnx.fuse.ui.core
Classpublic class DeleteAction
InheritanceDeleteAction Inheritance ActionBase Inheritance flash.events.EventDispatcher

DeleteAction are Actions used for Delete or Removal functionality in the Context Menu. A DeleteAction will appear at the very bottom of the Context Menu. Only one DeleteAction can be on the Context Menu at a time.

Class information:
BlackBerry 10 Version:   10.0.0



Public Properties

 PropertyDefined By
  actionBarPlacement : String
A placement option for the action when it is displayed in an ActionBar.
DeleteAction
 Inheriteddata : Object
The data associated with the action.
ActionBase
 Inheritedenabled : Boolean
Enables or disables the Action.
ActionBase
 Inheritedicon : Object
An optional icon that is shown next to the label text.
ActionBase
 InheritedkeyboardShortcut : Array
An array of keys that can be pressed to trigger this action.
ActionBase
 Inheritedlabel : String
The text that appears when this action is displayed in a UI component.
ActionBase

Public Methods

 MethodDefined By
  
DeleteAction(label:String = null, icon:Object = null, data:Object = null, actionBarPlacement:String = default, keyboardShortcut:Array = null)
Creates a new DeleteAction instance.
DeleteAction

Events

 Event Summary Defined By
 InheritedDispatched when one of the properties on the Action is modified.ActionBase

Property Detail

actionBarPlacement


actionBarPlacement:String

A placement option for the action when it is displayed in an ActionBar. This value shold be one of the options in the ActionBarPlacement class.


Implementation

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

Constructor Detail

DeleteAction()


public function DeleteAction(label:String = null, icon:Object = null, data:Object = null, actionBarPlacement:String = default, keyboardShortcut:Array = null)

Creates a new DeleteAction instance.

Parameters

label:String (default = null) — A label for the DeleteAction to be shown whenever an Action is shown in components like the ActionBar or CrossCut menu. If none is provided, a default one will be provided in the user's chosen language.
icon:Object (default = null) — A String as a URL to an external image, a Bitmap instance, or a BitmapData instance. If none is provided a default delete icon will be used.
data:Object (default = null) — Data to be associated with the DeleteAction. Use this parameter to maintain useful data associated with the Action.
actionBarPlacement:String (default = default) — Placement option for the action when it is displayed in an ActionBar. Should be one of the options in the ActionBarPlacement class.
keyboardShortcut:Array (default = null) — An array of keys that can be pressed to trigger this action. Valid keys can be found in the flash.ui.Keyboard class. If no shortcut is provided, a default of Keyboard.BACKSPACE is used.





comments powered by Disqus