Package | com.adobe.bridge |
Class | public class MenuElement |
Inheritance | MenuElement ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
altDown : Boolean [read-only]
When true, the Alt modifier key was pressed when the item was selected. | MenuElement | ||
canBeChecked : Boolean [read-only]
Whether the menu item can be checked. | MenuElement | ||
checked : Boolean
Whether the item is checked. | MenuElement | ||
cmdDown : Boolean [read-only]
When true, the Command modifier key was pressed when the item was selected. | MenuElement | ||
ctrlDown : Boolean [read-only]
When true, the Control modifier key was pressed when the item was selected. | MenuElement | ||
enabled : Boolean
Whether the menu or item is enabled. | MenuElement | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : String [read-only]
A unique identifier for the element. | MenuElement | ||
location : String [read-only]
A string describing the location of the new menu element, with respect to existing menu elements. | MenuElement | ||
optionDown : Boolean [read-only]
When true, the Option modifier key was pressed when the item was selected. | MenuElement | ||
separatorAfter : Boolean
Whether there is a separator after this item. | MenuElement | ||
separatorBefore : Boolean
Whether there is a separator before this item. | MenuElement | ||
shiftDown : Boolean [read-only]
When true, the Shift modifier key was pressed when the item was selected. | MenuElement | ||
text : String
The displayed label text, a localizable string. | MenuElement | ||
type : String [read-only]
The type of menu element, a menu or command. | MenuElement |
Method | Defined By | ||
---|---|---|---|
MenuElement(type:String = null, text:String = null, location:String = null, id:String = null) | MenuElement | ||
create(type:String, text:String, location:String, id:String):MenuElement [static]
Adds a new menu to the menu bar, a new submenu to an existing menu, or a new command to an existing menu or submenu. | MenuElement | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
find(id:String):MenuElement [static]
Retrieves a menu element object using its unique identifier. | MenuElement | ||
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
remove(id:String):void [static]
Removes a script-defined menu or menu item. | MenuElement | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
Method | Defined By | ||
---|---|---|---|
createWithArgs(args:Array):void [override] | MenuElement | ||
![]() | hostCreate(args:Array):void | CSHostObject |
altDown | property |
altDown:Boolean
[read-only] Since : | CS5 |
When true, the Alt modifier key was pressed when the item was selected.
public function get altDown():Boolean
canBeChecked | property |
canBeChecked:Boolean
[read-only] Since : | CS5 |
Whether the menu item can be checked.
public function get canBeChecked():Boolean
checked | property |
checked:Boolean
Since : | CS5 |
Whether the item is checked.
public function get checked():Boolean
public function set checked(value:Boolean):void
cmdDown | property |
cmdDown:Boolean
[read-only] Since : | CS5 |
When true, the Command modifier key was pressed when the item was selected.
public function get cmdDown():Boolean
ctrlDown | property |
ctrlDown:Boolean
[read-only] Since : | CS5 |
When true, the Control modifier key was pressed when the item was selected.
public function get ctrlDown():Boolean
enabled | property |
enabled:Boolean
Since : | CS5 |
Whether the menu or item is enabled.
public function get enabled():Boolean
public function set enabled(value:Boolean):void
id | property |
id:String
[read-only] Since : | CS5 |
A unique identifier for the element.
public function get id():String
location | property |
location:String
[read-only] Since : | CS5 |
A string describing the location of the new menu element, with respect to existing menu elements.
public function get location():String
optionDown | property |
optionDown:Boolean
[read-only] Since : | CS5 |
When true, the Option modifier key was pressed when the item was selected.
public function get optionDown():Boolean
separatorAfter | property |
separatorAfter:Boolean
Since : | CS5 |
Whether there is a separator after this item.
public function get separatorAfter():Boolean
public function set separatorAfter(value:Boolean):void
separatorBefore | property |
separatorBefore:Boolean
Since : | CS5 |
Whether there is a separator before this item.
public function get separatorBefore():Boolean
public function set separatorBefore(value:Boolean):void
shiftDown | property |
shiftDown:Boolean
[read-only] Since : | CS5 |
When true, the Shift modifier key was pressed when the item was selected.
public function get shiftDown():Boolean
text | property |
text:String
Since : | CS5 |
The displayed label text, a localizable string.
public function get text():String
public function set text(value:String):void
type | property |
type:String
[read-only] Since : | CS5 |
The type of menu element, a menu or command.
public function get type():String
MenuElement | () | Constructor |
public function MenuElement(type:String = null, text:String = null, location:String = null, id:String = null)
Since : | CS5 |
Parameters
type:String (default = null ) — (String)
| |
text:String (default = null ) — (String)
| |
location:String (default = null ) — (String)
| |
id:String (default = null ) — (String)
|
create | () | method |
public static function create(type:String, text:String, location:String, id:String):MenuElement
Since : | CS5 |
Adds a new menu to the menu bar, a new submenu to an existing menu, or a new command to an existing menu or submenu.
Parameters
type:String — (String)
| |
text:String — (String)
| |
location:String — (String)
| |
id:String — (String)
|
MenuElement |
createWithArgs | () | method |
override protected function createWithArgs(args:Array):void
Since : | CS5 |
Parameters
args:Array |
find | () | method |
public static function find(id:String):MenuElement
Since : | CS5 |
Retrieves a menu element object using its unique identifier.
Parameters
id:String — (String)
|
MenuElement |
remove | () | method |
public static function remove(id:String):void
Since : | CS5 |
Removes a script-defined menu or menu item.
Parameters
id:String — (String)
|