com.xmlmind.xmledit.cmd.include

Class CopyAsInclusion

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.include.CopyAsInclusion

All Implemented Interfaces:

Command

public final class CopyAsInclusion
extends CommandBase

Implementation of the copyAsInclusion command.

Field Summary

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
CopyAsInclusion()

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.
static String	formatInclusion(Node child1, Node child2, SimpleInclusionScheme scheme, boolean createAbsRef, String absRef, Map<Object,Object> inclusionOpts, boolean checkAdvancedXInclude, DocumentView docView)
static boolean	getAllowAdvancedXInclude(CommandEnv env) Returns true if copying a reference to a range of nodes using XInclude is allowed; false otherwise.
static boolean	getWarnAboutAdvancedXInclude(CommandEnv env) Returns true if a warning is to be reported when copying a reference to a range of nodes using XInclude; false otherwise.
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 void	setAllowAdvancedXInclude(CommandEnv env, boolean allow) Specifies whether copying a reference to a range of nodes using XInclude is allowed.
static void	setWarnAboutAdvancedXInclude(CommandEnv env, boolean warn) Specifies whether a warning is to be reported when copying a reference to a range of nodes using XInclude.

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

CopyAsInclusion

public CopyAsInclusion()

Method Detail

setAllowAdvancedXInclude

public static void setAllowAdvancedXInclude(CommandEnv env,
                                            boolean allow)

Specifies whether copying a reference to a range of nodes using XInclude is allowed.

By default, this is not allowed.

getAllowAdvancedXInclude

public static boolean getAllowAdvancedXInclude(CommandEnv env)

Returns true if copying a reference to a range of nodes using XInclude is allowed; false otherwise.

setWarnAboutAdvancedXInclude

public static void setWarnAboutAdvancedXInclude(CommandEnv env,
                                                boolean warn)

Specifies whether a warning is to be reported when copying a reference to a range of nodes using XInclude.

By default, a warning is reported.

getWarnAboutAdvancedXInclude

public static boolean getWarnAboutAdvancedXInclude(CommandEnv env)

Returns true if a warning is to be reported when copying a reference to a range of nodes using XInclude; false otherwise.

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.

formatInclusion

public static final String formatInclusion(Node child1,
                                           Node child2,
                                           SimpleInclusionScheme scheme,
                                           boolean createAbsRef,
                                           String absRef,
                                           Map<Object,Object> inclusionOpts,
                                           boolean checkAdvancedXInclude,
                                           DocumentView docView)