qnx.fuse.ui.core.ActionSet

ActionSet

Properties | Methods


Packageqnx.fuse.ui.core
Classpublic class ActionSet
InheritanceActionSet Inheritance Object

ActionSets hold ActionBase objects that will be shown in the context menu.

Provide ActionSets to UIComponents via the contextActions property. When the user invokes the action required to open a context menu on a control (typically a long press) a context menu will be invoked to display these actions

Actions added to the actions vector after the context menu has been opened will not be shown until the next time the ActionSet is shown in a context menu.

The image below is an example of a cross cut menu opened using an ActionSet of 3 Actions and one DeleteAction.

A cross cut menu



Class information:
BlackBerry 10 Version:   10.0.0

See also

qnx.fuse.ui.core.UIComponent



Public Properties

 PropertyDefined By
  actions : Vector.<ActionBase>
A vector of context ActionBase objects that will be shown in the context menu.
ActionSet
  deleteAction : DeleteAction
A DeleteAction instance that should be displayed at the bottom of the context menu.
ActionSet
  multiSelectAction : MultiSelectAction
A MultiSelectAction instance that should be the last action displayed before the DeleteAction if it exists.
ActionSet
  subtitle : String
The subtitle to be shown in the Context Menu
ActionSet
  title : String
The title to be shown in the Context Menu
ActionSet

Public Methods

 MethodDefined By
  
ActionSet(actions:Vector.<ActionBase> = null, title:String = null, subtitle:String = null, deleteAction:DeleteAction = null, multiSelectAction:MultiSelectAction = null)
Creates a new ActionSet instance.
ActionSet

Property Detail

actions


public var actions:Vector.<ActionBase>

A vector of context ActionBase objects that will be shown in the context menu.

deleteAction


public var deleteAction:DeleteAction

A DeleteAction instance that should be displayed at the bottom of the context menu. Should be used for Delete or Remove type tasks.

multiSelectAction


public var multiSelectAction:MultiSelectAction

A MultiSelectAction instance that should be the last action displayed before the DeleteAction if it exists.

subtitle


public var subtitle:String

The subtitle to be shown in the Context Menu

title


public var title:String

The title to be shown in the Context Menu

Constructor Detail

ActionSet()


public function ActionSet(actions:Vector.<ActionBase> = null, title:String = null, subtitle:String = null, deleteAction:DeleteAction = null, multiSelectAction:MultiSelectAction = null)

Creates a new ActionSet instance.

Parameters

actions:Vector.<ActionBase> (default = null) — A Vector of actions. All actions should be added to the actions array at the time the ActionSet is created.
title:String (default = null) — A optional String to be shown in the title bar of a context menu.
subtitle:String (default = null) — An optional String to be shown in the title bar of a context menu, underneath the title.
deleteAction:DeleteAction (default = null) — An optional DeleteAction to be shown in the context menu. DeleteActions are always placed at the bottom of the context menu.
multiSelectAction:MultiSelectAction (default = null) — An optional MultiSelectAction to be shown in the context menu. MultiSelectActions are always after all the actions in the actions vector.





comments powered by Disqus