|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--MozileCommand
Defined in interface.js
Field Summary | |
Object |
accelerator
Mozile Command - Accelerator - The keyboard shortcut for this command, or "null" for none. |
Object |
accesskey
Mozile Command - Access Key - The keyboard access key for the menuitem, or "null" for none. |
Object |
button
Mozile Command - Button - The button element this command, or "null" for none. |
Object |
debugLevel
Mozile Command - Debug Level - An integer indicating how verbose debugging should be. |
Object |
id
Mozile Command - Id - The unique id by which this command is known. |
Object |
image
Mozile Command - Image - The path to the image associated with this command, if any. |
Object |
label
Mozile Command - Label - A word or two describing this command. |
Object |
menuitem
Mozile Command - Menuitem - The menuitem for this command, or "null" for none. |
Object |
namespace
Mozile Command - Namespace - The XUL namespace in which elements will be created. |
Object |
tooltip
Mozile Command - Tooltip - A short phrase describing this command. |
Object |
type
Mozile Command - Type - Denotes this object as a command. |
Constructor Summary | |
MozileCommand
()
Mozile Command Object - Creates a Mozile command object, which controls the button, menuitem, and code associated with a Mozile editing command. |
Method Summary | |
Object
|
command(event)
Mozile Command - Command - Implements the editing command for this object. |
Object
|
createButton()
Mozile Command - Create Button - Creates an XUL button element for this command. |
Object
|
createMenuitem()
Mozile Command - Create Menuitem - Creates an XUL menuitem element for this command. |
Object
|
debug(details, level, message)
Mozile Debug - A basic debugging tool. |
Object
|
init(configArray)
Mozile Command - Init - Initializes the Mozile Command object, setting various properties based on the configArray. |
Object
|
isActive()
Mozile Command - Is Active - Checks to see if the command is active in the current selection. |
Object
|
update()
Mozile Command - Update Button - Updates the XUL button and menu item for this command, setting its "active" or "checked" attribute to true if this.isActive() returns true, and to "false" otherwise. |
Field Detail |
Object accelerator
Object accesskey
Object button
Object debugLevel
Object id
Object image
Object label
Object menuitem
Object namespace
Object tooltip
Object type
Constructor Detail |
MozileCommand()
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', 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 configuration string, following the above format.
Method Detail |
Object command(event)
event
- The event which triggered this command.
Object createButton()
Object createMenuitem()
Object debug(details, level, message)
details
- An array of information. The first two fields are "File", and "Function" (usually a function name). Fancier debugging functions might use more fields.
level
- An integer describing the importance of the debugging message. 4="critical", 3="very important", 2="important", 1="normal", 0="not important".
message
- A string containing the debugging message.
Object init(configArray)
configArray
- An array of configuration opions, as created by Mozile.parseConfig().
Object isActive()
Object update()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |