com.xmlmind.xmleditapp.desktop.file

Class NewAction

java.lang.Object

javax.swing.AbstractAction

com.xmlmind.xmleditapp.desktop.AppAction

com.xmlmind.xmleditapp.desktop.LengthyAction

com.xmlmind.xmleditapp.desktop.file.NewAction

All Implemented Interfaces:

AppPart, NewDocumentService, ActionListener, Serializable, Cloneable, EventListener, Action

public class NewAction
extends LengthyAction
implements NewDocumentService

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	NewAction.ChooserPane
protected static class	NewAction.TemplateRenderer
protected static class	NewAction.TemplateTree

Field Summary

Fields

Modifier and Type	Field and Description
protected static IconResource	collapsedIcon
protected URL	copyURL
protected boolean	createOnly
protected static IconResource	documentIcon
protected static IconResource	expandedIcon
protected URL	inURL
protected static IconResource	newIcon
protected boolean	selectCopyURL

Fields inherited from class com.xmlmind.xmleditapp.desktop.AppAction

app, id, MODIFIERS_TOOLTIP_KEY, NO_MNEMONIC, SELECTED_ICON_KEY, UNSELECTED_ICON_KEY

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface com.xmlmind.xmleditapp.desktop.NewDocumentService

PART_ID

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
NewAction()

Method Summary

Modifier and Type	Method and Description
protected NewAction.ChooserPane	createChooserPane(Configuration[] configurations)
protected CommandResult	doExec(URL templateURL, URL saveURL, boolean createSaveFile, boolean onlyCreate)
protected void	exec() Second step of LengthyAction.doIt().
protected URL	findTemplate(String categoryName, String templateName, URL saveURL, boolean reportError)
protected static TemplateInfo.Entry[]	getAllTemplateEntries(Configuration[] configs)
protected static void	getAllTemplateEntries(Configuration[] configs, List<TemplateInfo.Entry> all)
protected static boolean	hasCategory(TemplateInfo.Entry entry, String categoryName)
protected boolean	init() First step of LengthyAction.doIt().
URL	newDocument(String categoryName, String templateName, URL saveURL, boolean createSaveFile) Create a new document.
URL	newDocument(URL templateURL, URL saveURL, boolean createSaveFile) Create a new document.
protected URL[]	promptUser(URL inURL, String showCategory, boolean selectCopyURL)
static URL	selectTemplate(App app, String title) Displays a dialog box allowing to choose a document template.
void	updateEnabled() This action should enable or disable itself using standard method setEnabled(boolean).

Methods inherited from class com.xmlmind.xmleditapp.desktop.LengthyAction

doIt, finish

Methods inherited from class com.xmlmind.xmleditapp.desktop.AppAction

actionPerformed, activeEditorChanged, applyPreferences, destroyApp, editingContextChanged, flushPreferences, getAccelerator, getApp, getDialogTitle, getIcon, getId, getLabel, getMnemonic, getMnemonicIndex, getModifiersToolTip, getSelectedIcon, getToolTip, getUnselectedIcon, hasListeners, initApp, isEditingContextSensitive, isSelected, namespacePrefixesChanged, saveStateChanged, setAccelerator, setDisabledIcons, setIcon, setLabel, setMnemonic, setMnemonicIndex, setModifiersToolTip, setSelected, setSelectedIcon, setToolTip, setUnselectedIcon, undoStateChanged, validityStateChanged, wasCtrlClick, wasRightClick, wasShiftClick

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

inURL

protected URL inURL

copyURL

protected URL copyURL

selectCopyURL

protected boolean selectCopyURL

createOnly

protected boolean createOnly

newIcon

protected static IconResource newIcon

expandedIcon

protected static IconResource expandedIcon

collapsedIcon

protected static IconResource collapsedIcon

documentIcon

protected static IconResource documentIcon

Constructor Detail

NewAction

public NewAction()

Method Detail

init

protected boolean init()

Description copied from class: LengthyAction

First step of LengthyAction.doIt(). Possibly an interactive one. It is possible to prompt the user during this step and therefore, the user can cancel the execution of the action (before it actually starts).

Specified by:

init in class LengthyAction

Returns:

true if execution should proceed; false if execution has been canceled

exec

protected void exec()

Description copied from class: LengthyAction

Second step of LengthyAction.doIt(). Actual execution of the action. A busy cursor is displayed during this step.

Specified by:

exec in class LengthyAction

doExec

protected CommandResult doExec(URL templateURL,
                               URL saveURL,
                               boolean createSaveFile,
                               boolean onlyCreate)

updateEnabled

public void updateEnabled()

Description copied from class: AppAction

This action should enable or disable itself using standard method setEnabled(boolean).

This method is invoked:

• each time the active editor changes;
• for a context sensitive action, each time the editing context changes.

Specified by:

updateEnabled in class AppAction

See Also:

AppAction.activeEditorChanged(), AppAction.editingContextChanged()

promptUser

protected URL[] promptUser(URL inURL,
                           String showCategory,
                           boolean selectCopyURL)

createChooserPane

protected NewAction.ChooserPane createChooserPane(Configuration[] configurations)

selectTemplate

public static URL selectTemplate(App app,
                                 String title)

Displays a dialog box allowing to choose a document template.

This convenience method is used by the Folder to create a copy of user-selected document template in current folder.

Parameters:

app - App used to obtain the configurations and to position the dialog box

title - title of the dialog box

Returns:

the URL of the selected document template or null if the user has canceled this action

getAllTemplateEntries

protected static TemplateInfo.Entry[] getAllTemplateEntries(Configuration[] configs)

getAllTemplateEntries

protected static void getAllTemplateEntries(Configuration[] configs,
                                            List<TemplateInfo.Entry> all)

newDocument

public URL newDocument(String categoryName,
                       String templateName,
                       URL saveURL,
                       boolean createSaveFile)

Description copied from interface: NewDocumentService

Create a new document.

If category is null, then saveURL cannot be null. In this ``saveURL'' mode, the document template used to create the new document is:

• the only document template having the same file extension (e.g. ".ditaval");
• otherwise, if there is an ambiguity (e.g. ".xml), the File|New dialog box is displayed to let the user choose a document template.

Specified by:

newDocument in interface NewDocumentService

Parameters:

categoryName - category of the document template.

Note that by default, the category of a document template is the name of the configuration containing it.

May be null in which case, this method works in ``saveURL'' mode. See above.

templateName - name of a document template. May be null in which case the first document template of the category is automatically selected.

saveURL - the URL of the newly created document. May be null in which case an "untitled" URL is automatically computed.

createSaveFile - if true and saveURL is not null, the newly created document is immediately saved at specified location

Returns:

the URL of the newly created document; null otherwise (e.g. specified category or template are not found)

findTemplate

protected URL findTemplate(String categoryName,
                           String templateName,
                           URL saveURL,
                           boolean reportError)

hasCategory

protected static final boolean hasCategory(TemplateInfo.Entry entry,
                                           String categoryName)

newDocument

public URL newDocument(URL templateURL,
                       URL saveURL,
                       boolean createSaveFile)

Description copied from interface: NewDocumentService

Create a new document.

Specified by:

newDocument in interface NewDocumentService

Parameters:

templateURL - URL of the document template

saveURL - the URL of the newly created document. May be null in which case an "untitled" URL is automatically computed.

createSaveFile - if true and saveURL is not null, the newly created document is immediately saved at specified location

Returns:

the URL of the newly created document; null otherwise (e.g. specified template cannot be opened)