org.mdi.app.swing

Class AbstractMDIApplication

java.lang.Object

org.mdi.app.AbstractApplication

org.mdi.app.swing.AbstractMDIApplication

All Implemented Interfaces:

CommandLineListener, MDIApplication, GUIApplication, TabbedApplication, PluginsListener

public abstract class AbstractMDIApplication
extends AbstractApplication
implements TabbedApplication

An abstract MDIApplication implementation, which have a GUI. It provides:

• A JFrame which can hold various tabs
• A Status bar
• A Message area

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractMDIApplication.MDIFrame

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<MDIApplicationListener>	appListeners The list of application listeners registeed in the Application.
protected SwingMessageArea	message The MDIApplication associated Message Area.
protected MDIMenuFactory	mfactory The MDIApplication associated Menu Factory.
protected java.util.Map<java.lang.String,java.lang.String>	nameToTab This Maps the real name of the element in the tab to the tab name.
protected java.util.Map<java.lang.String,SwingFileProperties>	properties The properties Map.
protected StatusBar	statusBar The MDIApplication associated Status bar.
protected javax.swing.JTabbedPane	tab Tabbed pane containing the panels imported or created by the application
protected java.util.Map<java.lang.String,javax.swing.JComponent>	tablist The tab list.
protected java.util.Map<java.lang.String,java.lang.String>	tabToName This Maps the tab name to the real name of the element in the tab.

Fields inherited from class org.mdi.app.AbstractApplication

additionalPluginTypes, allowedPluginTypes, appDesc, argsMap, commandLineHandler, conf, confmanager, customActions, errorLogger, plugins, pluginsConfiguration, pluginsDefInFile, pluginsDir, pluginsManager, pluginsMap, preventOpening, queue, time

Fields inherited from interface org.mdi.bootstrap.swing.TabbedApplication

FORCE_CLOSE_ALL, FORCE_CLOSE_ALL_TABS, FORCE_CLOSE_NONE, FORCE_CLOSE_OTHER_TABS

Constructor Summary

Constructors

Constructor and Description
AbstractMDIApplication() Constructor, with a default title.
AbstractMDIApplication(java.lang.String title) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptRemoveTab(java.lang.String name) Return true if the tab of the specified name can be removed.
void	addApplicationListener(MDIApplicationListener listener) Add an application listener.
SwingFileProperties	addTab(javax.swing.JComponent comp, javax.swing.Icon icon, java.lang.Object obj, java.lang.String name, java.lang.String tooltip, boolean isCloseable) Add an undefined tab.
SwingFileProperties	addTab(javax.swing.JComponent comp, javax.swing.Icon icon, SwingFileProperties prop, java.lang.String tooltip) Add a tab with a specified name and panel.
protected void	appendMessage(java.lang.String message, java.lang.String htmlColor)
void	applyDialog(MDIDialog dialog) Apply a dialog.
void	cancelDialog(MDIDialog dialog) Cancel a dialog.
void	closeAllTabs(boolean forceClose) Close all tabs.
boolean	closeCurrentTab(boolean forceClose) Close the currently opened Tab.
void	closeOtherTabs(boolean forceClose) Close all Tabs except the current one.
protected ThreadQueue	createThreadQueue() Create the ThreadQueue.
void	dispose() Provided for convenience.
void	endAction(MDIAction action) Ends a generic action.
void	executeAction(MDIAction action, short blockingType) Execute a generic Action.
void	executeAction(MDIAction action, short blockingType, java.lang.ClassLoader loader) Execute a generic Action, using a specific Classloader.
protected boolean	fireTabBeforeClosing(SwingFileProperties prop) Fired before a tab is removed.
protected void	fireTabChanged(SwingFileProperties prop) Fired when the current selected Tab change.
protected void	fireTabRemoved(SwingFileProperties prop) Fired when a tab is removed.
java.util.List<MDIApplicationListener>	getApplicationListeners() Return the list of application listeners.
javax.swing.JFrame	getApplicationWindow() Return the frame.
java.util.Map<java.lang.String,SwingFileProperties>	getCompatibleTabs(MetaData properties, boolean excludeSelected) Return all the panels that are compatible with the given properties Map.
javax.swing.JComponent	getComponent(java.lang.Object object) Return the Tab component for the specified object.
javax.swing.JComponent	getComponent(java.lang.String name) Return the panel of the specified name, or null if there is no panel with this name.
MDIDialogType	getDefaultDialogOpenType() Return the default dialog opening type.
char	getDefaultForceCloseTab() Return which of the TabbedApplication.closeCurrentTab(), TabbedApplication.closeAllTabs(), and TabbedApplication.closeOtherTabs() methods will close each tab even if the acceptRemoveTab(java.lang.String) return false or FileProperties.isCloseable() return false.
MDIDialogHelper	getDialogHelper() Return the dialog helper.
SwingFileProperties	getFileProperties(java.lang.Object object) Return the FileProperties for the specified object.
javax.swing.JMenuBar	getMenuBar() Return the menu bar.
MDIMenuFactory	getMenuFactory() Return the associated menu factory.
SwingMessageArea	getMessageArea() Return the MDIApplication Message Area.
SwingMessageArea	getMessageArea(SwingFileProperties properties) Return the MDIApplication MessageArea for a specified properties.
short	getMessageAreaType() Return the message area type.
PluginsEDTSupport	getPluginsEDTSupport(PluginsManager manager) Return the Swing support class for the GUI initialization of Plugins.
SwingFileProperties	getProperties(java.lang.String name) Return the FileProperties for a tab of a specified name.
java.lang.String	getRealNameForTab(java.lang.String tabName) Return the real name corresponding with a tab name.
javax.swing.JComponent	getSelectedComponent() Return the selected component.
SwingFileProperties	getSelectedProperties() Return the FileProperties for the selected tab.
StatusBar	getStatusBar() Return the Statusbar associated with the main window, and create it before if it does not exist.
javax.swing.JTabbedPane	getTabbedPane() Return the tabbed pane used by the MDI Application.
int	getTabCount() Return the number of tabs.
java.lang.String	getTabDisplayedName(java.lang.String name) Return the displayed tab name corresponding with a name.
java.util.Map<java.lang.String,javax.swing.JComponent>	getTabList() Return the list of tabs as a Map, associating the tabs names with their Component.
java.util.Map<java.lang.String,SwingFileProperties>	getTabPropertiesList() Return the list of tabs properties as a Map.
java.lang.String	getTitle() Return the GUI frame title
javax.swing.JPanel	getToolBarPanel() Return the panel containing the toolbars.
protected java.lang.String	getUnusedName(java.lang.String name) Return an unused name beginning with the name String.
boolean	hasClosableTab(boolean hasClosableTab) Try to define this application as having closable tabs.
boolean	hasGlobalMessageArea() Return true if there is one global message area.
boolean	hasPerTabMessageArea() Return true if there is one message area for each tab.
boolean	hasSelectedTab() Return true if there is a selected tab.
protected boolean	hasStatusBar()
boolean	hasTab(java.lang.String name) Return true if the application has a tab of a specified name.
protected boolean	hasToolBar()
protected boolean	isChangeTabsAllowed() Return true if future changes in tabs must be listened to trigger Application actions.
boolean	isClosableTab() Return true if this applications use tabs closable with a button on the tabs header.
boolean	isDialogOpened(MDIDialog dialog) Return true if a dialog is currently opened.
boolean	isEditableMessageArea() Return true if the message area is editable.
boolean	isModified(java.lang.String name) Return true if the tab is modified.
protected void	manageTabs(java.awt.event.MouseEvent e)
void	noTimeMessages() Avoid to write time in messages for the current MDIAction.
void	noWriteMessages() Avoid to write messages for the current MDIAction.
protected void	preparePanels() The last method called for preparing the panels of the application.
protected void	preparePanels(boolean hasStatusbar, boolean hasToolBar, MDIMenuFactory mfactory) Prepare the various panels of the MDIApplication, without any Message Area.
protected void	preparePanels(int messageAreaSize, boolean hasStatusbar, boolean hasToolBar, MDIMenuFactory mfactory) Prepare the various panels of the MDIApplication.
protected void	preparePanels(int messageAreaSize, int messageAreaType, boolean hasStatusbar, boolean hasToolBar, MDIMenuFactory mfactory) Prepare the various panels of the MDIApplication.The application window present: A Menu bar An optional toolbar The main panel of the application, presenting the various files opened and/or created by the application itself or plugins An optional message area An optional status bar This is necessary to add all GUI elements in the application, and can be configured in a number of ways: the initial size of the message area can be set.Note that the application comes with a default message area (see DefaultMessageArea), but that any specific message area implementation can be provided (see SwingMessageArea).
protected void	preparePanels(int messageAreaSize, MDIMenuFactory mfactory) Prepare the various panels of the MDIApplication, with a message area, a toolbar, and a status bar.
protected void	preparePanels(MDIApplicationProperties appProperties) Prepare the various panels of the MDIApplication.
protected void	preparePanels(SwingMessageArea area, boolean hasStatusbar, boolean hasToolBar, MDIMenuFactory mfactory) Prepare the various panels of the MDIApplication.
boolean	removeApplicationListener(MDIApplicationListener listener) Remove an application listener.
SwingFileProperties	removeSelectedTab() Remove the currently selected tab.
SwingFileProperties	removeTab(java.lang.String name) Remove a tab of the specified name.
void	renameTab(java.lang.String oldName, java.lang.String newName) Rename a tab of the specified name.
protected void	setChangeTabsAllowed(boolean changeTabsAllowed) Set if future changes in tabs must be listened to trigger Application actions.
boolean	setCloseBackground(java.awt.Color color) Set the close button background color when the close button is focused.
boolean	setCloseIcon(javax.swing.Icon icon) Set the close Icon for the tabs header, and try to define this application as having a closable tab.
boolean	setCloseIcon(java.net.URL icon) Set the close Icon for the tabs header, and try to define this application as having a closable tab.
boolean	setComponenAt(java.lang.String name, javax.swing.JComponent comp) Set the component to use for a selected Tab name.
void	setCurrentTabModified(boolean isModified) Set the modified state of the currently selected tab.
boolean	setDefaultCloseIcon() Use the default icon for the close button.
void	setDefaultDialogOpenType(MDIDialogType openType) Set the default dialog opening type.
void	setDefaultForceCloseTab(char defaultForceCloseTabs) Set which of the TabbedApplication.closeCurrentTab(), TabbedApplication.closeAllTabs(), and TabbedApplication.closeOtherTabs() methods will close each tab even if the acceptRemoveTab(java.lang.String) return false or FileProperties.isCloseable() return false.
void	setDialogHelper(MDIDialogHelper helper) Set the dialog helper.
void	setMenuFactory(MDIMenuFactory mfactory) Set the associated menu factory.
protected void	setMessageArea(SwingMessageArea message) Set the MDIApplication Message Area.
void	setModified(java.lang.String name, boolean isModified) Set the modified state of a tab.
SwingFileProperties	setSelectedTab(java.lang.String name) Set the selected tab.
void	setSize(int width, int height) Provided for convenience.
void	setTitle(java.lang.String title) Set the GUI frame title.
void	setVisible(boolean visible) Provided for convenience.
void	showActionException(java.lang.String message, java.lang.Exception e) Show the Exception stackTrace by default.
int	showDialog(MDIDialog dialog) Show a dialog, with the default dialog opening type.
int	showDialog(MDIDialog dialog, javax.swing.AbstractAction action) Show a dialog, with the default dialog opening type.
int	showDialog(MDIDialog dialog, javax.swing.AbstractAction action, MDIDialogType openType) Show a dialog.
int	showDialog(MDIDialogBuilder builder) Show a dialog.
int	showDialog(MDIDialogBuilder builder, MDIDialogType openType) Show a dialog.
int	showDialog(MDIDialog dialog, MDIDialogType openType) Show a dialog.
int	showMessageDialog(java.lang.String title, int messageType, boolean isModal, boolean isResizable, java.lang.String... messages) Show a message dialog, with an OK button.
void	startTime(MDIAction action) Start to count the time for the last operation, and show the statusBar progress.
long	stopTime(MDIAction action) Return the time after the last operation and stop the progress bar if there is any.
void	updateUI() Update the UI of the application content

Methods inherited from class org.mdi.app.AbstractApplication

addAdditionalPluginType, addCustomAction, addPluginDirectory, applyCommandLineArguments, disposeApplication, executeCustomAction, executeCustomAction, getAdditionalPluginTypes, getAllowedPluginTypes, getApplicationDesc, getCommandLineArguments, getCommandLineHandler, getConfigurationManager, getErrorLogger, getPlugin, getPluginForName, getPlugins, getPluginsManager, getPluginsMap, getStartDirectory, getThreadQueue, getTime, hasPlugin, hasPluginsDirectories, hasPluginsDirectoryList, hasSinglePluginsDirectory, initConfiguration, initConfiguration, initConfiguration, initConfiguration, initConfiguration, initProcessFromRegister, isDefaultBlockingActions, loadResources, pluginsActionPerformed, preventOpeningApplication, registerPlugins, serializeConfiguration, setAllowedPluginTypes, setCommandLineArguments, setCommandLineArguments, setCommandLineArguments, setCommandLineHandler, setConfiguration, setDefaultBlockingActions, setErrorLogger, setPluginsConfiguration, setPluginsConfiguration, setPluginsConfigurationFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mdi.bootstrap.swing.TabbedApplication

addTab, addTab, addTab, addTab, addTab, addTab, closeAllTabs, closeCurrentTab, closeOtherTabs, getFilePropertyForTab

Methods inherited from interface org.mdi.bootstrap.swing.GUIApplication

appendError, appendMessage, showMessageDialog, showMessageDialog, updateMenus

Methods inherited from interface org.mdi.bootstrap.MDIApplication

disposeApplication, executeAction, executeAction, getAdditionalPluginTypes, getAllowedPluginTypes, getApplicationDesc, getApplicationID, getCommandLineArguments, getConfigurationManager, getErrorLogger, getPlugin, getPluginForName, getPlugins, getPluginsManager, getPluginsMap, getStartDirectory, getTime, hasPlugin, isDefaultBlockingActions, setDefaultBlockingActions

Methods inherited from interface org.mdi.bootstrap.launcher.CommandLineListener

getCommandLineConfiguration, handleCommandLineArguments, handleCommandLineArguments, handleCommandLineException

Field Detail

mfactory

protected MDIMenuFactory mfactory

The MDIApplication associated Menu Factory.

tab

protected javax.swing.JTabbedPane tab

Tabbed pane containing the panels imported or created by the application

tablist

protected java.util.Map<java.lang.String,javax.swing.JComponent> tablist

The tab list. It links the tab name to the underlying Component.

nameToTab

protected java.util.Map<java.lang.String,java.lang.String> nameToTab

This Maps the real name of the element in the tab to the tab name.

tabToName

protected java.util.Map<java.lang.String,java.lang.String> tabToName

This Maps the tab name to the real name of the element in the tab.

properties

protected java.util.Map<java.lang.String,SwingFileProperties> properties

The properties Map.

statusBar

protected StatusBar statusBar

The MDIApplication associated Status bar.

message

protected SwingMessageArea message

The MDIApplication associated Message Area.

appListeners

protected final java.util.List<MDIApplicationListener> appListeners

The list of application listeners registeed in the Application.

Constructor Detail

AbstractMDIApplication

public AbstractMDIApplication()

Constructor, with a default title.

AbstractMDIApplication

public AbstractMDIApplication(java.lang.String title)

Constructor.

Parameters:

title - the GUI frame title

Method Detail

setTitle

public void setTitle(java.lang.String title)

Set the GUI frame title.

Parameters:

title - the title

getTitle

public java.lang.String getTitle()

Return the GUI frame title

Returns:

the title

setDefaultForceCloseTab

public void setDefaultForceCloseTab(char defaultForceCloseTabs)

Set which of the TabbedApplication.closeCurrentTab(), TabbedApplication.closeAllTabs(), and TabbedApplication.closeOtherTabs() methods will close each tab even if the acceptRemoveTab(java.lang.String) return false or FileProperties.isCloseable() return false.

• TabbedApplication.FORCE_CLOSE_NONE: none of the methods will force close tabs by default
• TabbedApplication.FORCE_CLOSE_OTHER_TABS: only the TabbedApplication.closeOtherTabs() method will force close tabs by default
• TabbedApplication.FORCE_CLOSE_ALL_TABS: only the TabbedApplication.closeAllTabs() and TabbedApplication.closeOtherTabs() methods will force close tabs by default
• TabbedApplication.FORCE_CLOSE_ALL: both the TabbedApplication.closeCurrentTab(), TabbedApplication.closeAllTabs() and TabbedApplication.closeOtherTabs() methods will force close tabs by default

Parameters:

defaultForceCloseTabs - sets which close methods for tabs do not take into account acceptRemoveTab(java.lang.String) return false or FileProperties.isCloseable()

getDefaultForceCloseTab

public char getDefaultForceCloseTab()

Return which of the TabbedApplication.closeCurrentTab(), TabbedApplication.closeAllTabs(), and TabbedApplication.closeOtherTabs() methods will close each tab even if the acceptRemoveTab(java.lang.String) return false or FileProperties.isCloseable() return false. This method return TabbedApplication.FORCE_CLOSE_NONE by default:

• TabbedApplication.FORCE_CLOSE_NONE: none of the methods will force close tabs by default
• TabbedApplication.FORCE_CLOSE_OTHER_TABS: only the TabbedApplication.closeOtherTabs() method will force close tabs by default
• TabbedApplication.FORCE_CLOSE_ALL_TABS: only the TabbedApplication.closeAllTabs() and TabbedApplication.closeOtherTabs() methods will force close tabs by default
• TabbedApplication.FORCE_CLOSE_ALL: both the TabbedApplication.closeCurrentTab(), TabbedApplication.closeAllTabs() and TabbedApplication.closeOtherTabs() methods will force close tabs by default

Specified by:

getDefaultForceCloseTab in interface TabbedApplication

Returns:

which close methods for tabs do not take into account acceptRemoveTab(java.lang.String) return false or FileProperties.isCloseable()

createThreadQueue

protected ThreadQueue createThreadQueue()

Create the ThreadQueue.

Specified by:

createThreadQueue in class AbstractApplication

Returns:

the ThreadQueue

getPluginsEDTSupport

public PluginsEDTSupport getPluginsEDTSupport(PluginsManager manager)

Return the Swing support class for the GUI initialization of Plugins.

Specified by:

getPluginsEDTSupport in interface MDIApplication

Specified by:

getPluginsEDTSupport in interface GUIApplication

Parameters:

manager - the PluginsManager

Returns:

the support class

hasClosableTab

public boolean hasClosableTab(boolean hasClosableTab)

Try to define this application as having closable tabs. Note that this will not be successful if the application has already constructed its internal panels (see preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory))

Parameters:

hasClosableTab - true if this application should have closable tabs

Returns:

true if this has been successful, false if it is not allowed to define this application as having a closable tab.

See Also:

isClosableTab(), preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory)

setCloseIcon

public boolean setCloseIcon(javax.swing.Icon icon)

Set the close Icon for the tabs header, and try to define this application as having a closable tab. Note that this will not be successful if the application has already constructed its internal panels (see preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory))

Parameters:

icon - the close icon

Returns:

true if this has been successful

See Also:

preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory)

setCloseIcon

public boolean setCloseIcon(java.net.URL icon)

Set the close Icon for the tabs header, and try to define this application as having a closable tab. Note that this will not be successful if the application has already constructed its internal panels (see preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory))

Parameters:

icon - the close icon URL

Returns:

true if this has been successful

See Also:

preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory)

setCloseBackground

public boolean setCloseBackground(java.awt.Color color)

Set the close button background color when the close button is focused. Note that this will not be successful if the application has already constructed its internal panels (see preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory))

Parameters:

color - the background color

Returns:

true if this has been successful

See Also:

preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory)

setDefaultCloseIcon

public boolean setDefaultCloseIcon()

Use the default icon for the close button. Note that this will not be successful if the application has already constructed its internal panels (see preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory))

Returns:

true if this has been successful

See Also:

preparePanels(boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory)

isClosableTab

public boolean isClosableTab()

Return true if this applications use tabs closable with a button on the tabs header.

Specified by:

isClosableTab in interface TabbedApplication

Returns:

true if this applications use tabs closable with a button on the tabs header

setMenuFactory

public final void setMenuFactory(MDIMenuFactory mfactory)

Set the associated menu factory.

Parameters:

mfactory - the menu factory

getMenuFactory

public final MDIMenuFactory getMenuFactory()

Return the associated menu factory.

Specified by:

getMenuFactory in interface GUIApplication

Returns:

the menu factory

getApplicationWindow

public final javax.swing.JFrame getApplicationWindow()

Return the frame.

Specified by:

getApplicationWindow in interface GUIApplication

Returns:

the frame

setChangeTabsAllowed

protected void setChangeTabsAllowed(boolean changeTabsAllowed)

Set if future changes in tabs must be listened to trigger Application actions.

Parameters:

changeTabsAllowed - true if future changes in tabs must be listened to trigger Application actions

isChangeTabsAllowed

protected boolean isChangeTabsAllowed()

Return true if future changes in tabs must be listened to trigger Application actions.

Returns:

true if future changes in tabs must be listened to trigger Application actions

isEditableMessageArea

public boolean isEditableMessageArea()

Return true if the message area is editable.

Returns:

true if the message area is editabl

fireTabChanged

protected void fireTabChanged(SwingFileProperties prop)

Fired when the current selected Tab change. By default fire all the MDIApplicationListeners registered in the Application.

Parameters:

prop - the selected tab FileProperties

fireTabBeforeClosing

protected boolean fireTabBeforeClosing(SwingFileProperties prop)

Fired before a tab is removed. By default fire all the MDIApplicationListeners registered in the Application.

Parameters:

prop - the FileProperties that is under the tab before it is removed

Returns:

true if closing the tab is allowed

fireTabRemoved

protected void fireTabRemoved(SwingFileProperties prop)

Fired when a tab is removed. By default fire all the MDIApplicationListeners registered in the Application.

Parameters:

prop - the FileProperties that is under the tab that was removed

addApplicationListener

public void addApplicationListener(MDIApplicationListener listener)

Add an application listener.

Specified by:

addApplicationListener in interface TabbedApplication

Parameters:

listener - the application listener

removeApplicationListener

public boolean removeApplicationListener(MDIApplicationListener listener)

Remove an application listener.

Specified by:

removeApplicationListener in interface TabbedApplication

Parameters:

listener - the application listener

Returns:

true if it was in the listeners list

getApplicationListeners

public java.util.List<MDIApplicationListener> getApplicationListeners()

Return the list of application listeners.

Specified by:

getApplicationListeners in interface TabbedApplication

Returns:

the list of application listeners

executeAction

public void executeAction(MDIAction action,
                          short blockingType)

Execute a generic Action.

Blocking types

The blocking type can be:

• BlockingType.DEFAULT: use the default blocking type of the application
• BlockingType.BLOCKING: if the action should be blocking
• BlockingType.NOT_BLOCKING: if the action should not be blocking
• BlockingType.UI_NOT_BLOCKING:The UI not blocking type, the action must be performed in the UI Thread
• BlockingType.UI_BLOCKING:The UI blocking type, the action must be performed in the UI Thread

Specified by:

executeAction in interface MDIApplication

Overrides:

executeAction in class AbstractApplication

Parameters:

action - the Action

blockingType - the enumeration specifying if the action should be blocking

executeAction

public void executeAction(MDIAction action,
                          short blockingType,
                          java.lang.ClassLoader loader)

Execute a generic Action, using a specific Classloader.

Blocking types

The blocking type can be:

• BlockingType.DEFAULT: use the default blocking type of the application
• BlockingType.BLOCKING: if the action should be blocking
• BlockingType.NOT_BLOCKING: if the action should not be blocking
• BlockingType.UI_NOT_BLOCKING:The UI not blocking type, the action must be performed in the UI Thread
• BlockingType.UI_BLOCKING:The UI blocking type, the action must be performed in the UI Thread

Specified by:

executeAction in interface MDIApplication

Overrides:

executeAction in class AbstractApplication

Parameters:

action - the Action

blockingType - the enumeration specifying if the action should be blocking

loader - the ClassLoader to execute the action

preparePanels

protected void preparePanels()

The last method called for preparing the panels of the application.

preparePanels

protected void preparePanels(boolean hasStatusbar,
                             boolean hasToolBar,
                             MDIMenuFactory mfactory)

Prepare the various panels of the MDIApplication, without any Message Area.

Parameters:

hasStatusbar - true if there is a Statusbar

hasToolBar - true if there is a ToolBar

mfactory - theAbstractMDIMenuFactory used with this MDIApplication

preparePanels

protected void preparePanels(SwingMessageArea area,
                             boolean hasStatusbar,
                             boolean hasToolBar,
                             MDIMenuFactory mfactory)

Prepare the various panels of the MDIApplication.

Parameters:

area - the Message Area (can be null if there is no Message Area)

hasStatusbar - true if there is a Status bar

hasToolBar - true if there is a ToolBar

mfactory - theAbstractMDIMenuFactoryy used with this MDIApplication

preparePanels

protected void preparePanels(int messageAreaSize,
                             MDIMenuFactory mfactory)

Prepare the various panels of the MDIApplication, with a message area, a toolbar, and a status bar.

Parameters:

messageAreaSize - the number of rows of the Message Area, or 0 or less if there is no Message Area

mfactory - the MDIMenuFactory used with this MDIApplication

See Also:

preparePanels(int, boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory)

preparePanels

protected void preparePanels(int messageAreaSize,
                             boolean hasStatusbar,
                             boolean hasToolBar,
                             MDIMenuFactory mfactory)

Prepare the various panels of the MDIApplication. The application window present:

• A Menu bar
• An optional toolbar
• The main panel of the application, presenting the various files opened and/or created by the application itself or plugins
• An optional message area
• An optional status bar

This is necessary to add all GUI elements in the application, and can be configured in a number of ways:

• the initial size of the message area can be set. Note that the application comes with a default message area (see DefaultMessageArea), but that any specific message area implementation can be provided (see SwingMessageArea).
• Toolbar or Statusbar are optional

Parameters:

messageAreaSize - the number of rows of the Message Area, or 0 or less if there is no Message Area

hasStatusbar - true if there is a Status bar

hasToolBar - true if there is a ToolBar

mfactory - the MDIMenuFactory used with this MDIApplication

preparePanels

protected void preparePanels(int messageAreaSize,
                             int messageAreaType,
                             boolean hasStatusbar,
                             boolean hasToolBar,
                             MDIMenuFactory mfactory)

Prepare the various panels of the MDIApplication.The application window present:

• A Menu bar
• An optional toolbar
• The main panel of the application, presenting the various files opened and/or created by the application itself or plugins
• An optional message area
• An optional status bar

This is necessary to add all GUI elements in the application, and can be configured in a number of ways:

• the initial size of the message area can be set.Note that the application comes with a default message area (see DefaultMessageArea), but that any specific message area implementation can be provided (see SwingMessageArea).
• Toolbar or Statusbar are optional

Parameters:

messageAreaSize - the number of rows of the Message Area, or 0 or less if there is no Message Area

messageAreaType - the message area type

hasStatusbar - true if there is a Status bar

hasToolBar - true if there is a ToolBar

mfactory - the MDIMenuFactory used with this MDIApplication

preparePanels

protected void preparePanels(MDIApplicationProperties appProperties)

Prepare the various panels of the MDIApplication. The application window present:

• A Menu bar
• An optional toolbar
• The main panel of the application, presenting the various files opened and/or created by the application itself or plugins
• An optional message area
• An optional status bar

This is necessary to add all GUI elements in the application, and can be configured in a number of ways:

• the initial size of the message area can be set. Note that the application comes with a default message area (see DefaultMessageArea), but that any specific message area implementation can be provided (see SwingMessageArea).
• Toolbar or Statusbar are optional

Parameters:

appProperties - the application properties

getMessageArea

public SwingMessageArea getMessageArea(SwingFileProperties properties)

Return the MDIApplication MessageArea for a specified properties.

Specified by:

getMessageArea in interface GUIApplication

Parameters:

properties - the properties

Returns:

the MessageArea

getMessageArea

public final SwingMessageArea getMessageArea()

Return the MDIApplication Message Area. Depending on what the getMessageAreaType() methods returns, if can be the global message area, or the message area associated with the currently selected tab.

Specified by:

getMessageArea in interface GUIApplication

Returns:

the MDIApplication Message Area

setMessageArea

protected final void setMessageArea(SwingMessageArea message)

Set the MDIApplication Message Area. This method must be called by the application before preparePanels(int, boolean, boolean, org.mdi.bootstrap.swing.MDIMenuFactory).

Parameters:

message - the MDIApplication Message Area

setDialogHelper

public final void setDialogHelper(MDIDialogHelper helper)

Set the dialog helper.

Specified by:

setDialogHelper in interface GUIApplication

Parameters:

helper - the dialog helper

getDialogHelper

public final MDIDialogHelper getDialogHelper()

Return the dialog helper.

Specified by:

getDialogHelper in interface GUIApplication

Returns:

the dialog helper

setDefaultDialogOpenType

public void setDefaultDialogOpenType(MDIDialogType openType)

Set the default dialog opening type.

Specified by:

setDefaultDialogOpenType in interface GUIApplication

Parameters:

openType - the default dialog opening type

getDefaultDialogOpenType

public MDIDialogType getDefaultDialogOpenType()

Return the default dialog opening type.

Specified by:

getDefaultDialogOpenType in interface GUIApplication

Returns:

the default dialog opening type

showDialog

public int showDialog(MDIDialog dialog)

Show a dialog, with the default dialog opening type.

Specified by:

showDialog in interface GUIApplication

Parameters:

dialog - the dialog

Returns:

the result, can be JFileChooser.APPROVE_OPTION, or JFileChooser.CANCEL_OPTION

See Also:

MDIDialogType

showDialog

public int showDialog(MDIDialog dialog,
                      javax.swing.AbstractAction action)

Show a dialog, with the default dialog opening type.

Specified by:

showDialog in interface GUIApplication

Parameters:

dialog - the dialog

action - the associated Action

Returns:

the result, can be JFileChooser.APPROVE_OPTION, or JFileChooser.CANCEL_OPTION

See Also:

MDIDialogType

showDialog

public int showDialog(MDIDialog dialog,
                      MDIDialogType openType)

Show a dialog.

Specified by:

showDialog in interface GUIApplication

Parameters:

dialog - the dialog

openType - the opening type of the dialog

Returns:

the result, can be JFileChooser.APPROVE_OPTION, or JFileChooser.CANCEL_OPTION

See Also:

MDIDialogType

showDialog

public int showDialog(MDIDialogBuilder builder,
                      MDIDialogType openType)

Show a dialog.

Specified by:

showDialog in interface GUIApplication

Parameters:

builder - the dialog builder

openType - the opening type of the dialog

Returns:

the result, can be JFileChooser.APPROVE_OPTION, or JFileChooser.CANCEL_OPTION

See Also:

MDIDialogType

showDialog

public int showDialog(MDIDialogBuilder builder)

Show a dialog.

Specified by:

showDialog in interface GUIApplication

Parameters:

builder - the dialog builder

Returns:

the result, can be JFileChooser.APPROVE_OPTION, or JFileChooser.CANCEL_OPTION

See Also:

MDIDialogType

showMessageDialog

public int showMessageDialog(java.lang.String title,
                             int messageType,
                             boolean isModal,
                             boolean isResizable,
                             java.lang.String... messages)

Show a message dialog, with an OK button.

Specified by:

showMessageDialog in interface GUIApplication

Parameters:

title - the dialog title

messageType - the message type

isModal - true if the dialog is modal

isResizable - true if the dialog is resizable

messages - the list of messages, which will be shown in a vertical grid

Returns:

the result, will be JFileChooser.APPROVE_OPTION

cancelDialog

public void cancelDialog(MDIDialog dialog)

Cancel a dialog.

Specified by:

cancelDialog in interface GUIApplication

Parameters:

dialog - the dialog

applyDialog

public void applyDialog(MDIDialog dialog)

Apply a dialog.

Specified by:

applyDialog in interface GUIApplication

Parameters:

dialog - the dialog

showDialog

public int showDialog(MDIDialog dialog,
                      javax.swing.AbstractAction action,
                      MDIDialogType openType)

Show a dialog.

Specified by:

showDialog in interface GUIApplication

Parameters:

dialog - the dialog

action - the associated Action

openType - the opening type of the dialog

Returns:

the result, can be JFileChooser.APPROVE_OPTION, or JFileChooser.CANCEL_OPTION

See Also:

MDIDialogType

isDialogOpened

public boolean isDialogOpened(MDIDialog dialog)

Return true if a dialog is currently opened.

Specified by:

isDialogOpened in interface GUIApplication

Parameters:

dialog - the dialog

Returns:

true if the dialog ius currently opened

startTime

public void startTime(MDIAction action)

Start to count the time for the last operation, and show the statusBar progress.

Specified by:

startTime in interface MDIApplication

Overrides:

startTime in class AbstractApplication

Parameters:

action - the Action

stopTime

public long stopTime(MDIAction action)

Return the time after the last operation and stop the progress bar if there is any.

Specified by:

stopTime in interface MDIApplication

Overrides:

stopTime in class AbstractApplication

Parameters:

action - the Action

Returns:

the time after the last operation

getUnusedName

protected java.lang.String getUnusedName(java.lang.String name)

Return an unused name beginning with the name String. If there is no tab with this name, it will return this String, else it will create a new String by adding an index at the end.

Parameters:

name - the tab name

Returns:

an unused tab name

setComponenAt

public boolean setComponenAt(java.lang.String name,
                             javax.swing.JComponent comp)

Set the component to use for a selected Tab name.

Specified by:

setComponenAt in interface TabbedApplication

Parameters:

name - the tab name

comp - the component

Returns:

true if the tab with this name exist

getMessageAreaType

public short getMessageAreaType()

Return the message area type. The possible values are:

• MessageAreaType.MESSAGEAREA_NONE: No message area
• MessageAreaType.MESSAGEAREA_GLOBAL: A global message area for all tabs
• MessageAreaType.MESSAGEAREA_PER_TAB: One message area for each tab

Specified by:

getMessageAreaType in interface GUIApplication

Returns:

the message area type

See Also:

MessageAreaType

hasPerTabMessageArea

public boolean hasPerTabMessageArea()

Return true if there is one message area for each tab.

Specified by:

hasPerTabMessageArea in interface TabbedApplication

Returns:

true if there is one message area for each tab

See Also:

getMessageAreaType()

hasGlobalMessageArea

public boolean hasGlobalMessageArea()

Return true if there is one global message area.

Specified by:

hasGlobalMessageArea in interface TabbedApplication

Returns:

true if there is one global message area

See Also:

getMessageAreaType()

addTab

public SwingFileProperties addTab(javax.swing.JComponent comp,
                                  javax.swing.Icon icon,
                                  SwingFileProperties prop,
                                  java.lang.String tooltip)

Add a tab with a specified name and panel.

Specified by:

addTab in interface TabbedApplication

Parameters:

comp - the component to add

icon - the icon

prop - the properties of the panel, advertising the type of the tab, and what can be done with it

tooltip - the tooltip

Returns:

the FileProperties of the tab

addTab

public SwingFileProperties addTab(javax.swing.JComponent comp,
                                  javax.swing.Icon icon,
                                  java.lang.Object obj,
                                  java.lang.String name,
                                  java.lang.String tooltip,
                                  boolean isCloseable)

Add an undefined tab. An associated undefined FileProperties will be created.

Specified by:

addTab in interface TabbedApplication

Parameters:

comp - the component to add

icon - the icon

obj - the associated object

name - the name of the tab

tooltip - the tooltip

isCloseable - true if the tab is closeable

Returns:

the FileProperties of the tab

closeAllTabs

public void closeAllTabs(boolean forceClose)

Close all tabs.

Specified by:

closeAllTabs in interface TabbedApplication

Parameters:

forceClose - true if the application should not check for the result of acceptRemoveTab(java.lang.String) before closing if the current tab content has been modified

closeOtherTabs

public void closeOtherTabs(boolean forceClose)

Close all Tabs except the current one.

Specified by:

closeOtherTabs in interface TabbedApplication

Parameters:

forceClose - true if the application should not check for the result of acceptRemoveTab(java.lang.String) before closing if the current tab content has been modified

closeCurrentTab

public boolean closeCurrentTab(boolean forceClose)

Close the currently opened Tab.

Specified by:

closeCurrentTab in interface TabbedApplication

Parameters:

forceClose - true if the application should not check for the result of acceptRemoveTab(java.lang.String) before closing if the current tab content has been modified

Returns:

true if the tab could be closed

getTabbedPane

public javax.swing.JTabbedPane getTabbedPane()

Return the tabbed pane used by the MDI Application.

Specified by:

getTabbedPane in interface TabbedApplication

Returns:

the tabbed pane used by the MDI Application

getTabCount

public int getTabCount()

Return the number of tabs.

Specified by:

getTabCount in interface TabbedApplication

Returns:

the number of tabs

setCurrentTabModified

public void setCurrentTabModified(boolean isModified)

Set the modified state of the currently selected tab. Modified tabs will be presented with a trailing "*" at the end of their name.

Specified by:

setCurrentTabModified in interface TabbedApplication

Parameters:

isModified - true if the current tab is modified

See Also:

setModified(java.lang.String, boolean)

setModified

public void setModified(java.lang.String name,
                        boolean isModified)

Set the modified state of a tab. Modified tabs will be presented with a trailing "*" at the end of their name. Note that the trailing "*" is not considered in the "real" name of the element. For example if the tab named "default" is modified, is displayed name will be "default *", but it will still be defined n the app as "default". For example you should use "default" and not "default *" if you now want the same tab to be declared as not modified.

Specified by:

setModified in interface TabbedApplication

Parameters:

name - thr tab name

isModified - true if the tab is modified

getRealNameForTab

public java.lang.String getRealNameForTab(java.lang.String tabName)

Return the real name corresponding with a tab name. In all cases these names will be equal, except when the tab has been declared as modified, in this case the tab name will have a trailing "*".

Specified by:

getRealNameForTab in interface TabbedApplication

Parameters:

tabName - the tab displayed name

Returns:

the real tab name

getTabDisplayedName

public java.lang.String getTabDisplayedName(java.lang.String name)

Return the displayed tab name corresponding with a name. In all cases these names will be equal, except when the tab has been declared as modified, in this case the tab name will have a trailing "*".

Specified by:

getTabDisplayedName in interface TabbedApplication

Parameters:

name - the tab name

Returns:

the tab displayed name

isModified

public boolean isModified(java.lang.String name)

Return true if the tab is modified.

Specified by:

isModified in interface TabbedApplication

Parameters:

name - the tab name

Returns:

true if the tab is modified

See Also:

setModified(java.lang.String, boolean)

renameTab

public void renameTab(java.lang.String oldName,
                      java.lang.String newName)

Rename a tab of the specified name.

Parameters:

oldName - the old tab name

newName - the new tab name

acceptRemoveTab

public boolean acceptRemoveTab(java.lang.String name)

Return true if the tab of the specified name can be removed. Return true by default. This method can be overriden by an application to have a generic behavior when the user try to close a tab for which the content is modified. For example it can be used to display a dialog asking the user if he wants to save the content of the tab before closing.

Example

The following code show how the method could be overriden to save the content of a tab before closing the tab if the content has been modified:

 public boolean acceptRemoveTab(String name) {
   if (tabToName.containsKey(name)) {
      name = tabToName.get(name);
     if (isModified(name)) {
        FileProperties prop = properties.get(name);
        Object o = prop.getObject();
        // here save the associated object, the code will depend on the application
     }
   }
   return true;
 }
 

Specified by:

acceptRemoveTab in interface TabbedApplication

Parameters:

name - the tab name

Returns:

true by default

removeTab

public SwingFileProperties removeTab(java.lang.String name)

Remove a tab of the specified name.

Specified by:

removeTab in interface TabbedApplication

Parameters:

name - the tab name

Returns:

the FileProperties of the tab

manageTabs

protected void manageTabs(java.awt.event.MouseEvent e)

setSelectedTab

public SwingFileProperties setSelectedTab(java.lang.String name)

Set the selected tab.

Specified by:

setSelectedTab in interface TabbedApplication

Parameters:

name - the tab name

Returns:

the file properties for the tab if it exists

removeSelectedTab

public SwingFileProperties removeSelectedTab()

Remove the currently selected tab.

Specified by:

removeSelectedTab in interface TabbedApplication

Returns:

the FileProperties for removed tab

getTabList

public java.util.Map<java.lang.String,javax.swing.JComponent> getTabList()

Return the list of tabs as a Map, associating the tabs names with their Component.

Specified by:

getTabList in interface TabbedApplication

Returns:

the list of tabs as a Map

hasTab

public boolean hasTab(java.lang.String name)

Return true if the application has a tab of a specified name.

Parameters:

name - the tab name

Returns:

true if the application has a tab of a specified name

getTabPropertiesList

public java.util.Map<java.lang.String,SwingFileProperties> getTabPropertiesList()

Return the list of tabs properties as a Map.

Specified by:

getTabPropertiesList in interface TabbedApplication

Returns:

the list of tabs properties as a Map

getCompatibleTabs

public java.util.Map<java.lang.String,SwingFileProperties> getCompatibleTabs(MetaData properties,
                                                                             boolean excludeSelected)

Return all the panels that are compatible with the given properties Map.

The compatible panels are the Panels :

• who have all the properties defined in the reference input
• whose properties values are equals to the reference input properties values

For example, if the properties Map contains only this following property :

• "test" > true

Only Panels that contain the "test" property with the associated true value will be retrieved.

Specified by:

getCompatibleTabs in interface TabbedApplication

Parameters:

properties - the properties MetaData whose panels properties must be compatible

excludeSelected - true if the selected tab must be excluded

Returns:

the Map of compatible tabs

getComponent

public final javax.swing.JComponent getComponent(java.lang.String name)

Return the panel of the specified name, or null if there is no panel with this name.

Specified by:

getComponent in interface GUIApplication

Parameters:

name - the tab name

Returns:

the associated Panel

getComponent

public javax.swing.JComponent getComponent(java.lang.Object object)

Return the Tab component for the specified object. See FileProperties.getObject(). Note that it is guaranteed that even if two objects for which the Object.equals(java.lang.Object) methods returns true, and they are associated with different tabs, the respective correct tabs will be returned for reach object.

Specified by:

getComponent in interface GUIApplication

Parameters:

object - the object

Returns:

the Tab component

getFileProperties

public SwingFileProperties getFileProperties(java.lang.Object object)

Return the FileProperties for the specified object. See FileProperties.getObject(). Note that it is guaranteed that even if two objects for which the Object.equals(java.lang.Object) methods returns true, and they are associated with different tabs, the respective correct FileProperties will be returned for reach object.

Specified by:

getFileProperties in interface GUIApplication

Parameters:

object - the object

Returns:

the Tab component

getProperties

public final SwingFileProperties getProperties(java.lang.String name)

Return the FileProperties for a tab of a specified name.

Specified by:

getProperties in interface GUIApplication

Parameters:

name - the tab name

Returns:

the associated FileProperties

getSelectedComponent

public final javax.swing.JComponent getSelectedComponent()

Return the selected component.

Specified by:

getSelectedComponent in interface GUIApplication

Returns:

the selected component

hasStatusBar

protected boolean hasStatusBar()

hasToolBar

protected boolean hasToolBar()

hasSelectedTab

public boolean hasSelectedTab()

Return true if there is a selected tab.

Specified by:

hasSelectedTab in interface GUIApplication

Returns:

true if there is a selected tab

getSelectedProperties

public final SwingFileProperties getSelectedProperties()

Return the FileProperties for the selected tab.

Specified by:

getSelectedProperties in interface GUIApplication

Returns:

the FileProperties for the selected tab

getStatusBar

public StatusBar getStatusBar()

Return the Statusbar associated with the main window, and create it before if it does not exist.

If (and only if) the Status bar is null it will be created beforehand. Since this method is used at creation, it can be therefore used to specialize the status bar.

Specified by:

getStatusBar in interface GUIApplication

Returns:

the Statusbar associated with the main window

getToolBarPanel

public final javax.swing.JPanel getToolBarPanel()

Return the panel containing the toolbars.

Specified by:

getToolBarPanel in interface GUIApplication

Returns:

the panel containing the toolbars

getMenuBar

public javax.swing.JMenuBar getMenuBar()

Return the menu bar.

Specified by:

getMenuBar in interface GUIApplication

Returns:

the menu bar

showActionException

public void showActionException(java.lang.String message,
                                java.lang.Exception e)

Show the Exception stackTrace by default. Can be overriden.

Specified by:

showActionException in interface MDIApplication

Overrides:

showActionException in class AbstractApplication

Parameters:

message - the message to show

e - the Exception

noWriteMessages

public void noWriteMessages()

Avoid to write messages for the current MDIAction.

Specified by:

noWriteMessages in interface MDIApplication

Overrides:

noWriteMessages in class AbstractApplication

noTimeMessages

public void noTimeMessages()

Avoid to write time in messages for the current MDIAction.

Specified by:

noTimeMessages in interface MDIApplication

Overrides:

noTimeMessages in class AbstractApplication

appendMessage

protected void appendMessage(java.lang.String message,
                             java.lang.String htmlColor)

endAction

public void endAction(MDIAction action)

Ends a generic action.

Specified by:

endAction in interface MDIApplication

Overrides:

endAction in class AbstractApplication

Parameters:

action - the action

updateUI

public void updateUI()

Update the UI of the application content

Specified by:

updateUI in interface GUIApplication

dispose

public void dispose()

Provided for convenience. Same as AbstractApplication.disposeApplication().

setSize

public void setSize(int width,
                    int height)

Provided for convenience. Set the size of the underlying Frame.

Parameters:

width - the frame width

height - the frame height

setVisible

public void setVisible(boolean visible)

Provided for convenience. Make the underlying Frame visible.

Parameters:

visible - true if the underlying Frame should be visible