qnx.fuse.ui.core.Action

Action

Properties | Methods | Events


Packageqnx.fuse.ui.core
Classpublic class Action
InheritanceAction Inheritance ActionBase Inheritance flash.events.EventDispatcher

Actions represent tasks that can be performed within the current view. They be passed in to ActionBar components, or added to ActionSets and passed to UIComponents where a user can interact with them.

For navigation related tasks, use TabActions instead.



Class information:
BlackBerry 10 Version:   10.0.0

See also

TabAction
UIComponent.contextActions
qnx.fuse.ui.actionbar.ActionBar



Public Properties

 PropertyDefined By
  actionBarPlacement : String
A placement option for the action when it is displayed in an ActionBar.
Action
 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
  
Action(label:String, icon:Object = null, data:Object = null, actionBarPlacement:String = default, keyboardShortcut:Array = null)
Create a new Action.
Action
  
[override] Returns a new Action with identical values to this Action.
Action

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

See also

qnx.fuse.ui.actionbar.ActionPlacement

Constructor Detail

Action()


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

Create a new Action.

Parameters

label:String — A label for the Action 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.
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.

See also

ActionPlacement

Method Detail

clone()


override public function clone():ActionBase

Returns a new Action with identical values to this Action.

Returns

ActionBase — A cloned Action.




comments powered by Disqus