com.xmlmind.xmledit.cmd.include

Class UpdateInclusions

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.include.UpdateInclusions

All Implemented Interfaces:

InclusionTraversal.Handler, Command

Direct Known Subclasses:

UpdateInclusionsCmd

public class UpdateInclusions
extends CommandBase
implements InclusionTraversal.Handler

Implementation of command updateInclusions.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	markCount

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
UpdateInclusions()

Method Summary

Modifier and Type	Method and Description
protected void	beginMarkInclusions(Document updatedDoc)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected void	endMarkInclusions()
protected Document[]	getPreloadedDocuments(Document updatedDoc)
protected boolean	markInclusion(XInclusion inclusion, Node firstIncludedNode, Node lastIncludedNode)
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
Object	processInclusion(Inclusion inclusion, Node firstIncludedNode, Node lastIncludedNode) Invoked during the traversal of a document subtree for each inclusion encountered.

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

markCount

protected int markCount

Constructor Detail

UpdateInclusions

public UpdateInclusions()

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.

beginMarkInclusions

protected void beginMarkInclusions(Document updatedDoc)

markInclusion

protected boolean markInclusion(XInclusion inclusion,
                                Node firstIncludedNode,
                                Node lastIncludedNode)

endMarkInclusions

protected void endMarkInclusions()

getPreloadedDocuments

protected Document[] getPreloadedDocuments(Document updatedDoc)

processInclusion

public Object processInclusion(Inclusion inclusion,
                               Node firstIncludedNode,
                               Node lastIncludedNode)

Description copied from interface: InclusionTraversal.Handler

Invoked during the traversal of a document subtree for each inclusion encountered.

Specified by:

processInclusion in interface InclusionTraversal.Handler

Parameters:

inclusion - The currently visited inclusion.

firstIncludedNode - First included node.

lastIncludedNode - Last included node. Often the same node as firstIncludedNode.

Returns:

null to proceed; any other value to stop the traversal. In the later case, the Object returned by this method is the Object returned by InclusionTraversal.traverse(com.xmlmind.xml.doc.Tree, com.xmlmind.xml.load.InclusionTraversal.Handler).