com.xmlmind.xmleditapp.cmd.imagemap

Class EditImageMapBase

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditapp.cmd.imagemap.EditImageMapBase

All Implemented Interfaces:

Command

Direct Known Subclasses:

EditImageMap, EditImageMap, EditImageMap

public abstract class EditImageMapBase
extends CommandBase

The base class of all config_prefix.editImageMap commands.

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	imageMapElement

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

recordable, repeatable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EditImageMapBase()

Method Summary

Modifier and Type	Method and Description
protected ImageMapEditor	createImageMapEditor(Component parentComponent, String title)
protected com.xmlmind.xmleditapp.cmd.imagemap.LinkTargetChooser	createLinkTargetChooser(Element imageMapElem)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected abstract boolean	editImageMap(ImageMap imageMap, Element imageMapElement)
protected Attribute	findLinkAttribute(Element tree, Name[][] linkNames)
protected abstract Name[]	getImageMapNames(Element selected)
protected abstract Name[][]	getLinkNames(Element imageMapElement)
protected static String	getNonEmptyAttribute(Element element, Name attrName)
protected static String	getNonEmptyText(Element element)
protected static Image	loadImage(URL url, String widthName, String widthValue, String heightName, String heightValue, String scaleName, String scaleValue, String fitName, String fitValue)
protected abstract ImageMap	parseImageMap(Element imageMapElement)
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
protected static void	setAttributes(Element element, PropertySet propertySet)
protected static void	setProperties(PropertySet propertySet, Element element, Name[] skippedAttributes)

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

imageMapElement

protected Element imageMapElement

Constructor Detail

EditImageMapBase

protected EditImageMapBase()

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

getImageMapNames

protected abstract Name[] getImageMapNames(Element selected)

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.

createImageMapEditor

protected ImageMapEditor createImageMapEditor(Component parentComponent,
                                              String title)

createLinkTargetChooser

protected com.xmlmind.xmleditapp.cmd.imagemap.LinkTargetChooser createLinkTargetChooser(Element imageMapElem)

getLinkNames

protected abstract Name[][] getLinkNames(Element imageMapElement)

findLinkAttribute

protected Attribute findLinkAttribute(Element tree,
                                      Name[][] linkNames)

parseImageMap

protected abstract ImageMap parseImageMap(Element imageMapElement)
                                   throws Exception

Throws:

Exception

editImageMap

protected abstract boolean editImageMap(ImageMap imageMap,
                                        Element imageMapElement)
                                 throws Exception

Throws:

Exception

getNonEmptyAttribute

protected static String getNonEmptyAttribute(Element element,
                                             Name attrName)

getNonEmptyText

protected static String getNonEmptyText(Element element)

setProperties

protected static void setProperties(PropertySet propertySet,
                                    Element element,
                                    Name[] skippedAttributes)

setAttributes

protected static void setAttributes(Element element,
                                    PropertySet propertySet)

loadImage

protected static Image loadImage(URL url,
                                 String widthName,
                                 String widthValue,
                                 String heightName,
                                 String heightValue,
                                 String scaleName,
                                 String scaleValue,
                                 String fitName,
                                 String fitValue)
                          throws RuntimeException

Throws:

RuntimeException