Class mozile.edit.CommandGroup

Object
   |
   +--mozile.edit.Command
         |
         +--mozile.edit.CommandGroup

class mozile.edit.CommandGroup

extends mozile.edit.Command

Defined in edit.js

Field Detail

group

Boolean group

Indicates that this command contains more commands.

makesChanges

String makesChanges

Specifies what kind of change this command makes to the document. See mozile.edit.Command.respond for possible values.

name

String name

The name for this command group.

watchesChanges

String watchesChanges

Specifies what kind of change will cause this command to change its isActive or isAvailable states. See mozile.edit.Command.respond for possible values.

mozile.edit.CommandGroup

mozile.edit.CommandGroup()

CommandGroups contain other commands.

Parameters:
name - The group's name.
localization - Optional. The localization object to use.

addCommand

mozile.edit.Command addCommand(<mozile.edit.Command> command, <mozile.edit.Command> previousCommand)

Adds a command to the list of commands for this CommandGroup.

Parameters:
command - The command to be added.
previousCommand - Optional. The new command will be added after this command.

compareCommands

Number compareCommands(<mozile.edit.Command> command1, <mozile.edit.Command> command2)

Compares a pair commands by their "priority" attribute. Higher values come first. Designed to be used by JavaScript's array.sort() method.

Parameters:
command1 -
command2 -

removeCommands

Void removeCommands()

Removes all commands from this command group. The command objects themselves are not deleted.

toString

String toString()

Returns a description of this object.

trigger

mozile.edit.State trigger(<Event> event)

Takes an event object and uses it to try and trigger all of the commands associated with this CommandGroup.

Parameters:
event - The event to handle.