org.mdi.bootstrap.swing

Interface GUIApplication

All Superinterfaces:

MDIApplication

All Known Subinterfaces:

TabbedApplication

All Known Implementing Classes:

AbstractMDIApplication

public interface GUIApplication
extends MDIApplication

Interface for a Swing GUI MDIApplication.

Method Summary

Modifier and Type	Method and Description
void	applyDialog(MDIDialog dialog) Apply a dialog.
void	cancelDialog(MDIDialog dialog) Cancel a dialog.
javax.swing.JFrame	getApplicationWindow() Return the main Window of the MDIApplication.
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 component of the specified name, or null if there is no panel with this name.
MDIDialogType	getDefaultDialogOpenType() Return the default dialog opening type.
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 MDIApplication Menu Factory.
SwingMessageArea	getMessageArea() Return the MDIApplication MessageArea.
default 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.
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.
javax.swing.JPanel	getToolBarPanel() Return the panel containing the toolbars.
boolean	hasSelectedTab() Return true if there is a selected tab.
boolean	isDialogOpened(MDIDialog dialog) Return true if a dialog is currently opened.
void	setDefaultDialogOpenType(MDIDialogType openType) Set the default dialog opening type.
void	setDialogHelper(MDIDialogHelper helper) Set the dialog helper.
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.
default int	showMessageDialog(java.lang.String title, int messageType, java.lang.String... messages) Show a modal and not resizable message dialog, with an OK button.
default int	showMessageDialog(java.lang.String title, java.lang.String... messages) Show a modal and not resizable message dialog, with an OK button.
default void	updateMenus(MDIPlugin plugin) Update the MDIMenuFactory menus.
default void	updateUI() Update the UI of the application content.

Methods inherited from interface org.mdi.bootstrap.MDIApplication

disposeApplication, endAction, executeAction, executeAction, executeAction, executeAction, getAdditionalPluginTypes, getAllowedPluginTypes, getApplicationDesc, getApplicationID, getCommandLineArguments, getConfigurationManager, getErrorLogger, getPlugin, getPluginForName, getPlugins, getPluginsManager, getPluginsMap, getStartDirectory, getTime, hasPlugin, isDefaultBlockingActions, noTimeMessages, noWriteMessages, setDefaultBlockingActions, showActionException, startTime, stopTime

Method Detail

getComponent

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

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

Parameters:

name - the tab name

Returns:

the component of the specified name

getProperties

SwingFileProperties getProperties(java.lang.String name)

Return the FileProperties for a tab of a specified name.

Parameters:

name - the tab name

Returns:

the associated FileProperties

getComponent

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.

Parameters:

object - the object

Returns:

the Tab component

getFileProperties

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.

Parameters:

object - the object

Returns:

the Tab component

getSelectedComponent

javax.swing.JComponent getSelectedComponent()

Return the selected component.

Returns:

the selected component

getApplicationWindow

javax.swing.JFrame getApplicationWindow()

Return the main Window of the MDIApplication.

Returns:

the main Window of the MDIApplication

getMenuFactory

MDIMenuFactory getMenuFactory()

Return the MDIApplication Menu Factory.

Returns:

the MDIApplication Menu Factory

updateMenus

default void updateMenus(MDIPlugin plugin)

Update the MDIMenuFactory menus. Call MDIMenuFactory.updateMenus() by default.

Parameters:

plugin - the Plugin which is at the origin of the update

getSelectedProperties

SwingFileProperties getSelectedProperties()

Return the FileProperties for the selected tab.

Returns:

the FileProperties for the selected tab

getPluginsEDTSupport

default PluginsEDTSupport getPluginsEDTSupport(PluginsManager manager)

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

Specified by:

getPluginsEDTSupport in interface MDIApplication

Parameters:

manager - the PluginsManager

Returns:

the support class

hasSelectedTab

boolean hasSelectedTab()

Return true if there is a selected tab.

Returns:

true if there is a selected tab

getStatusBar

StatusBar getStatusBar()

Return the Statusbar associated with the main window.

Returns:

the Statusbar associated with the main window

getToolBarPanel

javax.swing.JPanel getToolBarPanel()

Return the panel containing the toolbars.

Returns:

the panel containing the toolbars

getMenuBar

javax.swing.JMenuBar getMenuBar()

Return the menu bar.

Returns:

the menu bar

getMessageArea

SwingMessageArea getMessageArea()

Return the MDIApplication MessageArea.

Returns:

the MDIApplication MessageArea

updateUI

default void updateUI()

Update the UI of the application content. Do nothng by default.

setDialogHelper

void setDialogHelper(MDIDialogHelper helper)

Set the dialog helper.

Parameters:

helper - the dialog helper

getDialogHelper

MDIDialogHelper getDialogHelper()

Return the dialog helper.

Returns:

the dialog helper

setDefaultDialogOpenType

void setDefaultDialogOpenType(MDIDialogType openType)

Set the default dialog opening type.

Parameters:

openType - the default dialog opening type

getDefaultDialogOpenType

MDIDialogType getDefaultDialogOpenType()

Return the default dialog opening type.

Returns:

the default dialog opening type

showDialog

int showDialog(MDIDialog dialog)

Show a dialog, with the default dialog opening type.

Parameters:

dialog - the dialog

Returns:

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

See Also:

MDIDialogType

showDialog

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

Show a dialog, with the default dialog opening type.

Parameters:

dialog - the dialog

action - the associated Action

Returns:

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

See Also:

MDIDialogType

showDialog

int showDialog(MDIDialog dialog,
               MDIDialogType openType)

Show a dialog.

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

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

Show a dialog.

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

showDialog

int showDialog(MDIDialogBuilder builder,
               MDIDialogType openType)

Show a dialog.

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

int showDialog(MDIDialogBuilder builder)

Show a dialog.

Parameters:

builder - the dialog builder

Returns:

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

See Also:

MDIDialogType

showMessageDialog

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

Show a message dialog, with an OK button.

Parameters:

title - the dialog title

messageType - the message type. It can be:

• MDIDialogBuilder.PLAIN_MESSAGE for a default dialog without any icon
• MDIDialogBuilder.ERROR_MESSAGE for a dialog with an error icon
• MDIDialogBuilder.INFORMATION_MESSAGE for a dialog with an information icon
• MDIDialogBuilder.QUESTION_MESSAGE for a dialog with a question icon

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

showMessageDialog

default int showMessageDialog(java.lang.String title,
                              int messageType,
                              java.lang.String... messages)

Show a modal and not resizable message dialog, with an OK button.

Parameters:

title - the dialog title

messageType - the message type. It can be:

• MDIDialogBuilder.PLAIN_MESSAGE for a default dialog without any icon
• MDIDialogBuilder.ERROR_MESSAGE for a dialog with an error icon
• MDIDialogBuilder.INFORMATION_MESSAGE for a dialog with an information icon
• MDIDialogBuilder.QUESTION_MESSAGE for a dialog with a question icon

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

Returns:

the result, will be JFileChooser.APPROVE_OPTION

showMessageDialog

default int showMessageDialog(java.lang.String title,
                              java.lang.String... messages)

Show a modal and not resizable message dialog, with an OK button.

Parameters:

title - the dialog title

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

Returns:

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

cancelDialog

void cancelDialog(MDIDialog dialog)

Cancel a dialog.

Parameters:

dialog - the dialog

applyDialog

void applyDialog(MDIDialog dialog)

Apply a dialog.

Parameters:

dialog - the dialog

isDialogOpened

boolean isDialogOpened(MDIDialog dialog)

Return true if a dialog is currently opened.

Parameters:

dialog - the dialog

Returns:

true if the dialog ius currently opened