com.xmlmind.xmledit.cmd.edit

Class AddBlockInFlow

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.edit.AddBlockInFlow

All Implemented Interfaces:

Command

public class AddBlockInFlow
extends CommandBase

Implementation of command addBlockInFlow.

Field Summary

Fields

Modifier and Type	Field and Description
protected Node	beforeNode
protected ElementTemplates	elementTemplates
protected static Name	INLINE_ELEMENT_NAMES_PROPERTY
protected Field	insertField
protected Name	insertName
protected ElementTemplate	insertTemplate
protected ArrayList<Field>	list

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
AddBlockInFlow()

Method Summary

Modifier and Type	Method and Description
protected static boolean	canContain(Element element, Name childName, DocumentType docType)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected Map<Name,Name>	doGetInlineNames(Document doc, DocumentType docType, String parameter)
protected boolean	doParseInsertName(String parameter, int offset, Document doc)
static boolean	getChildElementNames(DocumentType docType, Name parentName, Object result) Return the names of the child elements of specified parent element.
protected Map<Name,Name>	getInlineNames(Document doc, DocumentType docType, String parameter)
static boolean	parseInlineElementNames(Document doc, DocumentType docType, Map<Name,Name> inlineNameSet) Parse inline element names from system property "$c inlineElementNames".
protected boolean	parseInsertName(String parameter, Document doc)
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

insertName

protected Name insertName

insertTemplate

protected ElementTemplate insertTemplate

elementTemplates

protected ElementTemplates elementTemplates

beforeNode

protected Node beforeNode

insertField

protected Field insertField

list

protected ArrayList<Field> list

INLINE_ELEMENT_NAMES_PROPERTY

protected static final Name INLINE_ELEMENT_NAMES_PROPERTY

Constructor Detail

AddBlockInFlow

public AddBlockInFlow()

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

parseInsertName

protected boolean parseInsertName(String parameter,
                                  Document doc)

doParseInsertName

protected boolean doParseInsertName(String parameter,
                                    int offset,
                                    Document doc)

canContain

protected static final boolean canContain(Element element,
                                          Name childName,
                                          DocumentType docType)

getInlineNames

protected Map<Name,Name> getInlineNames(Document doc,
                                        DocumentType docType,
                                        String parameter)

doGetInlineNames

protected Map<Name,Name> doGetInlineNames(Document doc,
                                          DocumentType docType,
                                          String parameter)

parseInlineElementNames

public static final boolean parseInlineElementNames(Document doc,
                                                    DocumentType docType,
                                                    Map<Name,Name> inlineNameSet)

Parse inline element names from system property "$c inlineElementNames".

Parameters:

doc - document being edited

inlineNameSet - to be filled with parsed names

Returns:

true if success or false if system property does not exist or its content cannot be parsed

getChildElementNames

public static final boolean getChildElementNames(DocumentType docType,
                                                 Name parentName,
                                                 Object result)

Return the names of the child elements of specified parent element.

Parameters:

docType - type of the document containing the parent element

parentName - name of the parent element

result - to be filled with child element names; a Map<Name,Name> or a List<Name>

Returns:

true if success or false if the type of parent element cannot be determined

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.