com.xmlmind.xmleditapp.desktop

Class App.AppCommandEnv

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmledit.edit.CommandEnv

com.xmlmind.xmleditapp.desktop.App.AppCommandEnv

All Implemented Interfaces:

Console

Direct Known Subclasses:

App.AppLoadDocumentEnv

Enclosing class:

App

protected class App.AppCommandEnv
extends CommandEnv
implements Console

Nested Class Summary

Nested classes/interfaces inherited from interface com.xmlmind.util.Console

Console.MessageType

Field Summary

Fields inherited from class com.xmlmind.xmledit.edit.CommandEnv

commandRegistry, console, navigationHistory, systemSelection, userPreferences, xmlClipboard

Fields inherited from class com.xmlmind.util.PropertySet

properties

Constructor Summary

Constructors

Constructor and Description
AppCommandEnv()

Method Summary

Modifier and Type	Method and Description
Console	getConsole() Returns the console.
Component	getDialogParent(Component component) Returns the parent of the dialog to be created by a command.
Preferences	getUserPreferences() Returns the user preferences.
void	showMessage(String message, Console.MessageType messageType) Show specified message to user.
void	showStatus(Component component, String message, boolean autoErase) Displays specified message in the status window corresponding to specified panel.

Methods inherited from class com.xmlmind.xmledit.edit.CommandEnv

getCommandRegistry, getNavigationHistory, getSharedInstance, getSystemProperty, getSystemSelection, getXMLClipboard, invokeLater, reportError, reportInfo, reportWarning, setSharedInstance, setSystemProperty, showError, showInfo, showStatus, showWarning

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

Constructor Detail

AppCommandEnv

public AppCommandEnv()

Method Detail

getUserPreferences

public Preferences getUserPreferences()

Description copied from class: CommandEnv

Returns the user preferences.

Overrides:

getUserPreferences in class CommandEnv

getConsole

public Console getConsole()

Description copied from class: CommandEnv

Returns the console.

Overrides:

getConsole in class CommandEnv

getDialogParent

public Component getDialogParent(Component component)

Description copied from class: CommandEnv

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.

Overrides:

getDialogParent in class CommandEnv

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.

showStatus

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

Description copied from class: CommandEnv

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

Overrides:

showStatus in class CommandEnv

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

showMessage

public void showMessage(String message,
                        Console.MessageType messageType)

Description copied from interface: Console

Show specified message to user.

Specified by:

showMessage in interface Console

Parameters:

message - a possibly multi-line message

messageType - type of message: Console.MessageType.INFO, Console.MessageType.WARNING, Console.MessageType.ERROR or Console.MessageType.DEBUG.