com.xmlmind.xmleditext.docbook

Class EditImageMap

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditapp.cmd.imagemap.EditImageMapBase

com.xmlmind.xmleditext.docbook.EditImageMap

All Implemented Interfaces:

Command

public final class EditImageMap
extends EditImageMapBase

Implementation of command config_prefix.editImageMap.

Field Summary

Fields inherited from class com.xmlmind.xmleditapp.cmd.imagemap.EditImageMapBase

imageMapElement

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
EditImageMap()

Method Summary

Modifier and Type	Method and Description
protected ImageMapEditor	createImageMapEditor(Component parentComponent, String title)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected boolean	editImageMap(ImageMap imageMap, Element imageMapElement)
protected Name[]	getImageMapNames(Element selected)
protected Name[][]	getLinkNames(Element imageMapElement)
protected ImageMap	parseImageMap(Element imageMapElement)

Methods inherited from class com.xmlmind.xmleditapp.cmd.imagemap.EditImageMapBase

createLinkTargetChooser, findLinkAttribute, getNonEmptyAttribute, getNonEmptyText, loadImage, prepare, setAttributes, setProperties

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

EditImageMap

public EditImageMap()

Method Detail

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

Overrides:

doExecute in class EditImageMapBase

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.

getImageMapNames

protected Name[] getImageMapNames(Element selected)

Specified by:

getImageMapNames in class EditImageMapBase

getLinkNames

protected Name[][] getLinkNames(Element imageMapElement)

Specified by:

getLinkNames in class EditImageMapBase

createImageMapEditor

protected ImageMapEditor createImageMapEditor(Component parentComponent,
                                              String title)

Overrides:

createImageMapEditor in class EditImageMapBase

parseImageMap

protected ImageMap parseImageMap(Element imageMapElement)
                          throws RuntimeException

Specified by:

parseImageMap in class EditImageMapBase

Throws:

RuntimeException

editImageMap

protected boolean editImageMap(ImageMap imageMap,
                               Element imageMapElement)

Specified by:

editImageMap in class EditImageMapBase