com.xmlmind.xmledit.edit

Class CommandEnv

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmledit.edit.CommandEnv

Direct Known Subclasses:

App.AppCommandEnv, CommandEnvWrapper, Convert.ConvertCommandEnv

public class CommandEnv
extends PropertySet

Access to the environment info needed to execute commands.

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandRegistry	commandRegistry
protected Console	console
protected NavigationHistory	navigationHistory
protected Clipboard	systemSelection
protected Preferences	userPreferences
protected XMLClipboard	xmlClipboard

Fields inherited from class com.xmlmind.util.PropertySet

properties

Constructor Summary

Constructors

Constructor and Description
CommandEnv() Constructs an environment initialized using application-wide, shared instances of user preferences, clipboard cache, command registry, console, etc, but no navigation history.
CommandEnv(Preferences userPreferences, XMLClipboard xmlClipboard, Clipboard systemSelection, CommandRegistry commandRegistry, Console console, NavigationHistory navigationHistory) Constructs specified environment.

Method Summary

Modifier and Type	Method and Description
CommandRegistry	getCommandRegistry() Returns the command registry.
Console	getConsole() Returns the console.
Component	getDialogParent(Component component) Returns the parent of the dialog to be created by a command.
NavigationHistory	getNavigationHistory() Returns the navigation history.
static CommandEnv	getSharedInstance() Returns the shared instance of CommandEnv.
String	getSystemProperty(String key) Returns the value of specified system property.
Clipboard	getSystemSelection() Returns the system selection.
Preferences	getUserPreferences() Returns the user preferences.
XMLClipboard	getXMLClipboard() Returns the clipboard cache and thus, the underlying system clipboard.
void	invokeLater(Runnable runnable) Executes asynchronously specified task on the relevant thread.
void	reportError(String msg) Convenience method: prints specified error message on the console.
void	reportInfo(String msg) Same as reportError(java.lang.String) but for info messages.
void	reportWarning(String msg) Same as reportError(java.lang.String) but for warning messages.
static void	setSharedInstance(CommandEnv env) Installs the shared instance of CommandEnv.
String	setSystemProperty(String key, String value) Sets or clears specified system property.
void	showError(String msg, Component component) Convenience method: displays an error dialog box showing specified error message when possible; otherwise, prints message on the console.
void	showInfo(String msg, Component component) Same as showError(java.lang.String, java.awt.Component) but for info messages.
void	showStatus(Component component, String message) Equivalent to {#showStatus(Component, String, boolean) showStatus(component, message, true)}.
void	showStatus(Component component, String message, boolean autoErase) Displays specified message in the status window corresponding to specified panel.
void	showWarning(String msg, Component component) Same as showError(java.lang.String, java.awt.Component) but for warning messages.

Methods inherited from class com.xmlmind.util.PropertySet

getProperties, getProperty, getPropertyCount, hasProperty, putProperties, putProperty, removeAllProperties, removeProperty

Methods inherited from class java.lang.Object

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

Field Detail

userPreferences

protected Preferences userPreferences

xmlClipboard

protected XMLClipboard xmlClipboard

systemSelection

protected Clipboard systemSelection

commandRegistry

protected CommandRegistry commandRegistry

console

protected Console console

navigationHistory

protected NavigationHistory navigationHistory

Constructor Detail

CommandEnv

public CommandEnv()

Constructs an environment initialized using application-wide, shared instances of user preferences, clipboard cache, command registry, console, etc, but no navigation history.

See Also:

Preferences.getUserPreferences(), XMLClipboard.getSharedInstance(), ClipboardHelper.getSystemSelection(), CommandRegistry.getSharedInstance(), SimpleConsole.INSTANCE

CommandEnv

public CommandEnv(Preferences userPreferences,
                  XMLClipboard xmlClipboard,
                  Clipboard systemSelection,
                  CommandRegistry commandRegistry,
                  Console console,
                  NavigationHistory navigationHistory)

Constructs specified environment.

Method Detail

setSystemProperty

public String setSystemProperty(String key,
                                String value)

Sets or clears specified system property.

Parameters:

key - property name

value - property value; null to clear the property

Returns:

previous property value if any; null otherwise

getSystemProperty

public String getSystemProperty(String key)

Returns the value of specified system property.

Parameters:

key - property name

getUserPreferences

public Preferences getUserPreferences()

Returns the user preferences.

getXMLClipboard

public XMLClipboard getXMLClipboard()

Returns the clipboard cache and thus, the underlying system clipboard.

getSystemSelection

public Clipboard getSystemSelection()

Returns the system selection.

getCommandRegistry

public CommandRegistry getCommandRegistry()

Returns the command registry.

getConsole

public Console getConsole()

Returns the console.

reportError

public void reportError(String msg)

Convenience method: prints specified error message on the console.

See Also:

getConsole()

reportWarning

public void reportWarning(String msg)

Same as reportError(java.lang.String) but for warning messages.

reportInfo

public void reportInfo(String msg)

Same as reportError(java.lang.String) but for info messages.

getNavigationHistory

public NavigationHistory getNavigationHistory()

Returns the navigation history. May return null.

getDialogParent

public Component getDialogParent(Component component)

Returns the parent of the dialog to be created by a command. May return null, in which case the command is expected to be executed non-interactively.

Parameters:

component - any component which is a descendant of current active Window; for example the panel hosting the gadget tree.

The default implementation uses this parameter but some implementations may ignore it. In such case, it is possible to pass null.

showError

public void showError(String msg,
                      Component component)

Convenience method: displays an error dialog box showing specified error message when possible; otherwise, prints message on the console.

Parameters:

msg - the error message

component - any component which is a descendant of current active Window; for example the panel hosting the gadget tree.

The default implementation uses this parameter but some implementations may ignore it. In such case, it is possible to pass null.

See Also:

getDialogParent(java.awt.Component), reportError(java.lang.String)

showWarning

public void showWarning(String msg,
                        Component component)

Same as showError(java.lang.String, java.awt.Component) but for warning messages.

showInfo

public void showInfo(String msg,
                     Component component)

Same as showError(java.lang.String, java.awt.Component) but for info messages.

showStatus

public void showStatus(Component component,
                       String message)

Equivalent to {#showStatus(Component, String, boolean) showStatus(component, message, true)}.

showStatus

public void showStatus(Component component,
                       String message,
                       boolean autoErase)

Displays specified message in the status window corresponding to specified panel.

Parameters:

component - any component which is a descendant of current active Window; for example the panel hosting the gadget tree.

The default implementation uses this parameter but some implementations may ignore it. In such case, it is possible to pass null.

message - the message to be displayed; may be null or empty in which case the message area is immediately cleared

autoErase - if true, instruct the application to automatically erase the message after a few seconds

invokeLater

public void invokeLater(Runnable runnable)

Executes asynchronously specified task on the relevant thread.

The default implementation executes the task on the AWT event thread by invoking EventQueue.invokeLater(java.lang.Runnable).

setSharedInstance

public static final void setSharedInstance(CommandEnv env)

Installs the shared instance of CommandEnv.

See Also:

getSharedInstance()

getSharedInstance

public static final CommandEnv getSharedInstance()

Returns the shared instance of CommandEnv.

Creates and installs one if setSharedInstance(com.xmlmind.xmledit.edit.CommandEnv) has never been invoked or has been set to null.