IlvApplication (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.appframe.IlvApplication

All Implemented Interfaces:

IlvPropertyManager
```
public class IlvApplication
extends Object
implements IlvPropertyManager
```
An application centralizes all the services that are provided with the JAppFrame project.
It is mandatory that all the applications that use this project initialize an IlvApplication instance, since all the JAppFrame components initialize themselves using an instance of IlvApplication. For example, an IlvMenuBar reads the definition of its menu items from the settings of the application and internationalizes the text displayed by its menu items using the internationalization services of the application.
Services provided by the application are:
- Common services, like internationalization or settings services.
- Management of documents opened by the application.
- Swing actions of the application.
Common Services
Gather the management of the settings, internationalization services, and resolution of URLs.
- Settings: Settings are added to the application using its methods addSettings(ilog.views.appframe.settings.IlvSettings) and addXMLSettings(java.lang.String) and are removed with the removeSettings(ilog.views.appframe.settings.IlvSettings) method. Data of the added settings are cascaded according to the rules detailed in the IlvSettingsManager class. When initializing, the application automatically adds the user settings that have been saved during the last session of the application for the same user. The URL to the XML file containing the user settings can be accessed with the methods getUserSettingsURL() and setUserSettingsURL(java.net.URL).
  All the added settings can be seen as big settings where data can be selected with the methods:
  The application delegates the management of its settings to a settings manager that can be accessed with the method getSettingsManager(). Methods of the application that access the settings are only shortcuts to the same methods of the associated settings manager. However, it may be necessary to use the settings manager to access some other settings services, like creating new layers.
- Resources: String and icon resources are stored by the application. They are added with the addResourcePropertyFile(java.lang.String) method and are accessed with the methods getString(java.lang.String), getFormattedString(java.lang.String, java.lang.Object[]), and getImageIcon().
  String and icon resources of the application are in fact managed by a delegate IlvResourceBundleManager instance, which can be accessed with the method getResourceBundleManager(). Resource methods of the application are only shortcuts to the same methods of the associated resource bundle manager.
- Resolution of URLs: The application resolves URLs using its URL resolvers. URL resolvers are added to the application with the method addURLResolver(ilog.views.appframe.util.IlvURLResolver) and removed with the method removeURLResolver(ilog.views.appframe.util.IlvURLResolver). URLs are then resolved using the method resolveURL(java.lang.String).
  Stored URL resolvers are in fact managed by a delegate IlvURLResolverManager, which can be accessed with the method getURLResolverManager(). URL management methods of the application are only shortcuts to the same methods of the associated URL resolver manager.
Document/View The application is the key component of the JAppFrame Document/View architecture. As illustrated in the following figure, it handles both the document templates and the main window.
- Document templates: When initializing, the application creates a document template for each <documentTemplate> root setting element it has selected from its settings. The list of document templates it has created can be retrieved with the methods getDocumentTemplate(int) and getDocumentTemplateCount().
  Additional document templates can be added to the application using its addDocumentTemplate(ilog.views.appframe.docview.IlvDocumentTemplate) method. This can be useful for adding document templates that override some default behavior of the IlvDocumentTemplate class.
- Main Window: The main window of the application must be registered with the application after it has been initialized, by invoking the method setMainWindow(ilog.views.appframe.docview.IlvMainWindow). It can be retrieved with the method getMainWindow().
The application is involved in all the steps of the life cycle of documents. It creates the documents, gives access to the active document, and allows for saving and closing documents.
- Creating documents: The application automatically handles the event of the predefined actions OPEN_DOCUMENT_CMD and NEW_DOCUMENT_CMD with the methods openDocument() and newDocument() respectively. It is also possible to open a document for a specified pathname with the method openDocumentFile(java.lang.String, boolean, boolean) and to create a new document that matches the class of a specified object with the method newDocument(Object, boolean).
- Accessing the active document, view, and container: They are accessible with the methods getActiveDocument(boolean), getActiveView(boolean), and getActiveViewContainer() respectively.
- Saving documents: with the methods saveActiveDocument(boolean), saveAsActiveDocument(boolean), and saveAllDocuments().
- Closing documents: with the methods closeActiveDocument(boolean), closeAllDocuments(boolean) and closeDocument(ilog.views.appframe.docview.IlvDocument, boolean).
Swing actions
The application centralizes all the services relative to Swing actions. When initializing, the application creates IlvAction instances for each <action> root setting element it has selected from its settings. New actions can be added to the application with the method addAction(javax.swing.Action) and removed with the method removeAction(javax.swing.Action).
The JAppFrame project has changed the semantic of Swing actions. They no longer handle the events emitted by menu items or buttons associated with them. They only contain display properties that allow for creating associated menu items or buttons. As all those properties can be specified from the settings of the action - as described for the IlvAction class - it is no longer necessary to implement action classes.
The application delegates the processing of action events to its registered action handlers by implementing the interface ActionHandler. An action handler is responsible for both processing action events and updating the properties of the action. From the lowest to the highest priority, the application automatically registers the following action handlers:
- The application itself.
- The document template of the active document, if any.
- The MDI client, like an IlvDesktopPane or an IlvMDITabbedPane, for handling actions of the Windows menu.
- The active document.
- The active view.
It is also possible to register new action handlers with the method addActionHandler(ilog.views.appframe.event.ActionHandler) and to remove them with the method removeActionHandler(ilog.views.appframe.event.ActionHandler).
Processing action events
From the highest to the lowest priority, action handlers are required to process the action events. The first action handler that processes the event stops the calling chain.
Updating actions
As in processing action events, the action handlers are required to update the state of the actions, from the highest to the lowest priority. The first action handler that succeeds in updating the action stops the calling chain.
Updates of actions are automatically triggered when the application initializes and each time the active view of the application changes. However, it is possible to trigger the application update mechanism for one or more actions with the methods updateAction(java.lang.String), updateActionsByCategory(java.lang.String) and updateActions().
Since:

JViews 5.5

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLOSE_ALL_DOCUMENTS_CMD` Action command key for the action that closes all the open documents.
`static String`	`CLOSE_DOCUMENT_CMD` Action command key for the action that closes the active document.
`static String`	`EXIT_CMD` Action command key for the action that exits the application.
`static String`	`ICON_PROPERTY` Bound property name for the icon of the application.
`static String`	`MAIN_WINDOW_PROPERTY` Bound property name for the main window of the application.
`static String`	`MENU_BAR_PROPERTY` Bound property name for the menu bar of the application main window.
`static String`	`NEW_DOCUMENT_CMD` Action command key for the action that creates a new document.
`static String`	`NEW_DOCUMENT_ON_LAST_TEMPLATE_CMD` Action command key for the action that creates a new document of the same type as the type of the last document created with the `newDocument()` method.
`static String`	`OPEN_DOCUMENT_CMD` Action command key for the action that opens a document.
`static int`	`OPEN_FILE_MUST_EXIST` File chooser constant that determines whether the file selected in the file chooser should exist.
`static int`	`OPEN_MODE` File chooser constant that specifies that the file chooser is displayed for opening a file.
`static int`	`OPEN_MULTIPLE_FILES` File chooser constant that determines whether multiple files can be selected within the file chooser.
`static String`	`REVERT_DOCUMENT_CMD` Action command key for the `Revert Document` action.
`static String`	`SAVE_ALL_DOCUMENTS_CMD` Action command key for the action that saves all modified documents.
`static String`	`SAVE_AS_DOCUMENT_CMD` Action command key for the `Save as` action.
`static int`	`SAVE_AS_MODE` File chooser constant that specifies that the file chooser is displayed for changing a filename while processing a `SaveAs` action.
`static String`	`SAVE_DOCUMENT_CMD` Action command key for the `Save` action.
`static int`	`SAVE_MODE` File chooser constant that specifies that the file chooser is displayed for changing a filename.
`static String`	`SETTINGS_TYPE` Type of settings element providing the settings of the application, such as its title or icon.
`static String`	`STATUS_BAR_PROPERTY` Bound property name for the status bar of the application main window.
`static String`	`STATUS_MESSAGE` Name of the message to send to the application to make a string message appear in the status bar of the main window of the application.
`static String`	`TITLE_PROPERTY` Bound property name for the title of the application.

Constructor Summary

Constructors
Constructor and Description
`IlvApplication()` Creates a new `IlvApplication` with the name `Default`.
`IlvApplication(String applicationName)` Creates a new application with the specified name.
`IlvApplication(String[] args)` Creates the application with the specified command line parameters.
`IlvApplication(String name, String[] args)` Creates a new `IlvApplication` with the specified command line parameters and the specified name.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAction(Action action)` Adds an action to the actions managed by the application.
`void`	`addActionHandler(ActionHandler handler)` Adds the specified action handler to receive action events.
`void`	`addApplicationListener(ApplicationListener listener)` Adds an application listener for receiving application events.
`void`	`addApplicationListener(String templateName, ApplicationListener listener)` Adds an application listener to receive application events for a specific document template.
`void`	`addClassLoader(ClassLoader classLoader)` Adds the specified `classLoader` to the list of class loaders managed by the application for loading classes and finding resources.
`void`	`addDocumentTemplate(IlvDocumentTemplate docTemplate)` Adds the specified document template to the application.
`void`	`addLocaleSettingsListener(LocaleSettingsListener listener)` Adds a locale setting listener to listen to changes that occur to the locale of the application.
`void`	`addMessageListener(MessageListener listener, String name)` Adds the specified message `listener` to receive message event sent to the application.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a listener that listens to the changes in the properties of this application.
`void`	`addResourceBundle(ResourceBundle bundle)` Adds the specified resource `bundle` to the list of resource bundles managed by this application.
`ResourceBundle`	`addResourcePropertyFile(String baseName)` Adds the specified resource bundle to the list of resource bundles managed by the application.
`boolean`	`addSettings(IlvSettings settings)` Adds new settings to the application.
`void`	`addSettingsListener(SettingsListener listener)` Adds a settings listener to listen to settings events.
`void`	`addURLResolver(IlvURLResolver resolver)` Adds the specified URL resolver to the application.
`IlvXMLSettings`	`addXMLSettings(String filename)` Adds XML settings to the application.
`IlvXMLSettings`	`addXMLSettings(URL url)` Adds the XML settings file with the specified URL.
`HashMap<Component,Cursor>`	`applyCursor(Cursor cursor)` Sets a new cursor on all windows.
`void`	`attachDocument(IlvDocument parentDocument, IlvDocument document)` Attaches the specified `document` to the specified `parentDocument`.
`boolean`	`canCreateDocument(Object userData)` Determines whether the application can create a document for the specified `userData`.
`boolean`	`close(boolean force)` Tries to end the application.
`boolean`	`closeActiveDocument(boolean mdiDocument)` Closes the current active document in the application.
`boolean`	`closeAllDocuments(boolean endSession)` Closes all the documents opened in the application.
`boolean`	`closeDocument(IlvDocument document, boolean force)` Closes the specified document in the application.
`void`	`commitSettingsChanges()` Commits the changes that occurred on the application settings to the user settings.
`protected IlvDocumentTemplate`	`createDocumentTemplate(String name)` Deprecated. As of JViews 6.0, replaced with `createDocumentTemplate(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement)`. This method is now invoked from this last method.
`protected IlvDocumentTemplate`	`createDocumentTemplate(String name, IlvSettingsElement element)` Creates a document template with the specified `name`.
`void`	`detachDocument(IlvDocument parentDocument, IlvDocument document)` Detaches the specified `document` from the specified `parentDocument`.
`IlvDocument`	`findDocument(String pathname)` Finds an open document with the specified `pathname`.
`protected void`	`fireApplicationEvent(ApplicationEvent event)` Notifies all the application listeners registered with the application that the specified application `event` has occurred.
`protected void`	`fireLocaleSettingsEvent(LocaleSettingsEvent event)` Fires the specified locale setting `event` to the locale setting listeners added to the application.
`protected void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)` Support method for notifying changes on the application properties: if `oldValue` and `newValue` are equal, this method does nothing.
`String`	`getAbbreviateForm(URL url)` Returns the abbreviated form of the specified URL.
`Action`	`getAction(String command)` Retrieves an action by its command key.
`ActionHandler[]`	`getActionHandlers(String actionCommand)` Returns an array of action handlers which can process actions with the specified `actionCommand`.
`IlvDocument`	`getActiveDocument(boolean mdiDocument)` Returns the document currently active in the application.
`IlvDocumentView`	`getActiveView(boolean mdiDocument)` Returns the document view currently active in the application.
`IlvViewContainer`	`getActiveViewContainer()` Returns the container of the active document view.
`Applet`	`getApplet()` Returns the main window of the application as an applet.
`Class<?>`	`getClassForName(String classname)` Retrieves a class for the specified `classname`.
`ClassLoader`	`getClassLoader()` Returns the class loader associated with the application.
`ComponentOrientation`	`getComponentOrientation()` Returns the component orientation of the application.
`protected String`	`getDefaultUserSettingsPathname()` Returns the default pathname of the XML file that contains the settings for the current application user.
`URL`	`getDocumentBase()` Returns the document base URL.
`IlvDocumentTemplate`	`getDocumentTemplate(int index)` Returns the document template at the specified storage `index` in the set of document templates managed by this application.
`IlvDocumentTemplate`	`getDocumentTemplate(String name)` Retrieves the document template with the specified `name`.
`int`	`getDocumentTemplateCount()` Returns the number of document templates managed by this application.
`String`	`getFormattedString(String format, Object[] params)` Returns the string resulting from the formatting of the specified `format` with the parameters contained in the `params` array of objects.
`ImageIcon`	`getImageIcon()` Returns the icon of the application.
`ImageIcon`	`getImageIcon(String filename)` Returns an image icon for the specified filename.
`Locale`	`getLocale()` Returns the locale of the application.
`Component`	`getMainComponent()` Returns the main window of the application as a `Component`.
`Container`	`getMainContainer()` Returns the main window of the application as a container.
`IlvMainWindow`	`getMainWindow()` Returns the main window associated with the application.
`String`	`getName()` Returns the name of the application.
`IlvDocument[]`	`getOpenDocuments()` Returns all the open documents in the application.
`IlvDocument[]`	`getOpenDocuments(IlvDocumentTemplate documentTemplate)` Returns all the documents open in the application for the specified `documentTemplate`.
`int`	`getOpenedDocumentCount()` Returns the number of open documents in the application.
`Object`	`getProperty(String key)` Returns the property of the application with the specified key.
`IlvRecentFileList`	`getRecentFileList()` Returns the recent file list used by the application to store the Most Recently Used files.
`String`	`getRecentOpenedFile(int index)` Returns the pathname at the specified storage `index` in the Most Recently Used file list managed by the application.
`int`	`getRecentOpenedFileCount()` Returns the number of pathnames stored in the Most Recently Used file list of the application.
`IlvResourceBundleManager`	`getResourceBundleManager()` Returns the resource bundle manager associated with the locale of this application.
`IlvSettings[]`	`getSettings()` Returns the settings managed by this application.
`IlvSettings`	`getSettings(String name)` Finds the settings with the specified `name`.
`IlvSettingsManager`	`getSettingsManager()` Returns the settings manager that manages all the settings of the application.
`String`	`getSoftwareProvider()` Returns the software provider name.
`IlvSplashWindow`	`getSplashWindow()` Returns the splash window currently displayed while the application is initializing.
`String`	`getString(String key)` Retrieves a string resource for the specified key.
`String`	`getTitle()` Returns the title of the application.
`IlvURLResolverManager`	`getURLResolverManager()` Returns the URL resolver manager used by the application to resolve URLs.
`URL`	`getUserHomeDirectory()` Returns the home directory of the current application user.
`String`	`getUserSettingsSubDirectory()` Returns the subdirectory that is used for constructing the pathname of the XML file containing the user settings for the current application user.
`URL`	`getUserSettingsURL()` Returns the URL of the XML file containing the settings of the current application user.
`boolean`	`initialize()` Initializes the application.
`void`	`initializeFileChooser(JFileChooser fileChooser, String initialPathName, int mode, IlvFileDocumentTemplate fileTemplate)` Initializes a file chooser dialog.
`boolean`	`isApplet()` Determines whether the main window of this application is an applet.
`boolean`	`isInitialized()` Determines whether the application is initialized.
`boolean`	`isValidDocumentFile(String pathname)` Returns if the given pathname corresponds to a file that is accepted by this application.
`IlvDocument`	`newDocument()` Creates a new document.
`IlvDocument`	`newDocument(IlvDocumentTemplate docTemplate, boolean createViews, Object userData)` Creates a new document for the specified document template.
`IlvDocument`	`newDocument(Object userData, boolean createViews)` Creates a new document that embeds the specified `userData`.
`IlvDocument`	`newDocumentOnLastTemplate()` Creates a new document for the same document template as the one selected in the New Document dialog box the last time it was launched.
`IlvDocument`	`openDocument()` Prompts for a document file name and opens the corresponding document.
`IlvDocument`	`openDocument(IlvFileDocumentTemplate docTemplate)` Opens a document for the specified document template.
`IlvDocument`	`openDocumentFile(String pathname, boolean createViews, boolean addToMRU)` Opens a document with the specified `pathname`.
`IlvDocument`	`openRecentOpenedFile(int index)` Opens or activates the document file corresponding to the pathname stored at specified `index` in the list of Most Recently Used files managed by the application.
`protected void`	`quit()` Quits the application.
`void`	`readApplicationSettings()` Reads the settings of the application as the name, title, or icon of the application.
`void`	`removeAction(Action action)` Removes an action from the list of actions managed by the application.
`void`	`removeActionHandler(ActionHandler handler)` Removes the specified action handler from the list of action handlers managed by the application.
`void`	`removeApplicationListener(ApplicationListener listener)` Removes the specified application listener, so that it no longer receives application events.
`void`	`removeApplicationListener(String templateName, ApplicationListener listener)` Removes the specified listener, so that it no longer receives application events.
`boolean`	`removeClassLoader(ClassLoader classLoader)` Removes the specified `classLoader` from the list of class loaders managed by the application.
`boolean`	`removeDocumentTemplate(IlvDocumentTemplate documentTemplate)` Removes the specified `documentTemplate` from the list of document templates managed by the application.
`boolean`	`removeLocaleSettingsListener(LocaleSettingsListener listener)` Removes the specified locale setting listener from the list of listeners managed by the application.
`void`	`removeMessageListener(MessageListener listener)` Removes the specified message `listener` from the list of message listeners managed by the application.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes the specified listener from the list of `PropertyChange` listeners managed by the application.
`ResourceBundle`	`removeResourcePropertyFile(String baseName)` Removes the resource bundle with the specified `baseName` from the application.
`boolean`	`removeSettings(IlvSettings settings)` Removes the specified settings from the list of settings stored by the application.
`boolean`	`removeSettingsListener(SettingsListener listener)` Removes the specified settings listener from the list of settings listeners managed by the settings manager of the application.
`boolean`	`removeURLResolver(IlvURLResolver resolver)` Removes the specified URL resolver from the list of resolvers managed by the application.
`URL`	`resolveURL(String filename)` Resolves a URL from the specified `filename`.
`void`	`restoreCursor()` Deprecated. replaced by `restoreCursor(java.util.HashMap<java.awt.Component, java.awt.Cursor>)`
`void`	`restoreCursor(HashMap<Component,Cursor> targetComponents)` Restores the saved cursors on components.
`boolean`	`saveActiveDocument(boolean mdiDocument)` Saves the document currently active in the application.
`boolean`	`saveAllDocuments()` Saves all the modified documents open in the application.
`boolean`	`saveAsActiveDocument(boolean mdiDocument)` Saves the active document under another file name.
`boolean`	`saveDocument(IlvDocument document)` Saves the specified `document`.
`boolean`	`saveDocument(String pathname)` Saves the document with the specified `pathname`.
`boolean`	`saveDocumentModifications(IlvDocument document)` Saves the modifications of the specified document.
`IlvSettingsElement[]`	`select(IlvSettingsQuery query)` Returns the settings elements selected by the specified query.
`IlvSettingsElement[]`	`select(IlvSettingsQuery query, IlvSettingsElement[] contextElements)` Returns the settings elements selected by the specified query starting from the specified settings elements.
`IlvSettingsElement[]`	`select(String type, IlvSettingsElement[] contextElements)` Returns the settings elements selected by the specified query parameters.
`IlvSettingsElement`	`selectElement(IlvSettingsQuery query)` Returns the first settings element selected by the specified query.
`IlvSettingsElement`	`selectElement(String type, String attributeName, Object attributeValue)` Returns the first settings element selected by the specified query parameters.
`void`	`sendActionEvent(ActionEvent e)` Sends an action event to the action handlers of the application.
`void`	`sendActionEvent(String actionCommand)` Sends an action event to the action listeners of the application.
`void`	`sendMessage(String targetName, MessageEvent messageEvent)` Sends the specified message event to all the message listeners registered with the application.
`void`	`sendMessage(String targetName, Object source, String messageName, Object[] params)` Sends the message `messageName` to the target `targetName` with the parameters `params`.
`void`	`setActiveDocument(IlvDocument document, IlvDocumentView view, boolean mdiDocument)` Sets the active document of the application.
`void`	`setActiveView(IlvDocumentView view, boolean mdiDocument)` Sets the active document view of this application.
`void`	`setCursor(Cursor cursor)` Deprecated. replaced by `applyCursor(java.awt.Cursor)` less prone to memory leaks
`void`	`setDocumentBase(URL documentBase)` Sets the document base URL of the application.
`void`	`setImageIcon(ImageIcon icon)` Sets the icon of the application to the specified `icon`.
`void`	`setLocale(Locale locale)` Sets the locale for the application.
`void`	`setMainWindow(IlvMainWindow window)` Sets the main window of the application.
`void`	`setName(String name)` Sets the name of the application.
`Object`	`setProperty(String key, Object value)` Sets one of the properties of the application using the associated key.
`void`	`setResourceBundleManager(IlvResourceBundleManager manager)` Sets the resource bundle manager that will manage the resource bundles of the application.
`void`	`setSoftwareProvider(String name)` Sets the software provider.
`void`	`setSplashWindow(IlvSplashWindow splashWindow)` Sets a splash window for the application.
`void`	`setTitle(String title)` Sets the title of the application to the specified string.
`void`	`setUserHomeDirectory(URL url)` Sets the home directory for the current application user.
`void`	`setUserSettingsSubDirectory(String subDirectory)` Sets the sub directory that is used for constructing the pathname of the XML file containing the user settings for the current application user.
`void`	`setUserSettingsURL(URL url)` Sets the URL that accesses the settings of the current application user.
`IlvFileChooserSelection[]`	`showFileChooser(String initialPathName, String title, int mode, IlvFileDocumentTemplate initialTemplate, Component parent)` Displays a file chooser dialog.
`boolean`	`updateAction(Action action)` Asks for the display properties of the specified `action` to be updated.
`boolean`	`updateAction(String command)` Asks for the display properties of the action with the specified command key to be updated.
`void`	`updateActions()` Asks for the display properties of all the actions that are represented in all of the menu bars and toolbars of the main window of the application to be updated.
`void`	`updateActionsByCategory(String category)` Asks for the display properties of all the actions that belong to the specified `category` to be updated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLOSE_ALL_DOCUMENTS_CMD
```
public static final String CLOSE_ALL_DOCUMENTS_CMD
```
    Action command key for the action that closes all the open documents.
    
    See Also:
    
    Constant Field Values
  - CLOSE_DOCUMENT_CMD
```
public static final String CLOSE_DOCUMENT_CMD
```
    Action command key for the action that closes the active document.
    
    See Also:
    
    Constant Field Values
  - OPEN_DOCUMENT_CMD
```
public static final String OPEN_DOCUMENT_CMD
```
    Action command key for the action that opens a document.
    
    See Also:
    
    Constant Field Values
  - NEW_DOCUMENT_CMD
```
public static final String NEW_DOCUMENT_CMD
```
    Action command key for the action that creates a new document.
    
    See Also:
    
    newDocument(), Constant Field Values
  - NEW_DOCUMENT_ON_LAST_TEMPLATE_CMD
```
public static final String NEW_DOCUMENT_ON_LAST_TEMPLATE_CMD
```
    Action command key for the action that creates a new document of the same type as the type of the last document created with the newDocument() method.
    
    See Also:
    
    newDocumentOnLastTemplate(), Constant Field Values
  - SAVE_ALL_DOCUMENTS_CMD
```
public static final String SAVE_ALL_DOCUMENTS_CMD
```
    Action command key for the action that saves all modified documents.
    
    See Also:
    
    Constant Field Values
  - SAVE_DOCUMENT_CMD
```
public static final String SAVE_DOCUMENT_CMD
```
    Action command key for the Save action.
    
    See Also:
    
    Constant Field Values
  - SAVE_AS_DOCUMENT_CMD
```
public static final String SAVE_AS_DOCUMENT_CMD
```
    Action command key for the Save as action.
    
    See Also:
    
    Constant Field Values
  - REVERT_DOCUMENT_CMD
```
public static final String REVERT_DOCUMENT_CMD
```
    Action command key for the Revert Document action.
    
    See Also:
    
    Constant Field Values
  - EXIT_CMD
```
public static final String EXIT_CMD
```
    Action command key for the action that exits the application.
    
    See Also:
    
    Constant Field Values
  - OPEN_MULTIPLE_FILES
```
public static final int OPEN_MULTIPLE_FILES
```
    File chooser constant that determines whether multiple files can be selected within the file chooser. This mode is used only if combined with the mode OPEN_MODEL.
    
    See Also:
    
    Constant Field Values
  - OPEN_FILE_MUST_EXIST
```
public static final int OPEN_FILE_MUST_EXIST
```
    File chooser constant that determines whether the file selected in the file chooser should exist. This mode is used only if combined with the mode OPEN_MODEL.
    
    See Also:
    
    Constant Field Values
  - OPEN_MODE
```
public static final int OPEN_MODE
```
    File chooser constant that specifies that the file chooser is displayed for opening a file.
    
    See Also:
    
    Constant Field Values
  - SAVE_MODE
```
public static final int SAVE_MODE
```
    File chooser constant that specifies that the file chooser is displayed for changing a filename.
    
    See Also:
    
    Constant Field Values
  - SAVE_AS_MODE
```
public static final int SAVE_AS_MODE
```
    File chooser constant that specifies that the file chooser is displayed for changing a filename while processing a SaveAs action.
    
    See Also:
    
    Constant Field Values
  - TITLE_PROPERTY
```
public static final String TITLE_PROPERTY
```
    Bound property name for the title of the application.
    
    See Also:
    
    Constant Field Values
  - ICON_PROPERTY
```
public static final String ICON_PROPERTY
```
    Bound property name for the icon of the application.
    
    See Also:
    
    Constant Field Values
  - STATUS_MESSAGE
```
public static final String STATUS_MESSAGE
```
    Name of the message to send to the application to make a string message appear in the status bar of the main window of the application.
    
    See Also:
    
    Constant Field Values
  - STATUS_BAR_PROPERTY
```
public static final String STATUS_BAR_PROPERTY
```
    Bound property name for the status bar of the application main window.
    
    See Also:
    
    Constant Field Values
  - MENU_BAR_PROPERTY
```
public static final String MENU_BAR_PROPERTY
```
    Bound property name for the menu bar of the application main window.
    
    See Also:
    
    Constant Field Values
  - MAIN_WINDOW_PROPERTY
```
public static final String MAIN_WINDOW_PROPERTY
```
    Bound property name for the main window of the application.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - SETTINGS_TYPE
```
public static final String SETTINGS_TYPE
```
    Type of settings element providing the settings of the application, such as its title or icon.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvApplication
```
public IlvApplication()
```
    Creates a new IlvApplication with the name Default.
  - IlvApplication
```
public IlvApplication(String applicationName)
```
    Creates a new application with the specified name.
    
    Parameters:
    
    applicationName - The name of the application.
    
    See Also:
    
    setName(java.lang.String), getName()
  - IlvApplication
```
public IlvApplication(String[] args)
```
    Creates the application with the specified command line parameters. By default, the command line parameters are parsed as follows:
    - If a parameter is equal to the string "-Unregister", the application does not read and write the user settings.
    - The newDocument() method is called for each parameter that are equal to the string "-newDocument".
    - All parameters that are not equal to "-Unregister" or "-newDocument" are considered as file pathnames. For each specified pathname, the method openDocumentFile(java.lang.String, boolean, boolean) is invoked. If the specified pathname is a relative path, it is resolved with the resolveURL(java.lang.String) method.
    Parameters:
    
    args - The command line parameters.
  - IlvApplication
```
public IlvApplication(String name,
                      String[] args)
```
    Creates a new IlvApplication with the specified command line parameters and the specified name.
    
    Parameters:
    
    name - The name of the application
    
    args - The command line parameters.
    
    See Also:
    
    setName(java.lang.String), getName(), IlvApplication(String[])
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of the application.
    
    See Also:
    
    setName(java.lang.String)
  - setName
```
public void setName(String name)
```
    Sets the name of the application.
    
    Parameters:
    
    name - The new name of the application
    
    See Also:
    
    getName()
  - setTitle
```
public void setTitle(String title)
```
    Sets the title of the application to the specified string. This title appears in both the message dialogs launched by the application and in the title bar of the main window.
    The specified string should be a key to a resource string. Triggers a property change for the TITLE_PROPERTY.
    
    Parameters:
    
    title - The new title of the application.
    
    See Also:
    
    getTitle(), TITLE_PROPERTY
  - getTitle
```
public String getTitle()
```
    Returns the title of the application.
    
    See Also:
    
    setTitle(java.lang.String), TITLE_PROPERTY
  - setImageIcon
```
public void setImageIcon(ImageIcon icon)
```
    Sets the icon of the application to the specified icon. The icon appears in both the title bar of the Swing main window of the application and in the title bar of the message dialogs launched by the application.
    Triggers a property change for the ICON_PROPERTY.
    
    Parameters:
    
    icon - The new icon of the application.
    
    See Also:
    
    getImageIcon(), ICON_PROPERTY
  - getImageIcon
```
public ImageIcon getImageIcon()
```
    Returns the icon of the application.
    
    See Also:
    
    setImageIcon(javax.swing.ImageIcon)
  - sendActionEvent
```
public void sendActionEvent(ActionEvent e)
```
    Sends an action event to the action handlers of the application.
    For each action handler of the application, the application invokes first the method ActionHandler.isProcessingAction(String) of the action handler to determine whether it is able to process the action. If yes, the ActionListener.actionPerformed(java.awt.event.ActionEvent) of the action handler is called and the calling chain is stopped. Otherwise, the next action handler in the calling chain is invoked.
    
    Parameters:
    
    e - The action event to send.
    
    See Also:
    
    sendActionEvent(String), updateAction(String), getAction(String)
  - sendActionEvent
```
public void sendActionEvent(String actionCommand)
```
    Sends an action event to the action listeners of the application.
    A new ActionEvent is created with the specified action command and is given as the argument of the sendActionEvent(java.awt.event.ActionEvent) method.
    
    Parameters:
    
    actionCommand - the action command to build an action event from
    
    See Also:
    
    sendActionEvent(java.awt.event.ActionEvent), updateAction(String), getAction(String)
  - sendMessage
```
public void sendMessage(String targetName,
                        Object source,
                        String messageName,
                        Object[] params)
```
    Sends the message messageName to the target targetName with the parameters params.
    
    Parameters:
    
    targetName - The name of the target to which the message is sent. If null, the message will be sent to all the message listeners registered with the application.
    
    source - The object that sent the message.
    
    messageName - The name of the message.
    
    params - The parameters of the message.
    
    See Also:
    
    addMessageListener(ilog.views.appframe.event.MessageListener, java.lang.String)
  - sendMessage
```
public void sendMessage(String targetName,
                        MessageEvent messageEvent)
```
    Sends the specified message event to all the message listeners registered with the application.
    
    Parameters:
    
    targetName - The name of the target to which the message is sent. If null, the message will be sent to all the listeners registered with the application.
    
    messageEvent - The message event sent to the message listeners of the application.
    
    See Also:
    
    addMessageListener(ilog.views.appframe.event.MessageListener, java.lang.String)
  - addMessageListener
```
public void addMessageListener(MessageListener listener,
                               String name)
```
    Adds the specified message listener to receive message event sent to the application.
    
    Parameters:
    
    listener - The new message listener to add.
    
    name - The name of the listener.
    
    See Also:
    
    removeMessageListener(MessageListener)
  - removeMessageListener
```
public void removeMessageListener(MessageListener listener)
```
    Removes the specified message listener from the list of message listeners managed by the application.
    
    Parameters:
    
    listener - The message listener to remove.
    
    See Also:
    
    addMessageListener(MessageListener, String)
  - addActionHandler
```
public void addActionHandler(ActionHandler handler)
```
    Adds the specified action handler to receive action events.
    
    Parameters:
    
    handler - The action handler to add.
    
    See Also:
    
    removeActionHandler(ActionHandler)
  - getActionHandlers
```
public ActionHandler[] getActionHandlers(String actionCommand)
```
    Returns an array of action handlers which can process actions with the specified actionCommand.
    For all the action handlers added to this application with the method addActionHandler(ilog.views.appframe.event.ActionHandler), the implementation of this method invokes the method ActionHandler.isProcessingAction(java.lang.String) the action handlers and selects the one which return true for the specified actionCommand as the parameter.
    The action handlers are stored in the returned array according to which order they are invoked for processing an action. The action handler at the index 0 will be the first - and the only one - to be invoked for processing the action with the actionCommand. If this action handler is removed from the application, the action handler at the index 1 will be the first to be invoked, and so on.
    As action handlers are susceptible to process several action commands, note that it can be dangerous to remove action handlers which behavior is not known from the remover.
    
    Parameters:
    
    actionCommand - The action command key.
    
    See Also:
    
    addActionHandler(ActionHandler), removeActionHandler(ActionHandler)
  - removeActionHandler
```
public void removeActionHandler(ActionHandler handler)
```
    Removes the specified action handler from the list of action handlers managed by the application.
    
    Parameters:
    
    handler - The handler to remove.
    
    See Also:
    
    addActionHandler(ilog.views.appframe.event.ActionHandler)
  - getAction
```
public Action getAction(String command)
```
    Retrieves an action by its command key. The application searches among the actions that have been automatically built from the settings or added with the method addAction(javax.swing.Action) for the action with property Action.ACTION_COMMAND_KEY equal to the specified command.
    
    Parameters:
    
    command - The command key of the action to retrieve.
    
    Returns:
    
    The action with the specified command key - can be null if no actions could be found.
  - addAction
```
public void addAction(Action action)
```
    Adds an action to the actions managed by the application. This method can be called to add specific user actions that are not described in the settings of the application. The ActionListener.actionPerformed(java.awt.event.ActionEvent) method of the action is called when an action event occurs for this action.
    
    Parameters:
    
    action - The new action to add.
    
    See Also:
    
    getAction(java.lang.String), removeAction(javax.swing.Action)
  - removeAction
```
public void removeAction(Action action)
```
    Removes an action from the list of actions managed by the application.
    
    Parameters:
    
    action - The action to remove.
    
    See Also:
    
    addAction(javax.swing.Action)
  - initialize
```
public boolean initialize()
```
    Initializes the application. The application initializes itself and all the objects, such as document templates or menu bars, that initialize themselves from the settings.
    When this method is invoked, it is recommended that all the settings, resource property files, and URL resolvers should have previously been added to the application.
    
    Returns:
    
    true if the application can be initialized; false otherwise.
    
    See Also:
    
    isInitialized()
  - isInitialized
```
public boolean isInitialized()
```
    Determines whether the application is initialized. The application is initialized after its initialize() method has been invoked.
    
    Returns:
    
    true if the application is initialized; false otherwise.
    
    See Also:
    
    initialize()
  - close
```
public boolean close(boolean force)
```
    Tries to end the application. The application tries to close all the open documents and then calls the method quit().
    
    Parameters:
    
    force - If true, the user cannot cancel the closing operation and all the open documents are closed even if they are modified. If false, the user is prompted to save modified open documents. At this stage, he/she can cancel the operation.
    
    Returns:
    
    true if the application can terminate; false otherwise.
  - addSettings
```
public boolean addSettings(IlvSettings settings)
```
    Adds new settings to the application. The specified settings are added to the settings manager associated with this application in the IlvSettingsManager.APPLICATION_DATA_LAYER.
    
    Parameters:
    
    settings - The settings to add.
    
    See Also:
    
    addXMLSettings(java.net.URL), addXMLSettings(String), IlvSettingsManager, getSettingsManager(), removeSettings(ilog.views.appframe.settings.IlvSettings)
  - addXMLSettings
```
public IlvXMLSettings addXMLSettings(String filename)
```
    Adds XML settings to the application. The specified file name is resolved into a URL using the URL resolvers set to the application. XML settings are then created and read from this file and added to the settings manager associated with this application in the layer IlvSettingsManager.APPLICATION_DATA_LAYER.
    
    Parameters:
    
    filename - The file name of the XML file to add.
    
    Returns:
    
    The newly created IlvXMLSettings instance if the operation is successful; null if the specified file name could not be resolved into a valid pathname or if the content of this file does not correspond to a valid XML file.
    
    See Also:
    
    addSettings(ilog.views.appframe.settings.IlvSettings), addXMLSettings(java.net.URL), IlvSettingsManager, addURLResolver(ilog.views.appframe.util.IlvURLResolver), IlvXMLSettings, addSettings(ilog.views.appframe.settings.IlvSettings), getSettingsManager(), removeSettings(ilog.views.appframe.settings.IlvSettings)
  - addXMLSettings
```
public IlvXMLSettings addXMLSettings(URL url)
```
    Adds the XML settings file with the specified URL. XML settings are created and read from this file and added to the settings manager associated with the application, in the IlvSettingsManager.APPLICATION_DATA_LAYER.
    
    Parameters:
    
    url - The URL of the XML settings file to add.
    
    Returns:
    
    The newly created IlvXMLSettings instance if the operation is successful; null, if the content of this file does not correspond to a valid XML file.
    
    See Also:
    
    addSettings(ilog.views.appframe.settings.IlvSettings), addXMLSettings(String), IlvSettingsManager, addURLResolver(ilog.views.appframe.util.IlvURLResolver), IlvXMLSettings, addSettings(ilog.views.appframe.settings.IlvSettings), getSettingsManager(), removeSettings(ilog.views.appframe.settings.IlvSettings)
  - removeSettings
```
public boolean removeSettings(IlvSettings settings)
```
    Removes the specified settings from the list of settings stored by the application.
    
    Returns:
    
    true if the specified settings belong to the application; false otherwise.
    
    See Also:
    
    addSettings(ilog.views.appframe.settings.IlvSettings), addXMLSettings(String), addXMLSettings(java.net.URL), IlvSettingsManager, getSettingsManager()
  - getSettings
```
public IlvSettings getSettings(String name)
```
    Finds the settings with the specified name.
    
    Parameters:
    
    name - The name of the settings to retrieve.
    
    Returns:
    
    The settings with the specified name or null if no settings could be found with this name.
  - getSettings
```
public IlvSettings[] getSettings()
```
    Returns the settings managed by this application.
    
    Returns:
    
    The array of settings managed by this application.
  - addSettingsListener
```
public void addSettingsListener(SettingsListener listener)
```
    Adds a settings listener to listen to settings events.
    
    Parameters:
    
    listener - The listener to add.
    
    See Also:
    
    removeSettingsListener(ilog.views.appframe.settings.SettingsListener)
  - removeSettingsListener
```
public boolean removeSettingsListener(SettingsListener listener)
```
    Removes the specified settings listener from the list of settings listeners managed by the settings manager of the application.
    
    Parameters:
    
    listener - The listener to remove.
    
    Returns:
    
    true if the listener was previously added to the application; false otherwise.
    
    See Also:
    
    addSettingsListener(ilog.views.appframe.settings.SettingsListener)
  - getSettingsManager
```
public IlvSettingsManager getSettingsManager()
```
    Returns the settings manager that manages all the settings of the application.
    
    Returns:
    
    The settings manager of the application.
  - selectElement
```
public IlvSettingsElement selectElement(IlvSettingsQuery query)
```
    Returns the first settings element selected by the specified query.
    This method is a shortcut for selecting an element from the settings manager associated with the application.
    
    Parameters:
    
    query - The query that selects the element to retrieve.
    
    Returns:
    
    The first settings element that matches the specified query or null if no settings element could be found.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement, IlvSettingsManager, selectElement(String, String, Object)
  - selectElement
```
public IlvSettingsElement selectElement(String type,
                                        String attributeName,
                                        Object attributeValue)
```
    Returns the first settings element selected by the specified query parameters. Root setting elements with the specified type are selected first. The first element of this selection with attribute attributeName value equal to attributeValue is returned.
    This method is a shortcut for selecting an element from the settings manager associated with the application.
    
    Parameters:
    
    type - The type of the element to retrieve.
    
    attributeName - The name of the attribute to match the value from.
    
    attributeValue - The value of the attribute to be compared.
    
    Returns:
    
    The first settings element that matches the specified query or null if no settings elements could be found.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement, IlvSettingsManager, selectElement(ilog.views.appframe.settings.IlvSettingsQuery)
  - select
```
public IlvSettingsElement[] select(IlvSettingsQuery query)
```
    Returns the settings elements selected by the specified query.
    This method is a shortcut for selecting elements from the settings manager associated with this application with the specified query.
    
    Parameters:
    
    query - The query that selects the elements to be returned.
    
    Returns:
    
    The array of settings elements that match the specified query.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement, IlvSettingsManager, select(String, ilog.views.appframe.settings.IlvSettingsElement[])
  - select
```
public IlvSettingsElement[] select(String type,
                                   IlvSettingsElement[] contextElements)
```
    Returns the settings elements selected by the specified query parameters.
    This method is a shortcut for selecting elements from the settings manager associated with the application.
    
    Parameters:
    
    type - The type of the settings elements to select.
    
    contextElements - The elements to start the selection from. If null, the selection starts from the root elements of all the settings added to the application.
    
    Returns:
    
    The array of settings elements that match the specified query.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement, IlvSettingsManager, select(ilog.views.appframe.settings.IlvSettingsQuery), IlvSettingsElement.getChildren(String)
  - select
```
public IlvSettingsElement[] select(IlvSettingsQuery query,
                                   IlvSettingsElement[] contextElements)
```
    Returns the settings elements selected by the specified query starting from the specified settings elements.
    This method is a shortcut for selecting elements from the settings manager associated with the application.
    
    Parameters:
    
    query - The query that selects the elements to retrieve.
    
    contextElements - The elements to start the selection from. If null, the selection starts from the root elements of all the settings added to the application.
    
    Returns:
    
    The array of settings elements that match the specified query.
    
    See Also:
    
    IlvSettingsElement.getChildren(ilog.views.appframe.settings.IlvSettingsQuery), select(String, ilog.views.appframe.settings.IlvSettingsElement[])
  - commitSettingsChanges
```
public void commitSettingsChanges()
```
    Commits the changes that occurred on the application settings to the user settings.
  - addLocaleSettingsListener
```
public void addLocaleSettingsListener(LocaleSettingsListener listener)
```
    Adds a locale setting listener to listen to changes that occur to the locale of the application.
    
    Parameters:
    
    listener - The listener to add.
    
    See Also:
    
    removeLocaleSettingsListener(ilog.views.appframe.settings.LocaleSettingsListener)
  - removeLocaleSettingsListener
```
public boolean removeLocaleSettingsListener(LocaleSettingsListener listener)
```
    Removes the specified locale setting listener from the list of listeners managed by the application.
    
    Parameters:
    
    listener - The listener to remove.
    
    Returns:
    
    true if the listener was previously added to the application; false otherwise.
    
    See Also:
    
    addLocaleSettingsListener(ilog.views.appframe.settings.LocaleSettingsListener)
  - fireLocaleSettingsEvent
```
protected void fireLocaleSettingsEvent(LocaleSettingsEvent event)
```
    Fires the specified locale setting event to the locale setting listeners added to the application.
    
    Parameters:
    
    event - The event to fire.
    
    See Also:
    
    addLocaleSettingsListener(ilog.views.appframe.settings.LocaleSettingsListener)
  - setMainWindow
```
public void setMainWindow(IlvMainWindow window)
```
    Sets the main window of the application.
    
    Parameters:
    
    window - The main window to associate with the application.
    
    See Also:
    
    getMainWindow(), MAIN_WINDOW_PROPERTY
  - getMainComponent
```
public Component getMainComponent()
```
    Returns the main window of the application as a Component.
    
    Returns:
    
    The main window component; null if no main window has been associated with the application or if the main window is not a component.
    
    See Also:
    
    getMainWindow()
  - getMainWindow
```
public IlvMainWindow getMainWindow()
```
    Returns the main window associated with the application.
    
    See Also:
    
    getMainContainer(), setMainWindow(ilog.views.appframe.docview.IlvMainWindow)
  - getMainContainer
```
public Container getMainContainer()
```
    Returns the main window of the application as a container.
    
    Returns:
    
    The main window container; null if no main window has been associated with the application or if the main window is not a container.
    
    See Also:
    
    getMainWindow()
  - isApplet
```
public boolean isApplet()
```
    Determines whether the main window of this application is an applet.
    
    Returns:
    
    true if the main window is an applet; false otherwise.
    
    See Also:
    
    getApplet()
  - getApplet
```
public Applet getApplet()
```
    Returns the main window of the application as an applet.
    
    Returns:
    
    The applet; null if the main window of the application is not an applet.
    
    See Also:
    
    isApplet()
  - readApplicationSettings
```
public void readApplicationSettings()
```
    Reads the settings of the application as the name, title, or icon of the application.
    
    Since:
    
    JViews 8.8
  - createDocumentTemplate
```
protected IlvDocumentTemplate createDocumentTemplate(String name,
                                                     IlvSettingsElement element)
```
    Creates a document template with the specified name. This method is invoked when the application creates its document templates from the settings. This method can be overridden to provide a specific document template for the specified document template name. By default, a new instance of IlvFileDocumentTemplate is returned.
    
    Parameters:
    
    name - The name of the document template to create.
    
    element - The settings element that defines the document template to create.
    
    Returns:
    
    The newly created document template.
  - createDocumentTemplate
```
@Deprecated
protected IlvDocumentTemplate createDocumentTemplate(String name)
```
    Deprecated. As of JViews 6.0, replaced with createDocumentTemplate(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement). This method is now invoked from this last method.
    
    Creates a document template with the specified name. This method is invoked when the application creates its document templates from the settings. This method can be overridden to provide a specific document template for the specified document template name. By default, a new instance of IlvFileDocumentTemplate is returned.
    
    Parameters:
    
    name - The name of the document template to create.
    
    Returns:
    
    The newly created document template.
  - getDocumentTemplateCount
```
public int getDocumentTemplateCount()
```
    Returns the number of document templates managed by this application.
    
    Returns:
    
    The number of document templates.
    
    See Also:
    
    getDocumentTemplate(int)
  - getDocumentTemplate
```
public IlvDocumentTemplate getDocumentTemplate(int index)
```
    Returns the document template at the specified storage index in the set of document templates managed by this application.
    
    Parameters:
    
    index - The storage index of the document template to return.
    
    Returns:
    
    The document template at the specified index.
    
    See Also:
    
    getDocumentTemplateCount()
  - getDocumentTemplate
```
public IlvDocumentTemplate getDocumentTemplate(String name)
```
    Retrieves the document template with the specified name.
    
    Parameters:
    
    name - The name of the document template to retrieve.
    
    Returns:
    
    The document template with the specified name or null if no document template can be found with this name.
  - addDocumentTemplate
```
public void addDocumentTemplate(IlvDocumentTemplate docTemplate)
```
    Adds the specified document template to the application. If the application already contains a document template with the same name as the name of the new document template, it is removed and replaced by the new document template.
    Since document templates should be specified in settings and automatically created by the application, this method is useful for specifying an IlvDocumentTemplate inheriting class instance for a specific type of document.
    
    Parameters:
    
    docTemplate - The new document template to be added.
    
    See Also:
    
    removeDocumentTemplate(ilog.views.appframe.docview.IlvDocumentTemplate)
  - removeDocumentTemplate
```
public boolean removeDocumentTemplate(IlvDocumentTemplate documentTemplate)
```
    Removes the specified documentTemplate from the list of document templates managed by the application. The method tries first to close the documents that have been opened by the document template. A save confirmation dialog is displayed for documents with the specified document template that have been modified. If the application user presses the Cancel button, the document cannot be closed and the removal process of the document template will be stopped.
    
    Parameters:
    
    documentTemplate - The document template to remove.
    
    Returns:
    
    true if the document template can be removed or false if the document template was not previously added to the application or if a document with this document template cannot be closed.
    
    See Also:
    
    addDocumentTemplate(ilog.views.appframe.docview.IlvDocumentTemplate)
  - openDocument
```
public IlvDocument openDocument()
```
    Prompts for a document file name and opens the corresponding document.
    
    Returns:
    
    The new open document or null if the user has canceled the file chooser dialog or if the creation of the document failed.
  - openDocument
```
public IlvDocument openDocument(IlvFileDocumentTemplate docTemplate)
```
    Opens a document for the specified document template.
    A file chooser is displayed first for selecting a pathname. Only pathnames that match the filters of the specified document template can be selected by the file chooser. If a pathname has been selected, a corresponding document is then opened by the specified document template.
    
    Parameters:
    
    docTemplate - The document template that specifies the type of document the file chooser can select.
    
    Returns:
    
    The new open document, if the method is successful, or null if the user cancels the file chooser or if a document could not be opened for the selected pathname.
  - openDocumentFile
```
public IlvDocument openDocumentFile(String pathname,
                                    boolean createViews,
                                    boolean addToMRU)
```
    Opens a document with the specified pathname. If an open document is found with the same pathname, it will be activated and the method will return this document. Otherwise, a new document is created by the file document template of the application that matches the specified pathname.
    
    Parameters:
    
    pathname - The file to open.
    
    createViews - If true, document views will be created for the document as specified in the settings of the document template. If false, no document view is created.
    
    addToMRU - If true, the specified pathname is added to the Most Recently Used file list managed by the application. If false, the pathname is not added to this list.
    
    Returns:
    
    The document with the specified pathname or null if no file document template matches the pathname or if the newly created document cannot be initialized from the specified file.
    
    See Also:
    
    openDocument(), IlvFileDocumentTemplate.matchPathName(java.net.URL)
  - isValidDocumentFile
```
public boolean isValidDocumentFile(String pathname)
```
    Returns if the given pathname corresponds to a file that is accepted by this application.
    
    Parameters:
    
    pathname - The file to validate
    
    Returns:
    
    true if the file is accepted by this application
    
    Since:
    
    JViews 8.1
  - initializeFileChooser
```
public void initializeFileChooser(JFileChooser fileChooser,
                                  String initialPathName,
                                  int mode,
                                  IlvFileDocumentTemplate fileTemplate)
```
    Initializes a file chooser dialog. The specified file chooser is filled with the file filters of the specified file document template.
    Parameters:
    
    fileChooser - The file chooser to initialize.
    
    initialPathName - The pathname to select in the file chooser. If null, the last selected pathname will be selected.
    mode - The mode for opening the file chooser. This mode must be a combination of one or more of the following constants:
    
    OPEN_MODE
    
    SAVE_MODE
    
    SAVE_AS_MODE
    
    OPEN_MULTIPLE_FILES
    
    OPEN_FILE_MUST_EXIST
    fileTemplate - The document template file that provides the file filters to set to the file chooser. If null, all the document template files of the application are used for initializing the file chooser filters.
    
    See Also:
    
    IlvFileDocumentTemplate.initializeFileChooser(javax.swing.JFileChooser, boolean), showFileChooser(java.lang.String, java.lang.String, int, ilog.views.appframe.docview.IlvFileDocumentTemplate, java.awt.Component)
  - showFileChooser
```
public IlvFileChooserSelection[] showFileChooser(String initialPathName,
                                                 String title,
                                                 int mode,
                                                 IlvFileDocumentTemplate initialTemplate,
                                                 Component parent)
```
    Displays a file chooser dialog.
    Parameters:
    
    initialPathName - The pathname to select in the file chooser. If null, the last selected pathname is selected.
    
    title - The title to display in the file chooser. If null, a default title will be displayed, depending on the mode the file chooser is opened in.
    mode - The mode for opening the file chooser. This mode must be a combination of one or more of the following constant values:
    
    OPEN_MODE
    
    SAVE_MODE
    
    SAVE_AS_MODE
    
    OPEN_MULTIPLE_FILES
    
    OPEN_FILE_MUST_EXIST
    initialTemplate - The document template file that provides the file filters of the file chooser. If null, all the document template files specified to the application are used for initializing the file chooser filters.
    
    parent - The parent component of the file chooser dialog; see JFileChooser.showDialog(java.awt.Component, java.lang.String) for details. If null, it is set to the main window of the application if it is a component.
    
    Returns:
    
    The array of pathnames the user has selected or null if no pathnames are chosen.
  - newDocument
```
public IlvDocument newDocument()
```
    Creates a new document. This method is invoked when processing the action with the command key NEW_DOCUMENT_CMD. If at least two document templates are registered, a dialog box will be shown to let the user select the type of document to create (the document template with which to create the new document).
    The selected document template or the only document template in the application creates a new empty document with its views as specified in the settings of the document template.
    
    Returns:
    
    The newly created document or null if the user cancels the new document dialog or if the application has no document templates.
    
    See Also:
    
    newDocumentOnLastTemplate(), NEW_DOCUMENT_CMD
  - newDocumentOnLastTemplate
```
public IlvDocument newDocumentOnLastTemplate()
```
    Creates a new document for the same document template as the one selected in the New Document dialog box the last time it was launched.
    This method is invoked when processing the action with the command key NEW_DOCUMENT_ON_LAST_TEMPLATE_CMD.
    If the application has only one document template, it will automatically be selected and this method will have the same behavior as the newDocument() method.
    If no document template has previously been selected in the New Document dialog box and if more than one document template can be selected for creating a new document, the New Dialog box will be launched.
    
    Returns:
    
    The newly created document or null if the user cancels the New Document dialog or if the new document cannot be created or initialized.
    
    See Also:
    
    newDocument(), NEW_DOCUMENT_ON_LAST_TEMPLATE_CMD
  - newDocument
```
public IlvDocument newDocument(IlvDocumentTemplate docTemplate,
                               boolean createViews,
                               Object userData)
```
    Creates a new document for the specified document template.
    
    Parameters:
    
    docTemplate - The document template to use for creating a new document.
    
    createViews - If true, document views are created for the newly created document as defined in the settings of the specified document template.
    
    userData - The user data given as the parameter to the IlvDocument.initializeDocument(java.lang.Object) method of the newly created document.
    
    Returns:
    
    The newly created document, if the method is successful, or false otherwise.
    
    See Also:
    
    newDocument(Object, boolean)
  - newDocument
```
public IlvDocument newDocument(Object userData,
                               boolean createViews)
```
    Creates a new document that embeds the specified userData.
    The method IlvDocumentTemplate.matchData(java.lang.Object) of all the document templates of the application is called with the specified data as the parameter. The returned matching level that is the closest to 0 and positive selects the document template that will create the document associated with the data. If two document templates have the same matching level for the data, the first document template added to the application will be selected. If no matching document template can be found, no document will be created.
    
    Parameters:
    
    userData - The data to create an embedded document for. It is given as the parameter to the IlvDocument.initializeDocument(java.lang.Object) method of the newly created document.
    
    createViews - If true, document views will be created for the newly created document as defined in the settings of the selected document template.
    
    See Also:
    
    newDocument(ilog.views.appframe.docview.IlvDocumentTemplate, boolean, Object), canCreateDocument(java.lang.Object)
  - canCreateDocument
```
public boolean canCreateDocument(Object userData)
```
    Determines whether the application can create a document for the specified userData.
    
    Returns:
    
    true if at least one document template registered with the application matches the specified userData or false otherwise.
    
    See Also:
    
    newDocument(Object, boolean), IlvDocumentTemplate.matchData(java.lang.Object)
  - saveAllDocuments
```
public boolean saveAllDocuments()
```
    Saves all the modified documents open in the application.
    
    Returns:
    
    true if all the modified documents can be saved or false if the application user has canceled the saving operation when prompted to save a modified document.
  - quit
```
protected void quit()
```
    Quits the application. This method is invoked by the close(boolean) method after checking that the application can be closed. At this stage, all the documents opened by the application have been closed.
    The default implementation of this method invokes the code System.exit(0). It can be overridden in order not to exit the application.
  - closeAllDocuments
```
public boolean closeAllDocuments(boolean endSession)
```
    Closes all the documents opened in the application.
    
    Parameters:
    
    endSession - The value true specifies that this method is called during a process that must end the session. The user is not prompted for saving the modified documents open in the application. If false, the user will be prompted to save modifications for each modified document. The user is then able to cancel the operation.
    
    Returns:
    
    true if all the open documents could be closed or false otherwise. It can fail if the application user has canceled the saving operation when prompted to save a modified document.
  - closeActiveDocument
```
public boolean closeActiveDocument(boolean mdiDocument)
```
    Closes the current active document in the application. This method is invoked for processing the CLOSE_DOCUMENT_CMD action event.
    
    Parameters:
    
    mdiDocument - Same meaning as the parameter of the getActiveDocument(boolean) method. When called for processing the CLOSE_DOCUMENT_CMD action event, this parameter is true.
    
    Returns:
    
    true if the active document has been closed or false if the application does not contain any documents or if the active document could not be closed.
    
    See Also:
    
    getActiveDocument(boolean), closeDocument(ilog.views.appframe.docview.IlvDocument, boolean)
  - closeDocument
```
public boolean closeDocument(IlvDocument document,
                             boolean force)
```
    Closes the specified document in the application. All the document views relative to the document are closed.
    
    Parameters:
    
    document - The document to close
    
    force - If true, the document will be closed, even though it has been modified, without asking the user for confirmation. If false, the user is asked to save the document if it has been modified and can cancel the operation.
    
    Returns:
    
    true if the specified document could be closed; false otherwise.
    
    See Also:
    
    IlvDocumentTemplate.closeDocument(ilog.views.appframe.docview.IlvDocument, boolean), closeActiveDocument(boolean)
  - saveActiveDocument
```
public boolean saveActiveDocument(boolean mdiDocument)
```
    Saves the document currently active in the application.
    
    Parameters:
    
    mdiDocument - Same meaning as the parameter of the getActiveDocument(boolean) method. When called for processing the SAVE_DOCUMENT_CMD action event, this parameter is true.
    
    Returns:
    
    true, if the application contains an active document and if this document can be saved; false otherwise.
    
    See Also:
    
    saveDocument(IlvDocument), getActiveDocument(boolean)
  - saveDocument
```
public boolean saveDocument(String pathname)
```
    Saves the document with the specified pathname.
    
    Parameters:
    
    pathname - The pathname of the document to save. It must have the syntax of a URL.
    
    Returns:
    
    true if saving is successful; false otherwise.
  - saveDocument
```
public boolean saveDocument(IlvDocument document)
```
    Saves the specified document.
    
    Parameters:
    
    document - The document to save.
    
    Returns:
    
    true if the document could be saved; false otherwise.
  - saveDocumentModifications
```
public boolean saveDocumentModifications(IlvDocument document)
```
    Saves the modifications of the specified document.
    If the document is not modified, this method will do nothing and will return true.
    If the document is modified, the application user will be prompted for saving the specified document.
    
    Parameters:
    
    document - the document to save.
    
    Returns:
    
    true if the document could be saved successfully; false otherwise.
  - saveAsActiveDocument
```
public boolean saveAsActiveDocument(boolean mdiDocument)
```
    Saves the active document under another file name. Prompts the user for a new file name and then saves the document.
    
    Parameters:
    
    mdiDocument - Same meaning as the parameter of the getActiveDocument(boolean) method. When called for processing the SAVE_AS_DOCUMENT_CMD action event, this parameter is true.
    
    Returns:
    
    true, if the active document has been saved; false otherwise.
  - findDocument
```
public IlvDocument findDocument(String pathname)
```
    Finds an open document with the specified pathname.
    
    Parameters:
    
    pathname - The pathname of the document to find. It must have the syntax of a URL.
    
    Returns:
    
    The document with the specified pathname; null if no documents could be found.
  - getOpenedDocumentCount
```
public int getOpenedDocumentCount()
```
    Returns the number of open documents in the application.
  - getOpenDocuments
```
public IlvDocument[] getOpenDocuments()
```
    Returns all the open documents in the application.
    
    Returns:
    
    The array of all the documents open in the application.
  - getOpenDocuments
```
public IlvDocument[] getOpenDocuments(IlvDocumentTemplate documentTemplate)
```
    Returns all the documents open in the application for the specified documentTemplate.
    
    Parameters:
    
    documentTemplate - The document template to retrieve the open documents from.
    
    Returns:
    
    The array of open documents.
  - openRecentOpenedFile
```
public IlvDocument openRecentOpenedFile(int index)
```
    Opens or activates the document file corresponding to the pathname stored at specified index in the list of Most Recently Used files managed by the application.
    
    Parameters:
    
    index - The index in the Most Recently Used file list. The value 0 corresponds to the most recently used file.
    
    Returns:
    
    The document opened for this file or null if the MRU list is empty or if the pathname at the specified index is no longer valid.
    
    See Also:
    
    getRecentFileList(), getRecentOpenedFile(int)
  - getRecentOpenedFile
```
public String getRecentOpenedFile(int index)
```
    Returns the pathname at the specified storage index in the Most Recently Used file list managed by the application.
    
    Parameters:
    
    index - the index in the MRU file list.
    
    Returns:
    
    The pathname at the specified index or null if the MRU file list is empty.
    
    See Also:
    
    getRecentFileList()
  - getRecentOpenedFileCount
```
public int getRecentOpenedFileCount()
```
    Returns the number of pathnames stored in the Most Recently Used file list of the application.
    
    See Also:
    
    getRecentFileList(), getRecentOpenedFile(int)
  - getRecentFileList
```
public IlvRecentFileList getRecentFileList()
```
    Returns the recent file list used by the application to store the Most Recently Used files.
  - getActiveDocument
```
public IlvDocument getActiveDocument(boolean mdiDocument)
```
    Returns the document currently active in the application. If the value of the mdiDocument parameter is true, the document currently active in the MDI client of the main window of the application is returned, even if another document view not contained by the MDI client (a static view) is currently active. If the value of the mdiDocument parameter is false, the document view currently active in the application is returned, even if it is in the MDI client zone of the main window of the application.
    
    Parameters:
    
    mdiDocument - If true, the view currently active in the MDI client zone of the main window of the application is returned; if false, the document view currently active is returned.
    
    Returns:
    
    The active document - can be null if no document is currently active in the application.
    
    See Also:
    
    setActiveDocument(ilog.views.appframe.docview.IlvDocument, ilog.views.appframe.docview.IlvDocumentView, boolean), getActiveView(boolean)
  - setActiveDocument
```
public void setActiveDocument(IlvDocument document,
                              IlvDocumentView view,
                              boolean mdiDocument)
```
    Sets the active document of the application.
    
    Parameters:
    
    document - The open document to activate in the application.
    
    view - The view of the specified document that has been activated.
    
    mdiDocument - Same meaning as the parameter of the getActiveDocument(boolean) method.
    
    See Also:
    
    getActiveDocument(boolean), setActiveView(ilog.views.appframe.docview.IlvDocumentView, boolean)
  - setActiveView
```
public void setActiveView(IlvDocumentView view,
                          boolean mdiDocument)
```
    Sets the active document view of this application.
    
    Parameters:
    
    view - The document view that has the focus in the application.
    
    mdiDocument - Same meaning as the parameter of the getActiveDocument(boolean) method.
  - getActiveView
```
public IlvDocumentView getActiveView(boolean mdiDocument)
```
    Returns the document view currently active in the application.
    
    Parameters:
    
    mdiDocument - Same meaning as the parameter of the getActiveDocument(boolean) method.
    
    Returns:
    
    The active document view - can be null if no document view is currently active in the application.
    
    See Also:
    
    setActiveView(ilog.views.appframe.docview.IlvDocumentView, boolean), getActiveDocument(boolean)
  - getActiveViewContainer
```
public IlvViewContainer getActiveViewContainer()
```
    Returns the container of the active document view.
    
    Returns:
    
    The active document view container.
  - addApplicationListener
```
public void addApplicationListener(ApplicationListener listener)
```
    Adds an application listener for receiving application events.
    
    Parameters:
    
    listener - The application listener to add.
    
    See Also:
    
    removeApplicationListener(ilog.views.appframe.event.ApplicationListener)
  - addApplicationListener
```
public void addApplicationListener(String templateName,
                                   ApplicationListener listener)
```
    Adds an application listener to receive application events for a specific document template. The listener will be invoked only when an application event has been triggered for a document or a document view belonging to the specified document template.
    
    Parameters:
    
    templateName - The name of the document template for which document events will be fired to the listener.
    
    listener - The application listener to add.
    
    See Also:
    
    removeApplicationListener(String, ilog.views.appframe.event.ApplicationListener)
  - removeApplicationListener
```
public void removeApplicationListener(ApplicationListener listener)
```
    Removes the specified application listener, so that it no longer receives application events.
    
    Parameters:
    
    listener - The application listener to remove.
    
    See Also:
    
    addApplicationListener(ilog.views.appframe.event.ApplicationListener)
  - removeApplicationListener
```
public void removeApplicationListener(String templateName,
                                      ApplicationListener listener)
```
    Removes the specified listener, so that it no longer receives application events.
    
    Parameters:
    
    templateName - The name of the document template for which document and view events were fired to the listener.
    
    listener - The application listener to remove.
    
    See Also:
    
    addApplicationListener(String, ilog.views.appframe.event.ApplicationListener)
  - fireApplicationEvent
```
protected void fireApplicationEvent(ApplicationEvent event)
```
    Notifies all the application listeners registered with the application that the specified application event has occurred.
    
    See Also:
    
    addApplicationListener(ilog.views.appframe.event.ApplicationListener)
  - attachDocument
```
public void attachDocument(IlvDocument parentDocument,
                           IlvDocument document)
```
    Attaches the specified document to the specified parentDocument. When closing, the parentDocument first closes its attached documents, containing the specified document.
    
    Parameters:
    
    parentDocument - The document to attach a document to.
    
    document - The document to attach.
    
    See Also:
    
    detachDocument(ilog.views.appframe.docview.IlvDocument, ilog.views.appframe.docview.IlvDocument)
  - detachDocument
```
public void detachDocument(IlvDocument parentDocument,
                           IlvDocument document)
```
    Detaches the specified document from the specified parentDocument. As a consequence, the parentDocument does not close the document when it closes itself.
    
    Parameters:
    
    parentDocument - The document to detach a document from.
    
    document - The document to detach.
    
    See Also:
    
    attachDocument(ilog.views.appframe.docview.IlvDocument, ilog.views.appframe.docview.IlvDocument)
  - updateAction
```
public boolean updateAction(String command)
```
    Asks for the display properties of the action with the specified command key to be updated. For example, the action can be enabled or disabled in response to this request.
    This method asks all its registered ActionHandler handlers to update the action, from the action handler of highest priority to the lowest. The first action handler that handles the action update stops the calling chain.
    All menu items and buttons within menu bars and toolbars that are associated with this action automatically reflect the property changes.
    
    Parameters:
    
    command - The command key of the action to be updated.
    
    Returns:
    
    true if an action with the specified command key has been found and if this action has been successfully updated; false otherwise.
    
    See Also:
    
    updateAction(javax.swing.Action), updateActionsByCategory(java.lang.String), ActionHandler.updateAction(javax.swing.Action)
  - updateAction
```
public boolean updateAction(Action action)
```
    Asks for the display properties of the specified action to be updated. This method use the same update mechanism as described for the method updateAction(String).
    
    Returns:
    
    true if the action could be updated; false otherwise.
    
    See Also:
    
    updateAction(String), updateActionsByCategory(java.lang.String), ActionHandler.updateAction(javax.swing.Action)
  - updateActions
```
public void updateActions()
```
    Asks for the display properties of all the actions that are represented in all of the menu bars and toolbars of the main window of the application to be updated. The same update mechanism is used as the one described for the method updateAction(String).
  - updateActionsByCategory
```
public void updateActionsByCategory(String category)
```
    Asks for the display properties of all the actions that belong to the specified category to be updated. Action categories are defined in the settings of the action as described for the IlvAction class. The same update mechanism is used as the one described for the method updateAction(String).
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Returns the class loader associated with the application. The class loader uses the URL resolvers of the application for locating the resources.
    If the application is running in an applet context, null is returned.
    
    See Also:
    
    addClassLoader(java.lang.ClassLoader), removeClassLoader(java.lang.ClassLoader)
  - addClassLoader
```
public void addClassLoader(ClassLoader classLoader)
```
    Adds the specified classLoader to the list of class loaders managed by the application for loading classes and finding resources.
    
    Parameters:
    
    classLoader - The class loader to add.
    
    See Also:
    
    removeClassLoader(java.lang.ClassLoader), getClassLoader()
  - removeClassLoader
```
public boolean removeClassLoader(ClassLoader classLoader)
```
    Removes the specified classLoader from the list of class loaders managed by the application.
    
    Parameters:
    
    classLoader - The class loader to remove.
    
    Returns:
    
    true if the class loader was previously added to the application; false otherwise.
    
    See Also:
    
    addClassLoader(java.lang.ClassLoader), getClassLoader()
  - getClassForName
```
public Class<?> getClassForName(String classname)
```
    Retrieves a class for the specified classname. The class is searched for in the system class loader and within all the class loaders added to the application.
    
    Parameters:
    
    classname - The classname to retrieve a class from.
    
    Returns:
    
    The class instance corresponding to the specified classname or null if no class is found with the specified name.
  - setLocale
```
public void setLocale(Locale locale)
```
    Sets the locale for the application.
    
    Parameters:
    
    locale - The new locale of the application.
    
    See Also:
    
    getLocale()
  - getLocale
```
public Locale getLocale()
```
    Returns the locale of the application.
    
    See Also:
    
    setLocale(java.util.Locale)
  - getResourceBundleManager
```
public IlvResourceBundleManager getResourceBundleManager()
```
    Returns the resource bundle manager associated with the locale of this application.
    
    See Also:
    
    IlvResourceBundleManager, setResourceBundleManager(ilog.views.appframe.util.IlvResourceBundleManager)
  - setResourceBundleManager
```
public void setResourceBundleManager(IlvResourceBundleManager manager)
```
    Sets the resource bundle manager that will manage the resource bundles of the application.
    
    Parameters:
    
    manager - The new resource bundle manager.
    
    See Also:
    
    getResourceBundleManager()
  - addResourcePropertyFile
```
public ResourceBundle addResourcePropertyFile(String baseName)
```
    Adds the specified resource bundle to the list of resource bundles managed by the application.
    
    Parameters:
    
    baseName - The base property filename to create a resource bundle from.
    
    Returns:
    
    The newly created resource bundle that corresponds to the specified property base file name and the current locale or null if no resource bundle can be created.
    
    See Also:
    
    addResourceBundle(java.util.ResourceBundle), removeResourcePropertyFile(java.lang.String)
  - removeResourcePropertyFile
```
public ResourceBundle removeResourcePropertyFile(String baseName)
```
    Removes the resource bundle with the specified baseName from the application.
    
    Parameters:
    
    baseName - The base name that was used for creating the resource bundle to be removed.
    
    Returns:
    
    The resource bundle corresponding to the specified baseName and the current locale or null if the resource bundle has not been added to the manager.
    
    See Also:
    
    addResourcePropertyFile(java.lang.String)
  - addResourceBundle
```
public void addResourceBundle(ResourceBundle bundle)
```
    Adds the specified resource bundle to the list of resource bundles managed by this application.
    
    Parameters:
    
    bundle - The new resource bundle.
  - getImageIcon
```
public ImageIcon getImageIcon(String filename)
```
    Returns an image icon for the specified filename. The application checks first whether the specified filename is a key to a string resource providing another filename. Then, the application tries to resolve the filename into a valid URL. If a valid URL can be created, a new image icon is created for this URL.
    If an image icon has already been created with the same file name, it is returned.
    
    Parameters:
    
    filename - The file name of the image icon to retrieve - can be a key to a string resource.
    
    Returns:
    
    The image icon for the specified file name or null if no image icons created for this file name could be found.
  - getString
```
public String getString(String key)
```
    Retrieves a string resource for the specified key.
    
    Parameters:
    
    key - The Key of the string resource to retrieve.
    
    Returns:
    
    The string resource. If no string resource has been defined for this key, no exception is thrown and the key is returned instead.
  - getFormattedString
```
public String getFormattedString(String format,
                                 Object[] params)
```
    Returns the string resulting from the formatting of the specified format with the parameters contained in the params array of objects.
    See the documentation of the java.text.MessageFormat class for the details of the format protocol.
    
    Parameters:
    
    format - The format to be used - can be a key to a string resource.
    
    params - The array of parameters used for the formatting.
    
    Returns:
    
    The formatted string.
  - getComponentOrientation
```
public ComponentOrientation getComponentOrientation()
```
    Returns the component orientation of the application.
    An right-to-left component orientation is enabled if the resource bundle has an entry "Orientation=RTL", regardless of the locale.
    
    Since:
    
    JViews 8.8
  - applyCursor
```
public HashMap<Component,Cursor> applyCursor(Cursor cursor)
```
    Sets a new cursor on all windows. Typical use is:
```
 HashMap list = application.applyCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
 try {
        ...
 } finally {
   application.restoreCursor(list);
 }
 
```
    Parameters:
    
    cursor - the new cursor
    
    Returns:
    
    The list of saved cursors.
    
    See Also:
    
    restoreCursor(java.util.HashMap<java.awt.Component, java.awt.Cursor>)
  - restoreCursor
```
public void restoreCursor(HashMap<Component,Cursor> targetComponents)
```
    Restores the saved cursors on components.
    
    Parameters:
    
    targetComponents - the list returned by applyCursor(java.awt.Cursor)
    
    See Also:
    
    applyCursor(java.awt.Cursor)
  - setCursor
```
@Deprecated
public void setCursor(Cursor cursor)
```
    Deprecated. replaced by applyCursor(java.awt.Cursor) less prone to memory leaks
    
    Changes the cursor for the entire application with the newly specified cursor. The previous cursor is saved and is restored by calling the method restoreCursor(java.util.HashMap<java.awt.Component, java.awt.Cursor>).
    
    Parameters:
    
    cursor - The new cursor for the application frame.
    
    See Also:
    
    restoreCursor(java.util.HashMap<java.awt.Component, java.awt.Cursor>)
  - restoreCursor
```
@Deprecated
public void restoreCursor()
```
    Deprecated. replaced by restoreCursor(java.util.HashMap<java.awt.Component, java.awt.Cursor>)
    
    Restores the cursor previously selected before the last call to the setCursor(java.awt.Cursor) method.
  - getUserSettingsURL
```
public URL getUserSettingsURL()
```
    Returns the URL of the XML file containing the settings of the current application user. If a URL was specified using the method setUserSettingsURL(java.net.URL), it will be returned. Otherwise, the implementation of this method tries to construct a URL from the pathname returned by the method getDefaultUserSettingsPathname().
    
    Returns:
    
    The user settings URL or null if the URL could not be constructed.
  - setUserSettingsURL
```
public void setUserSettingsURL(URL url)
```
    Sets the URL that accesses the settings of the current application user. Use of this method overrides the default mechanism that constructs the URL for the user settings as explained for the method getDefaultUserSettingsPathname()
    
    Parameters:
    
    url - The URL that accesses the user settings XML file.
  - getDefaultUserSettingsPathname
```
protected String getDefaultUserSettingsPathname()
```
    Returns the default pathname of the XML file that contains the settings for the current application user. This pathname is constructed as follows:
    <User Home>/<SoftwareProvider>/<Sub directory>/<Application name>/settings.xml where:
    - <User Home> is the user home directory accessed with the methods getUserHomeDirectory() and setUserHomeDirectory(java.net.URL).
    - <SoftwareProvider> is the software provider accessed with the methods getSoftwareProvider() and setSoftwareProvider(java.lang.String).
    - <Sub directory> is a subdirectory accessed with the methods getUserSettingsSubDirectory() and setUserSettingsSubDirectory(java.lang.String).
    - <Application name> is the application name accessed with the methods getName() and setName(java.lang.String).
    Returns:
    
    The default pathname of the user settings. The returned pathname may not correspond to an existing file.
  - getUserHomeDirectory
```
public URL getUserHomeDirectory()
```
    Returns the home directory of the current application user.
    
    See Also:
    
    setUserHomeDirectory(java.net.URL)
  - setUserHomeDirectory
```
public void setUserHomeDirectory(URL url)
```
    Sets the home directory for the current application user.
    
    Parameters:
    
    url - The URL of the new user home directory.
    
    See Also:
    
    getUserHomeDirectory()
  - getSoftwareProvider
```
public String getSoftwareProvider()
```
    Returns the software provider name. This name is used for constructing the path to the settings saved for the current application user.
    
    Returns:
    
    Returns the software provider name. If a name was specified by invoking method setSoftwareProvider(java.lang.String), this name will be returned. Otherwise, this method returns "RogueWave".
    
    See Also:
    
    setSoftwareProvider(String), getUserSettingsURL()
  - setSoftwareProvider
```
public void setSoftwareProvider(String name)
```
    Sets the software provider.
    
    Parameters:
    
    name - The name of the software provider.
    
    See Also:
    
    getSoftwareProvider()
  - getUserSettingsSubDirectory
```
public String getUserSettingsSubDirectory()
```
    Returns the subdirectory that is used for constructing the pathname of the XML file containing the user settings for the current application user.
    
    Returns:
    
    The user settings subdirectory.
    
    See Also:
    
    getDefaultUserSettingsPathname(), setUserSettingsSubDirectory(java.lang.String), getUserSettingsURL()
  - setUserSettingsSubDirectory
```
public void setUserSettingsSubDirectory(String subDirectory)
```
    Sets the sub directory that is used for constructing the pathname of the XML file containing the user settings for the current application user.
    
    Parameters:
    
    subDirectory - The subdirectory.
    
    See Also:
    
    getUserSettingsSubDirectory(), getDefaultUserSettingsPathname()
  - resolveURL
```
public URL resolveURL(String filename)
```
    Resolves a URL from the specified filename.
    
    Parameters:
    
    filename - The file name to resolve a URL from.
    
    Returns:
    
    The URL that corresponds to the specified file name.
  - getAbbreviateForm
```
public String getAbbreviateForm(URL url)
```
    Returns the abbreviated form of the specified URL.
    
    Parameters:
    
    url - The URL to get an abbreviated form from.
    
    See Also:
    
    resolveURL(java.lang.String), IlvURLResolver, IlvURLResolver.getAbbreviateForm(java.net.URL)
  - addURLResolver
```
public void addURLResolver(IlvURLResolver resolver)
```
    Adds the specified URL resolver to the application.
    
    Parameters:
    
    resolver - The new URL resolver to add to the application.
    
    See Also:
    
    IlvURLResolverManager.addResolver(ilog.views.appframe.util.IlvURLResolver)
  - removeURLResolver
```
public boolean removeURLResolver(IlvURLResolver resolver)
```
    Removes the specified URL resolver from the list of resolvers managed by the application.
    
    Parameters:
    
    resolver - The URL resolver to remove.
    
    Returns:
    
    true if the application contains the specified URL resolver; false otherwise.
    
    See Also:
    
    addURLResolver(ilog.views.appframe.util.IlvURLResolver), IlvURLResolverManager.removeResolver(ilog.views.appframe.util.IlvURLResolver)
  - getURLResolverManager
```
public IlvURLResolverManager getURLResolverManager()
```
    Returns the URL resolver manager used by the application to resolve URLs. All the methods that concern the resolution of URLs delegate their processing to this manager.
    
    Returns:
    
    The URL resolver manager of the application.
  - getDocumentBase
```
public URL getDocumentBase()
```
    Returns the document base URL. This URL gives access to data used by the application as settings files or icons.
    
    Returns:
    
    The application document base or null if not set with the setDocumentBase(java.net.URL) method.
    
    See Also:
    
    setDocumentBase(java.net.URL)
  - setDocumentBase
```
public void setDocumentBase(URL documentBase)
```
    Sets the document base URL of the application.
    
    Parameters:
    
    documentBase - The document base URL.
    
    See Also:
    
    getDocumentBase()
  - setProperty
```
public Object setProperty(String key,
                          Object value)
```
    Sets one of the properties of the application using the associated key. If the value has changed, a PropertyChangeEvent is sent to property change listeners.
    
    Specified by:
    
    setProperty in interface IlvPropertyManager
    
    Parameters:
    
    key - The non-null property key.
    
    value - An Object value. If it is equal to null, the property with the specified key will be removed.
    
    Returns:
    
    The previous value of the property.
    
    See Also:
    
    getProperty(java.lang.String), addPropertyChangeListener(java.beans.PropertyChangeListener)
  - getProperty
```
public Object getProperty(String key)
```
    Returns the property of the application with the specified key.
    
    Specified by:
    
    getProperty in interface IlvPropertyManager
    
    Parameters:
    
    key - The non-null property key.
    
    Returns:
    
    The value of the specified property or null if the specified property was not found.
    
    See Also:
    
    setProperty(java.lang.String, java.lang.Object)
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a listener that listens to the changes in the properties of this application.
    
    Specified by:
    
    addPropertyChangeListener in interface IlvPropertyManager
    
    Parameters:
    
    listener - The listener to add
    
    See Also:
    
    removePropertyChangeListener(java.beans.PropertyChangeListener), setProperty(java.lang.String, java.lang.Object)
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes the specified listener from the list of PropertyChange listeners managed by the application.
    
    Specified by:
    
    removePropertyChangeListener in interface IlvPropertyManager
    
    Parameters:
    
    listener - The listener to remove.
    
    See Also:
    
    addPropertyChangeListener(java.beans.PropertyChangeListener)
  - firePropertyChange
```
protected void firePropertyChange(String propertyName,
                                  Object oldValue,
                                  Object newValue)
```
    Support method for notifying changes on the application properties: if oldValue and newValue are equal, this method does nothing. Otherwise, a PropertyChange event is fired to each listener.
    
    Parameters:
    
    propertyName - The name of the property that was changed.
    
    oldValue - The old value of the property.
    
    newValue - The new value of the property.
    
    See Also:
    
    IlvDefaultPropertyManager.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object), addPropertyChangeListener(java.beans.PropertyChangeListener)
  - setSplashWindow
```
public void setSplashWindow(IlvSplashWindow splashWindow)
```
    Sets a splash window for the application. As soon as this method is invoked, the specified splashWindow is displayed. The splash window is closed when the main window of the application is displayed. This method should be invoked before the application is initialized.
    
    Parameters:
    
    splashWindow - The splash window to display while the application is initializing.
    
    See Also:
    
    getSplashWindow()
  - getSplashWindow
```
public IlvSplashWindow getSplashWindow()
```
    Returns the splash window currently displayed while the application is initializing.
    
    Returns:
    
    The splash window. This method returns null if no splash window has been set using the method setSplashWindow(ilog.views.appframe.swing.IlvSplashWindow) or if the application and its main window have been initialized.
    
    See Also:
    
    setSplashWindow(ilog.views.appframe.swing.IlvSplashWindow)

Class IlvApplication

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLOSE_ALL_DOCUMENTS_CMD

CLOSE_DOCUMENT_CMD

OPEN_DOCUMENT_CMD

NEW_DOCUMENT_CMD

NEW_DOCUMENT_ON_LAST_TEMPLATE_CMD

SAVE_ALL_DOCUMENTS_CMD

SAVE_DOCUMENT_CMD

SAVE_AS_DOCUMENT_CMD

REVERT_DOCUMENT_CMD

EXIT_CMD

OPEN_MULTIPLE_FILES

OPEN_FILE_MUST_EXIST

OPEN_MODE

SAVE_MODE

SAVE_AS_MODE

TITLE_PROPERTY

ICON_PROPERTY

STATUS_MESSAGE

STATUS_BAR_PROPERTY

MENU_BAR_PROPERTY

MAIN_WINDOW_PROPERTY

SETTINGS_TYPE

Constructor Detail

IlvApplication

IlvApplication

IlvApplication

IlvApplication

Method Detail

getName

setName

setTitle

getTitle

setImageIcon

getImageIcon

sendActionEvent

sendActionEvent

sendMessage

sendMessage

addMessageListener

removeMessageListener

addActionHandler

getActionHandlers

removeActionHandler

getAction

addAction

removeAction

initialize

isInitialized

close

addSettings

addXMLSettings

addXMLSettings

removeSettings

getSettings

getSettings

addSettingsListener

removeSettingsListener

getSettingsManager

selectElement

selectElement

select

select

select

commitSettingsChanges

addLocaleSettingsListener

removeLocaleSettingsListener

fireLocaleSettingsEvent

setMainWindow

getMainComponent

getMainWindow

getMainContainer

isApplet

getApplet

readApplicationSettings