com.xmlmind.xmleditapp.cmd.object

Class SetObject

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditapp.cmd.object.SetObject

All Implemented Interfaces:

Command

public class SetObject
extends CommandBase

Implementation of command setObject.

Field Summary

Fields

Modifier and Type	Field and Description
protected Name	attributeName
protected Element	element
protected boolean	gzip
protected URL	objectURL
protected ResourceType	resourceType

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
SetObject()

Method Summary

Modifier and Type	Method and Description
static ResourceType	canSetObject(Element element, Name attributeName, ResourceType resourceType)
protected static URL	chooseObject(Element element, String[] fileExtensions, DocumentView docView)
protected static boolean	copy(URL srcURL, URL dstURL, DocumentView docView)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected static CommandResult	doSetObject(URL objectURL, Element element, Name attributeName, ResourceType resourceType, String[] fileExtensions, boolean gzip, DocumentView docView)
protected static String	encodeBinaryObject(URL objectURL, ResourceType resourceType, boolean gzip, DocumentView docView)
protected static String[]	parseFileExtensions(String parameter, ResourceType resourceType)
protected URL	parseObjectURL(String location)
protected boolean	parseParameter(String[] args)
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 boolean	setBinaryObject(URL objectURL, Element element, Name attributeName, ResourceType resourceType, boolean gzip, DocumentView docView)
static CommandResult	setObject(URL objectURL, Element element, Name attributeName, ResourceType resourceType, boolean gzip, DocumentView docView)
static CommandResult	setObject(URL objectURL, Element element, Name attributeName, ResourceType resourceType, String[] fileExtensions, boolean gzip, DocumentView docView)
static boolean	setObjectReference(ResourceDialog.Info info, Element element, Name attributeName, DocumentView docView)
protected static boolean	setObjectValue(String objectValue, Element element, Name attributeName, DocumentView docView)
static boolean	setXMLObject(URL objectURL, Element element, DocumentView docView)

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

element

protected Element element

attributeName

protected Name attributeName

resourceType

protected ResourceType resourceType

gzip

protected boolean gzip

objectURL

protected URL objectURL

Constructor Detail

SetObject

public SetObject()

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

parseParameter

protected boolean parseParameter(String[] args)

parseObjectURL

protected URL parseObjectURL(String location)

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.

parseFileExtensions

protected static String[] parseFileExtensions(String parameter,
                                              ResourceType resourceType)

canSetObject

public static ResourceType canSetObject(Element element,
                                        Name attributeName,
                                        ResourceType resourceType)

setObject

public static CommandResult setObject(URL objectURL,
                                      Element element,
                                      Name attributeName,
                                      ResourceType resourceType,
                                      boolean gzip,
                                      DocumentView docView)

setObject

public static CommandResult setObject(URL objectURL,
                                      Element element,
                                      Name attributeName,
                                      ResourceType resourceType,
                                      String[] fileExtensions,
                                      boolean gzip,
                                      DocumentView docView)

doSetObject

protected static CommandResult doSetObject(URL objectURL,
                                           Element element,
                                           Name attributeName,
                                           ResourceType resourceType,
                                           String[] fileExtensions,
                                           boolean gzip,
                                           DocumentView docView)

chooseObject

protected static URL chooseObject(Element element,
                                  String[] fileExtensions,
                                  DocumentView docView)

setObjectReference

public static boolean setObjectReference(ResourceDialog.Info info,
                                         Element element,
                                         Name attributeName,
                                         DocumentView docView)

copy

protected static boolean copy(URL srcURL,
                              URL dstURL,
                              DocumentView docView)

setObjectValue

protected static boolean setObjectValue(String objectValue,
                                        Element element,
                                        Name attributeName,
                                        DocumentView docView)

setBinaryObject

public static boolean setBinaryObject(URL objectURL,
                                      Element element,
                                      Name attributeName,
                                      ResourceType resourceType,
                                      boolean gzip,
                                      DocumentView docView)

encodeBinaryObject

protected static String encodeBinaryObject(URL objectURL,
                                           ResourceType resourceType,
                                           boolean gzip,
                                           DocumentView docView)

setXMLObject

public static boolean setXMLObject(URL objectURL,
                                   Element element,
                                   DocumentView docView)