Packagecom.vmware.vsphere.client.views
Classpublic class ShortcutSpec
InheritanceShortcutSpec Inheritance Object
Implements mx.core.IUID, flash.events.IEventDispatcher

Contains the information for a home shortcut.

Specification class for vise.home.shortcuts extension point.

View the examples


Public Properties
 PropertyDefined By
  categoryUid : String
Category id under which the shortcut will be displayed.
ShortcutSpec
  icon : Class
An optional 32 by 32 shortcut icon.
ShortcutSpec
  name : String
The shortcut's user-visible name.
ShortcutSpec
  targetViewUid : String
Determines the extension to which to navigate to when the shortcut is clicked.
ShortcutSpec
  uid : String
Unique ID, usually a namespace-style string.
ShortcutSpec
Public Methods
 MethodDefined By
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
ShortcutSpec
  
dispatchEvent(event:Event):Boolean
ShortcutSpec
  
hasEventListener(type:String):Boolean
ShortcutSpec
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
ShortcutSpec
  
willTrigger(type:String):Boolean
ShortcutSpec
Property Detail
categoryUidproperty
categoryUid:String

Category id under which the shortcut will be displayed.

The supported categories are:

  • vsphere.core.controlcenter.inventoriesCategory (shortcut link will be added in the Inventories section of the Home view)
  • vsphere.core.controlcenter.monitoringCategory (shortcut link will be added in the Monitoring Tools section of the Home view)

    • This property can be used as the source for data binding.


    Implementation
        public function get categoryUid():String
        public function set categoryUid(value:String):void
    iconproperty 
    icon:Class

    An optional 32 by 32 shortcut icon.

    A default icon will be used if no icon is provided.

    This property can be used as the source for data binding.


    Implementation
        public function get icon():Class
        public function set icon(value:Class):void
    nameproperty 
    name:String

    The shortcut's user-visible name.

    This property can be used as the source for data binding.


    Implementation
        public function get name():String
        public function set name(value:String):void
    targetViewUidproperty 
    targetViewUid:String

    Determines the extension to which to navigate to when the shortcut is clicked.

    This property can be used as the source for data binding.


    Implementation
        public function get targetViewUid():String
        public function set targetViewUid(value:String):void
    uidproperty 
    uid:String

    Unique ID, usually a namespace-style string.

    By default the uid is set to the extension id where this spec is used.


    Implementation
        public function get uid():String
        public function set uid(value:String):void
    Method Detail
    addEventListener()method
    public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

    Parameters

    type:String
     
    listener:Function
     
    useCapture:Boolean (default = false)
     
    priority:int (default = 0)
     
    weakRef:Boolean (default = false)

    dispatchEvent()method 
    public function dispatchEvent(event:Event):Boolean

    Parameters

    event:Event

    Returns
    Boolean
    hasEventListener()method 
    public function hasEventListener(type:String):Boolean

    Parameters

    type:String

    Returns
    Boolean
    removeEventListener()method 
    public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

    Parameters

    type:String
     
    listener:Function
     
    useCapture:Boolean (default = false)

    willTrigger()method 
    public function willTrigger(type:String):Boolean

    Parameters

    type:String

    Returns
    Boolean
    Examples
    Here is an example of a shortcut declaration in plugin.xml. It adds the link "Helloworld" in the Home view's Inventories category and opens the extension "com.vmware.samples.helloworld.appview" when clicked on. 
     
 <extension id="com.vmware.samples.helloworld.shortcut">
    <extendedPoint>vise.home.shortcuts</extendedPoint>
    <object>
       <name>Helloworld</name>
       <categoryUid>vsphere.core.controlcenter.inventoriesCategory</categoryUid>
       <icon>#{sampleIcon}</icon>
       <targetViewUid>com.vmware.samples.helloworld.appview</targetViewUid>
    </object>
 </extension>



    Copyright @ 2012 VMware, Inc. All rights reserved.

    Fri Nov 4 2016, 08:32 AM -07:00