com.xmlmind.xmledit.cmd.attribute

Class EditAttribute

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.attribute.EditAttribute

All Implemented Interfaces:

Command, MacroRecorder.Paste

Direct Known Subclasses:

AddAttribute, PutAttribute, RemoveAttribute

public class EditAttribute
extends CommandBase
implements MacroRecorder.Paste

Implementation of command editAttribute.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EditAttribute.AutoValue

Field Summary

Fields

Modifier and Type	Field and Description
protected Name	attributeName
protected String	attributeValue
protected EditAttribute.AutoValue	autoValue
protected boolean	simplePrompt

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

recordable, repeatable

Constructor Summary

Constructors

Modifier	Constructor and Description
	EditAttribute()
protected	EditAttribute(boolean repeatable)

Method Summary

Modifier and Type	Method and Description
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected ElementEditor	doPrepare(DocumentView docView, String parameter)
protected String	getAttributeValue(DocumentView docView, boolean[] checkValue)
String	getPossiblyPastedText(String parameter) Returns the substring possibly pasted from the clipboard and contained in specified parameter.
protected String	makeRepeatParameter(String parameter)
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
static String	prompt(Element editedElement, Name attributeName)
protected String	selectAttributeValue(DocumentView docView, boolean addAttribute)
String	setPossiblyPastedText(String parameter, String replacement) Replaces in specified parameter the substring possibly pasted from the clipboard (as returned by MacroRecorder.Paste.getPossiblyPastedText(java.lang.String)) by specified replacement.
String[]	splitPossiblyPastedText(String parameter)

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

Field Detail

simplePrompt

protected boolean simplePrompt

autoValue

protected EditAttribute.AutoValue autoValue

attributeName

protected Name attributeName

attributeValue

protected String attributeValue

Constructor Detail

EditAttribute

public EditAttribute()

EditAttribute

protected EditAttribute(boolean repeatable)

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

doPrepare

protected ElementEditor doPrepare(DocumentView docView,
                                  String parameter)

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.

getAttributeValue

protected String getAttributeValue(DocumentView docView,
                                   boolean[] checkValue)

selectAttributeValue

protected String selectAttributeValue(DocumentView docView,
                                      boolean addAttribute)

prompt

public static final String prompt(Element editedElement,
                                  Name attributeName)

makeRepeatParameter

protected String makeRepeatParameter(String parameter)

getPossiblyPastedText

public String getPossiblyPastedText(String parameter)

Description copied from interface: MacroRecorder.Paste

Returns the substring possibly pasted from the clipboard and contained in specified parameter. May return null.

Example: putAttribute returns the attribute value part of specified parameter.

Specified by:

getPossiblyPastedText in interface MacroRecorder.Paste

Parameters:

parameter - the parameter of the command

Returns:

a substring within parameter containing possibly pasted text. May be null.

splitPossiblyPastedText

public String[] splitPossiblyPastedText(String parameter)

setPossiblyPastedText

public String setPossiblyPastedText(String parameter,
                                    String replacement)

Description copied from interface: MacroRecorder.Paste

Replaces in specified parameter the substring possibly pasted from the clipboard (as returned by MacroRecorder.Paste.getPossiblyPastedText(java.lang.String)) by specified replacement.

Specified by:

setPossiblyPastedText in interface MacroRecorder.Paste

Parameters:

parameter - the parameter of the command

replacement - a replacement for the substring possibly pasted from the clipboard

Returns:

new parameter with replacement replacing the substring possibly pasted from the clipboard