Package | com.vmware.vsphere.client.views |
Class | public class ShortcutSpec |
Inheritance | ShortcutSpec ![]() |
Implements | mx.core.IUID, flash.events.IEventDispatcher |
Specification class for vise.home.shortcuts
extension point.
Property | Defined 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 |
Method | Defined 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 |
categoryUid | property |
categoryUid:String
Category id under which the shortcut will be displayed.
The supported categories are:
This property can be used as the source for data binding.
public function get categoryUid():String
public function set categoryUid(value:String):void
icon | property |
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.
public function get icon():Class
public function set icon(value:Class):void
name | property |
name:String
The shortcut's user-visible name.
This property can be used as the source for data binding.
public function get name():String
public function set name(value:String):void
targetViewUid | property |
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.
public function get targetViewUid():String
public function set targetViewUid(value:String):void
uid | property |
uid:String
Unique ID, usually a namespace-style string.
By default the uid is set to the extension id where this spec is used.
public function get uid():String
public function set uid(value:String):void
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 |
Boolean |
hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
Parameters
type:String |
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 |
Boolean |
<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>