|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--MozileComponent | +--MozileCommand
Defined in interface.js
Constructor Summary | |
MozileCommand
(<String> configString)
Mozile Command Object - Creates a Mozile command object, which controls the button, menuitem, and code associated with a Mozile editing command. |
Method Summary | |
Void
|
execute(<Event> event)
Executes the command. |
XULElement
|
getButton()
|
String
|
getId()
Gets the id for the module. |
XULElement
|
getMenuitem()
|
Void
|
hide()
Hides the button and menuitem. |
Boolean
|
isActive()
Checks to see if the command is active in the current selection. |
Boolean
|
isAvailable()
Checks to see if the command is available in the current selection. |
Boolean
|
isUndoable()
True if the command can be undone. |
Void
|
show()
Shows the button and menuitem. |
Void
|
update()
Updates the button and menuitem. |
Methods inherited from class MozileComponent |
toString, getName, getConfigString, getOptions, getOption, setOption, _cleanOption
|
Constructor Detail |
MozileCommand(<String> configString)
Configuration String format (particular command objects may have other options): "MozileCommandObject: id=CommandId, label='Command Label', tooltip='Command Tool Tip', image='/path/to/image.file', accesskey=C, accelerator='Command-C', undoable=true, buttonPosition=0, menuPosition=0, debugLevel=0"
Accelerator format must follow this sequence: "Command-Meta-Control-Alt-Shift-Key". Mozile will check the UserAgent string for the browser, and replace "Command" with "Control" on Linux and Windows, or "Meta" on Macintosh. One of "Command", "Control" or "Meta" must be present, and "Key" is a single uppercase character.
configString
- A properly formatted configuration string.
Method Detail |
Void execute(<Event> event)
event
- The event object which triggered the command.
XULElement getButton()
String getId()
XULElement getMenuitem()
Void hide()
Boolean isActive()
Boolean isAvailable()
Boolean isUndoable()
Void show()
Void update()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |