com.xmlmind.xmledit.cmd.edit

Class Copy

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.edit.Copy

All Implemented Interfaces:

Command, MacroRecorder.Copy

Direct Known Subclasses:

CopyChars

public class Copy
extends CommandBase
implements MacroRecorder.Copy

Implementation of command copy.

Field Summary

Fields inherited from class com.xmlmind.xmledit.cmd.CommandBase

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
Copy()

Method Summary

Modifier and Type	Method and Description
protected String	copyElement(Element element, DocumentView docView, String parameter)
protected String	copyNodeRange(Element element, Node child1, Node child2, DocumentView docView, String parameter)
String	copySelection(DocumentView docView, String parameter)
protected String	copyTextRange(TextNode textNode1, int offset1, TextNode textNode2, int offset2, DocumentView docView, String parameter)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
String	getLastCopiedText() Return text last copied to the clipboard by this command.
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.

Methods inherited from class com.xmlmind.xmledit.cmd.CommandBase

doExecuteByName, execute, executeCommand, isRecordable, isRepeatable, prepareCommand

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.xmlmind.xmledit.control.Command

copy

Constructor Detail

Copy

public Copy()

Method Detail

prepare

public boolean prepare(DocumentView docView,
                       String parameter,
                       int x,
                       int y)

Description copied from class: CommandBase

Tests whether this command can be executed with specified parameter and in specified context.

If the command can be executed, this method returns true after having configured its internal state for consumption by method CommandBase.execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) which should be invoked immediately after this one.

Returns false if this command cannot be executed with specified parameter and in specified context.

Specified by:

prepare in class CommandBase

Parameters:

docView - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

doExecute

public CommandResult doExecute(DocumentView docView,
                               String parameter,
                               int x,
                               int y)

Description copied from class: CommandBase

Actually executes this command with specified parameter and in specified context.

This method assumes that CommandBase.prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) has been successfully invoked immediately before its own invocation.

IMPORTANT: application code which executes a command must always use CommandBase.execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) or CommandBase.executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) to do so, NOT CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int). CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) is intended to be used only by commands which invoke helper "sub-commands".

Specified by:

doExecute in class CommandBase

Parameters:

docView - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

Returns:

the result of the command; may NOT be null.

If the command execution is successful and the command is repeatable and/or recordable then CommandResult.details field of the result is expected to be one of:

null

The repeat/record parameter is simply the parameter used as an argument of this method.

An Object

The repeat/record parameter is the string value of this object.

An array of 2 Strings

First string is the repeat/record parameter. Second string is the description of the command to be displayed by repeat commands.

copySelection

public String copySelection(DocumentView docView,
                            String parameter)

copyElement

protected String copyElement(Element element,
                             DocumentView docView,
                             String parameter)

copyNodeRange

protected String copyNodeRange(Element element,
                               Node child1,
                               Node child2,
                               DocumentView docView,
                               String parameter)

copyTextRange

protected String copyTextRange(TextNode textNode1,
                               int offset1,
                               TextNode textNode2,
                               int offset2,
                               DocumentView docView,
                               String parameter)

getLastCopiedText

public String getLastCopiedText()

Description copied from interface: MacroRecorder.Copy

Return text last copied to the clipboard by this command. May return null.

This method is invoked by RecordMacro just after the command has been successfully executed.

Specified by:

getLastCopiedText in interface MacroRecorder.Copy