Class mozile.edit.Command

Object
   |
   +--mozile.edit.Command
Direct Known Subclasses:
mozile.edit.Insert, mozile.edit.Navigate, mozile.edit.Style, mozile.edit.Split, mozile.edit.CommandGroup, mozile.edit.SetAttribute, mozile.edit.Replace, mozile.edit.Unwrap, mozile.edit.Wrap

class mozile.edit.Command

Defined in edit.js


Field Summary
 Boolean group
          Indicates that this command does not contain more commands.
 String makesChanges
          Specifies what kind of change this command makes to the document.
 String name
          The name for this command.
 Object strings
          A localization object for this command.
 String watchesChanges
          Specifies what kind of change will cause this command to change its isActive or isAvailable states.
 
Constructor Summary
mozile.edit.Command ()
            Commands are objects capable of making undoable changes to the document, and aware of the context in which those changes can be made.
 
Method Summary
 Void evaluate(<String> code)
           Evaluates the given JavaScript code string in the context of this object instance.
 mozile.edit.State execute(<mozile.edit.State> state, <Boolean> fresh)
           Executes the command and returns a "state" object which stores the information necessary to unexecute the command.
 Boolean isActive(<Event> event)
           Indicates that the command is currently active.
 Boolean isAvailable(<Event> event)
           Indicates that the command is available to be used.
 Boolean localize(<Object> localization)
           Returns a description of this object.
 mozile.edit.State prepare(<Event> event)
           Creates a "state" object with all of the information needed to execute the command.
 mozile.edit.State request(<mozile.edit.State> state, <Boolean> fresh, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
           Used by commands to call other commands.
 Boolean respond(<String> change)
           Determines whether this command should respond to a change of a given type.
 Boolean test(<Event> event)
           Tests to see if the command should be executed.
 String toString()
           Returns a description of this object.
 mozile.edit.State trigger(<Event> event)
           Executes the command, but only if the test is successful.
 mozile.edit.State unexecute(<mozile.edit.State> state, <Boolean> fresh)
           Reverses the operation of the execute command.

Field Detail

group

Boolean group

makesChanges

String makesChanges

name

String name

strings

Object strings

watchesChanges

String watchesChanges

Constructor Detail

mozile.edit.Command

mozile.edit.Command()

Method Detail

evaluate

Void evaluate(<String> code)

execute

mozile.edit.State execute(<mozile.edit.State> state, <Boolean> fresh)

isActive

Boolean isActive(<Event> event)

isAvailable

Boolean isAvailable(<Event> event)

localize

Boolean localize(<Object> localization)

prepare

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

request

mozile.edit.State request(<mozile.edit.State> state, <Boolean> fresh, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)

respond

Boolean respond(<String> change)

test

Boolean test(<Event> event)

toString

String toString()

trigger

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

unexecute

mozile.edit.State unexecute(<mozile.edit.State> state, <Boolean> fresh)


Documentation generated by JSDoc on Wed Feb 20 13:25:28 2008