com.xmlmind.xmleditext.assembly

Class InsertOrEditModule

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditext.assembly.InsertOrEditModule

All Implemented Interfaces:

Command

public final class InsertOrEditModule
extends CommandBase

Implementation of command asm.insertOrEditModule.

Field Summary

Fields

Modifier and Type	Field and Description
static Name	ASSEMBLY_ELEM
static Name	ASSOCIATION_ELEM
static Name	CONTENTONLY_ATTR
static Name	DEFAULTFORMAT_ATTR
static PrefixEntry[]	DOCBOOK_PREFIXES
static Name	GRAMMAR_ATTR
static Name	HREF_ATTR
static Name	INDEXTERM_ELEM
static Name	INSTANCE_ELEM
static Name	LINKEND_ATTR
static Name	LINKING_ATTR
static Name	MODULE_ELEM
static Name	OMITTITLES_ATTR
static Name	OUTPUTFORMAT_ATTR
static Name	RELATIONSHIP_ELEM
static Name	RELATIONSHIPS_ELEM
static Name	RENDERAS_ATTR
static Name	RESOURCE_ELEM
static Name	RESOURCEREF_ATTR
static Name	RESOURCES_ELEM
static Name	STRUCTURE_ELEM
static Name	TITLE_ELEM
static Name	TRANSFORMS_ELEM
static Name	TYPE_ATTR

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
InsertOrEditModule()

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

Field Detail

ASSEMBLY_ELEM

public static final Name ASSEMBLY_ELEM

MODULE_ELEM

public static final Name MODULE_ELEM

RESOURCE_ELEM

public static final Name RESOURCE_ELEM

RESOURCES_ELEM

public static final Name RESOURCES_ELEM

STRUCTURE_ELEM

public static final Name STRUCTURE_ELEM

TITLE_ELEM

public static final Name TITLE_ELEM

RELATIONSHIPS_ELEM

public static final Name RELATIONSHIPS_ELEM

RELATIONSHIP_ELEM

public static final Name RELATIONSHIP_ELEM

ASSOCIATION_ELEM

public static final Name ASSOCIATION_ELEM

INSTANCE_ELEM

public static final Name INSTANCE_ELEM

TRANSFORMS_ELEM

public static final Name TRANSFORMS_ELEM

INDEXTERM_ELEM

public static final Name INDEXTERM_ELEM

CONTENTONLY_ATTR

public static final Name CONTENTONLY_ATTR

DEFAULTFORMAT_ATTR

public static final Name DEFAULTFORMAT_ATTR

GRAMMAR_ATTR

public static final Name GRAMMAR_ATTR

HREF_ATTR

public static final Name HREF_ATTR

OMITTITLES_ATTR

public static final Name OMITTITLES_ATTR

OUTPUTFORMAT_ATTR

public static final Name OUTPUTFORMAT_ATTR

RENDERAS_ATTR

public static final Name RENDERAS_ATTR

RESOURCEREF_ATTR

public static final Name RESOURCEREF_ATTR

TYPE_ATTR

public static final Name TYPE_ATTR

LINKEND_ATTR

public static final Name LINKEND_ATTR

LINKING_ATTR

public static final Name LINKING_ATTR

DOCBOOK_PREFIXES

public static final PrefixEntry[] DOCBOOK_PREFIXES

Constructor Detail

InsertOrEditModule

public InsertOrEditModule()

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.