Class mozile.edit.Split

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

class mozile.edit.Split

extends mozile.edit.Command

Defined in rich.js

Field Detail

direction

String direction

Determines what direction to search for the target in.

group

Boolean group

Indicates that this command does not contain 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.

remove

Boolean remove

Indicates that any contents of the selection should be removed before inserting.

target

String target

Determines what node is the target of the split. Can be a string: "element", "block", or "localName [name]"; or a function.

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.Split

mozile.edit.Split()

Splits a target element using splitNodes.

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

execute

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

Inserts a new element at the selection.

Parameters:
state - The state information needed to execute this command.
fresh - Optional. A value of "true" indicates that the window's selection is already in the correct place and does not need to be moved.

isAvailable

Boolean isAvailable(<Event> event)

Indicates that the command is available to be used.

Parameters:
event - Optional. The current event object.

prepare

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

Prepares a state object for the Split command.

Parameters:
event - The event object to be converted into a state.

test

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

Prepares a state object for the Split command.

Parameters:
event - The event object to be converted into a state.