com.xmlmind.xmleditapp.cmd.helper

Class SelectFile

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditapp.cmd.helper.SelectFile

All Implemented Interfaces:

Command

Direct Known Subclasses:

SelectConvertedFile

public class SelectFile
extends CommandBase

Implementation of command selectFile.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dirMode
protected URL	lastOpenDirectory
protected URL	lastOpenDirectoryURL
protected URL	lastOpenFile
protected URL	lastOpenFileURL
protected URL	lastSaveDirectory
protected URL	lastSaveDirectoryURL
protected URL	lastSaveFile
protected URL	lastSaveFileURL
protected List<URL>	lastSelectedURLs
protected boolean	saveMode
protected URL	template
protected String	title
protected boolean	urlMode

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
SelectFile()

Method Summary

Modifier and Type	Method and Description
protected void	addLastSelectedURL(DocumentView docView, URL selected)
protected List<URL>	createLastSelectedURLs(DocumentView docView)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected URL	getDefaultTemplate(DocumentView docView)
protected URL[]	getLastSelectedURLs(DocumentView docView)
protected boolean	parseAction(DocumentView docView, String parameter)
protected boolean	parseOption(DocumentView docView, String option)
protected boolean	parseParameter(DocumentView docView, String parameter)
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
protected URL	selectURL(DocumentView docView, String title, boolean dirMode, boolean saveMode, URL dir, String name, URL[] lastSelectedURLs)
protected void	setDefaultTemplate(DocumentView docView, URL selected)

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

title

protected String title

urlMode

protected boolean urlMode

saveMode

protected boolean saveMode

dirMode

protected boolean dirMode

template

protected URL template

lastOpenFileURL

protected URL lastOpenFileURL

lastSaveFileURL

protected URL lastSaveFileURL

lastOpenDirectoryURL

protected URL lastOpenDirectoryURL

lastSaveDirectoryURL

protected URL lastSaveDirectoryURL

lastOpenFile

protected URL lastOpenFile

lastSaveFile

protected URL lastSaveFile

lastOpenDirectory

protected URL lastOpenDirectory

lastSaveDirectory

protected URL lastSaveDirectory

lastSelectedURLs

protected List<URL> lastSelectedURLs

Constructor Detail

SelectFile

public SelectFile()

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(DocumentView docView,
                                 String parameter)

parseOption

protected boolean parseOption(DocumentView docView,
                              String option)

parseAction

protected boolean parseAction(DocumentView docView,
                              String parameter)

getDefaultTemplate

protected URL getDefaultTemplate(DocumentView docView)

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.

selectURL

protected URL selectURL(DocumentView docView,
                        String title,
                        boolean dirMode,
                        boolean saveMode,
                        URL dir,
                        String name,
                        URL[] lastSelectedURLs)

getLastSelectedURLs

protected URL[] getLastSelectedURLs(DocumentView docView)

createLastSelectedURLs

protected List<URL> createLastSelectedURLs(DocumentView docView)

addLastSelectedURL

protected void addLastSelectedURL(DocumentView docView,
                                  URL selected)

setDefaultTemplate

protected void setDefaultTemplate(DocumentView docView,
                                  URL selected)