Packagecom.vmware.actionsfw.model
Classpublic class ActionPriorityGroup
InheritanceActionPriorityGroup Inheritance PriorityGroup Inheritance Object

Lists actions to prioritize in the UI.

Use extension point vmware.prioritization.actions to prioritize actions for particular object types. Use extension point vmware.prioritization.listActions to prioritize context-less or global actions for a particular list. These are actions that appear to the left of the action bar separator and can be invoked even when nothing is selected in the list.

prioritizedIds

Specify actions by their ActionSpec.uid in the order they should appear in the UI.

regionId

Leave the regionId as null in order to specify default prioritized actions for a particular object type. Default prioritized actions will appear at the top of object menus and in object list action bars, unless the defaults have been overriden by another priority group for a particular regionId. Note that it is only possible to define default actions for an object type within the same plugin package that the object type is defined (via a vsphere.core.objectTypes extension). It is not possible to alter the default actions for types defined in other packages.

View the examples



Public Properties
 PropertyDefined By
  actionTargetTypes : Array
List of object types for which this priority group should apply.
ActionPriorityGroup
 InheritedprioritizedIds : Array
List of component ids to prioritize.
PriorityGroup
 InheritedregionId : String
Identifies the region of the UI to associate with this priority group.
PriorityGroup
Property Detail
actionTargetTypesproperty
public var actionTargetTypes:Array

List of object types for which this priority group should apply.

Note that in order for the prioritized actions to show, the types listed here must be types that the actions may be invoked on.

May be null if the actions are "global" (are not invoked on an object).

Examples
The following code might appear in a plugin manifest file to declare default action for a type samples:Chassis. For type samples:Chassis, com.vmware.samples.chassis.editChassis and com.vmware.samples.chassis.deleteChassis are the default actions.
 
 <extension id="com.vmware.sample.chassis.defaultactions">
    <extendedPoint>vmware.prioritization.actions</extendedPoint>
    <object>
       <prioritizedIds>
          <String>com.vmware.samples.chassis.editChassis</String>
          <String>com.vmware.samples.chassis.deleteChassis</String>
       </prioritizedIds>
    </object>
    <actionTargetTypes>
       <String>samples:Chassis</String>
    </actionTargetTypes>
 </extension>
 
 
The following code might appear in a plugin manifest file for defining prioritized actions for the list com.vmware.samples.chassis.list. The actions com.vmware.samples.chassis.moveVm and com.vmware.samples.chassis.powerOffVm are shown on the list's action bar when a samples:Chassis is selected in the list, rather than the default samples:Chassis actions defined in the first example.
 
 
 <extension id="com.vmware.sample.chassis.prioritizedActions">
    <extendedPoint>vmware.prioritization.actions</extendedPoint>
    <object>
       <prioritizedIds>
          <String>com.vmware.samples.chassis.moveVm</String>
          <String>com.vmware.samples.chassis.powerOffVm</String>
       </prioritizedIds>
    </object>
    <regionId>com.vmware.samples.chassis.list</regionId>
    <actionTargetTypes>
        <String>samples:Chassis</String>
    </actionTargetTypes>
 </extension>
 
 
The following promotes the context-less or global action com.vmware.samples.chassis.createChassis to the action bar of the list com.vmware.samples.chassis.list. The action will appear to the left of the action bar separator and can be invoked even when nothing is selected in the list.
 
  <extension id="com.vmware.sample.chassis.listAction">
      <extendedPoint>vmware.prioritization.listActions</extendedPoint>
      <object>
         <prioritizedIds>
            <String>com.vmware.samples.chassis.createChassis</String>
         </prioritizedIds>
      </object>
      <regionId>com.vmware.samples.chassis.list</regionId>
  </extension>