qnx.fuse.ui.core.ActionBase

ActionBase

Properties | Methods | Events


Packageqnx.fuse.ui.core
Classpublic class ActionBase
InheritanceActionBase Inheritance flash.events.EventDispatcher
Subclasses Action, DeleteAction, InvokableAction, InvokeActionItem, MultiSelectAction, TabAction

ActionBase is the base class for Actions and TabActions.

ActionBase should never be instantiated directly, but is useful for generically handling either type of action.



Class information:
BlackBerry 10 Version:   10.0.0



Public Properties

 PropertyDefined By
  data : Object
The data associated with the action.
ActionBase
  enabled : Boolean
Enables or disables the Action.
ActionBase
  icon : Object
An optional icon that is shown next to the label text.
ActionBase
  keyboardShortcut : Array
An array of keys that can be pressed to trigger this action.
ActionBase
  label : String
The text that appears when this action is displayed in a UI component.
ActionBase

Public Methods

 MethodDefined By
  
ActionBase(label:String, icon:Object = null, data:Object = null, keyboardShortcut:Array = null)
ActionBase should not be instantiated directly.
ActionBase

Events

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

Property Detail

data


data:Object

The data associated with the action.

Use this to associate custom data with actions and retrieve it later when an action has been selected.


Implementation

public function get data():Object
public function set data(value:Object):void

enabled


enabled:Boolean

Enables or disables the Action. This changes its appeance and renders it unclickable when displayed in the ActionBar and CrossCut controls.


Implementation

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

icon


icon:Object

An optional icon that is shown next to the label text.

Either a String as a URL to an external image, a Bitmap instance, or a BitmapData instance.


Implementation

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

keyboardShortcut


keyboardShortcut:Array

An array of keys that can be pressed to trigger this action. Valid keys that can be used can be found in the flash.ui.Keyboard class. Note that if you change the contents of the keyboard shortcut array after creating the Action, you must re-assign the array to the action.


Implementation

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

label


label:String

The text that appears when this action is displayed in a UI component.


Implementation

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

Constructor Detail

ActionBase()


public function ActionBase(label:String, icon:Object = null, data:Object = null, keyboardShortcut:Array = null)

ActionBase should not be instantiated directly. Instead, use one of the classes that extend it such as Action or TabAction.

Parameters

label:String — A label for the ActionBasetion to be shown whenever an action is shown in components like the ActionBar or CrossCut menu.
icon:Object (default = null) — A String as a URL to an external image, a Bitmap instance, or a BitmapData instance.
data:Object (default = null) — Data to be associated with the Action. Use this parameter to maintain useful data associated with the Action.
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. This value is only used on platforms that feature a physical keyboard.

See also

Action
TabAction

Event Detail

change


Event Object Type: flash.events.Event
Event.type property = flash.events.Event.CHANGE

Dispatched when one of the properties on the Action is modified.





comments powered by Disqus