* An application owns a {@link ApplicationModel} which provides meta-data about * the application, actions and factory methods for creating the views. *
* Depending on the document interface style used by the application, an * application can handle multiple views at the same time, or only one. *
* Typical document interface styles are the Single Document Interface (SDI), * the Multiple Document Interface (MDI) and the Mac OS X Application Interface * (OSX). Typically, for each of these styles an implementation of * {@code Application} exists. *
* Some applications have to decorate all opened windows and dialogs with * user interface elements and special behaviors. To make this work, * it is essential that all code which opens JFrame's, JDialog's or * JWindow's calls the addWindow/Palette and removeWindow/Palette methods on * the application object. *
* Typical usage of this class: *
* public class MyMainClass {
* public static void main(String[] args) {
* Application app = new SDIApplication(); // or OSXApplication(), MDIApplication().
* DefaultApplicationModel model = new DefaultApplicationModel();
* model.setName("MyApplication");
* model.setVersion("1.0");
* model.setCopyright("Copyright 2006 (c) Werner Randelshofer. All Rights Reserved.");
* model.setViewClassName("org.jhotdraw.myapplication.MyView");
* app.setModel(model);
* app.launch(args);
* }
*
* Framework
* The interfaces and classes listed below together with the {@code Action}
* classes in the org.jhotddraw.app.action package define the contracts of a
* framework for document oriented applications:
* Contract: {@link Application}, {@link ApplicationModel}, {@link View}.
*
configure() should have been invoked before the application
* is inited. Alternatively an application can be configured using setter
* methods.
*/
public void init();
/**
* Starts the application.
* This usually creates a new view, and adds it to the application.
* init() must have been invoked before the application is started.
*/
public void start();
/**
* Stops the application without saving any unsaved views.
* init() must have been invoked before the application is stopped.
*/
public void stop();
/**
* Destroys the application and calls System.exit(0).
*/
public void destroy();
/**
* Creates a new view for this application and initializes it, by calling
* {@link View#init}.
*/
public View createView();
/**
* Adds a view to this application.
* Fires a "documentCount" property change event.
* Invokes method setApplication(this) on the view object.
*/
public void add(View p);
/**
* Removes a view from this application and removes it from the users
* view.
* Fires a "documentCount" property change event.
* Invokes method setApplication(null) on the view object.
*/
public void remove(View p);
/**
* Shows a view.
*/
public void show(View p);
/**
* Hides a view.
*/
public void hide(View p);
/**
* This is a convenience method for removing a view and disposing it.
*/
public void dispose(View p);
/**
* Returns a read only collection view of the views of this application.
*/
public Collection
* This is a bound property.
*/
public View getActiveView();
/**
* Returns the enabled state of the application.
*/
public boolean isEnabled();
/**
* Sets the enabled state of the application.
*
* The enabled state is used to prevent parallel invocation of actions
* on the application. If an action consists of a sequential part and a
* concurrent part, it must disable the application only for the sequential
* part.
*
* Actions that act on the application must check in their actionPerformed
* method whether the application is enabled.
* If the application is disabled, they must do nothing.
* If the application is enabled, they must disable the application,
* perform the action and then enable the application again.
*
* This is a bound property.
*/
public void setEnabled(boolean newValue);
/**
* Adds a property change listener.
*/
public void addPropertyChangeListener(PropertyChangeListener l);
/**
* Removes a property change listener.
*/
public void removePropertyChangeListener(PropertyChangeListener l);
/**
* Returns the name of the application.
*/
public String getName();
/**
* Returns the version of the application.
*/
public String getVersion();
/**
* Returns the copyright of the application.
*/
public String getCopyright();
/**
* Sets the application model.
*/
public void setModel(ApplicationModel newValue);
/**
* Returns the application model.
*/
public ApplicationModel getModel();
/**
* Returns true, if this application shares tools among multiple views.
*/
public boolean isSharingToolsAmongViews();
/**
* Returns the application component.
* This may return null, if the application is not represented by a component
* of its own on the user interface.
*/
@Nullable public Component getComponent();
/**
* Adds a palette window to the application.
*/
public void addPalette(Window palette);
/**
* Removes a palette window from the application.
*/
public void removePalette(Window palette);
/**
* Adds a (non-palette) window to the application.
*
* @param window The window.
* @param view The View to which this window is associated, or null
* if the window is associated to the application.
*/
public void addWindow(Window window, @Nullable View view);
/**
* Removes a (non-palette) window from the application.
*/
public void removeWindow(Window window);
/**
* Returns the recently opened URIs.
* By convention, this is an immutable list.
*/
public java.util.List