com.xmlmind.xmleditapp.cmd.helper

Class SelectConvertedFile

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditapp.cmd.helper.SelectFile

com.xmlmind.xmleditapp.cmd.helper.SelectConvertedFile

All Implemented Interfaces:

Command

Direct Known Subclasses:

SelectConvertedFileCmd

public class SelectConvertedFile
extends SelectFile

Implementation of command selectConvertedFile.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	extension
protected boolean	lastPreviewChoice
protected static String	PREVIEWED_URL_PROP
protected JCheckBox	previewToggle

Fields inherited from class com.xmlmind.xmleditapp.cmd.helper.SelectFile

dirMode, lastOpenDirectory, lastOpenDirectoryURL, lastOpenFile, lastOpenFileURL, lastSaveDirectory, lastSaveDirectoryURL, lastSaveFile, lastSaveFileURL, lastSelectedURLs, saveMode, template, title, urlMode

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
SelectConvertedFile()

Method Summary

Modifier and Type	Method and Description
protected CommandResult	checkWriteLock(DocumentView docView, CommandResult selected)
protected List<URL>	createLastSelectedURLs(DocumentView docView)
protected static JLabel	createMangledInfo(String extension, String unrestricted)
protected static JCheckBox	createPreviewToggle()
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)
static URL	getPreviewedURL(DocumentView docView) Returns the URL of the file which is the result of the current document conversion, when this file is to be previewed using a helper application.
protected boolean	parseAction(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)
static void	setPreviewedURL(DocumentView docView, URL url) Specifies the URL of the file which is the result of the current document conversion, when this file is to be previewed using a helper application.
protected void	setURLChooserAccessory(DocumentView docView, URLChooserDialog urlChooser)
protected void	setURLChooserAccessory2(DocumentView docView, URLChooserDialog urlChooser)

Methods inherited from class com.xmlmind.xmleditapp.cmd.helper.SelectFile

addLastSelectedURL, getLastSelectedURLs, parseOption, parseParameter

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

extension

protected String extension

previewToggle

protected JCheckBox previewToggle

lastPreviewChoice

protected boolean lastPreviewChoice

PREVIEWED_URL_PROP

protected static final String PREVIEWED_URL_PROP

See Also:

Constant Field Values

Constructor Detail

SelectConvertedFile

public SelectConvertedFile()

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.

Overrides:

prepare in class SelectFile

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

parseAction

protected boolean parseAction(DocumentView docView,
                              String parameter)

Overrides:

parseAction in class SelectFile

getDefaultTemplate

protected URL getDefaultTemplate(DocumentView docView)

Overrides:

getDefaultTemplate in class SelectFile

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".

Overrides:

doExecute in class SelectFile

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.

checkWriteLock

protected CommandResult checkWriteLock(DocumentView docView,
                                       CommandResult selected)

selectURL

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

Overrides:

selectURL in class SelectFile

setURLChooserAccessory

protected void setURLChooserAccessory(DocumentView docView,
                                      URLChooserDialog urlChooser)

createPreviewToggle

protected static final JCheckBox createPreviewToggle()

setURLChooserAccessory2

protected void setURLChooserAccessory2(DocumentView docView,
                                       URLChooserDialog urlChooser)

createMangledInfo

protected static final JLabel createMangledInfo(String extension,
                                                String unrestricted)

setPreviewedURL

public static void setPreviewedURL(DocumentView docView,
                                   URL url)

Specifies the URL of the file which is the result of the current document conversion, when this file is to be previewed using a helper application.

Parameters:

docView - a view of the document being converted

url - URL of the file which is the result of current document conversion. Use null to remove this specification.

See Also:

getPreviewedURL(com.xmlmind.xmledit.view.DocumentView)

getPreviewedURL

public static URL getPreviewedURL(DocumentView docView)

Returns the URL of the file which is the result of the current document conversion, when this file is to be previewed using a helper application.

Parameters:

docView - a view of the document being converted

Returns:

URL of the file which is the result of current document conversion; otherwise null

See Also:

setPreviewedURL(com.xmlmind.xmledit.view.DocumentView, java.net.URL)

createLastSelectedURLs

protected List<URL> createLastSelectedURLs(DocumentView docView)

Overrides:

createLastSelectedURLs in class SelectFile

setDefaultTemplate

protected void setDefaultTemplate(DocumentView docView,
                                  URL selected)

Overrides:

setDefaultTemplate in class SelectFile