org.mdi.bootstrap.swing

Interface TabbedApplication

All Superinterfaces:

GUIApplication, MDIApplication

All Known Implementing Classes:

AbstractMDIApplication

public interface TabbedApplication
extends GUIApplication

This interface defines Applications which manage removing tabs.

Field Summary

Fields

Modifier and Type	Field and Description
static char	FORCE_CLOSE_ALL Specify that all of the closeCurrentTab(), closeAllTabs(), and closeOtherTabs() methods will force close by default.
static char	FORCE_CLOSE_ALL_TABS Specify that only the closeOtherTabs() and closeAllTabs() methods will force close by default.
static char	FORCE_CLOSE_NONE Specify that none of the closeCurrentTab(), closeAllTabs(), and closeOtherTabs() methods will force close by default.
static char	FORCE_CLOSE_OTHER_TABS Specify that only the closeOtherTabs() method will force close by default.

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.
default SwingFileProperties	addTab(javax.swing.Icon icon, SwingFileProperties properties, java.lang.String tooltip) Add a tab with a specified name and panel.
default SwingFileProperties	addTab(javax.swing.JComponent comp, javax.swing.Icon icon, java.lang.Object obj, java.lang.String name, java.lang.String tooltip) Add an undefined tab.
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.
SwingFileProperties	addTab(javax.swing.JComponent comp, javax.swing.Icon icon, SwingFileProperties properties, java.lang.String tooltip) Add a tab with a specified name and panel.
default SwingFileProperties	addTab(javax.swing.JComponent comp, java.lang.Object obj, java.lang.String name) Add an undefined tab.
default SwingFileProperties	addTab(javax.swing.JComponent comp, java.lang.Object obj, java.lang.String name, boolean isCloseable) Add an undefined tab.An associated undefined FileProperties will be created.
default SwingFileProperties	addTab(javax.swing.JComponent comp, SwingFileProperties properties) Add a tab with a specified name and panel.
default SwingFileProperties	addTab(SwingFileProperties properties) Add a tab with a specified name and panel.
default void	closeAllTabs() Close all tabs.
void	closeAllTabs(boolean forceClose) Close all tabs.
default boolean	closeCurrentTab() Close the currently opened Tab.
boolean	closeCurrentTab(boolean forceClose) Close the currently opened Tab.
default void	closeOtherTabs() Close all Tabs except the current one.
void	closeOtherTabs(boolean forceClose) Close all Tabs except the current one.
java.util.List<MDIApplicationListener>	getApplicationListeners() Return the list of application listeners.
java.util.Map<java.lang.String,SwingFileProperties>	getCompatibleTabs(MetaData properties, boolean excludeSelected) Return all the panels that are compatible with the given properties Map.
default char	getDefaultForceCloseTab() Return which of the closeCurrentTab(), closeAllTabs(), and closeOtherTabs() methods will close each tab even if the acceptRemoveTab(java.lang.String) return false or FileProperties.isCloseable() return false.
default SwingFileProperties	getFilePropertyForTab(java.lang.String name) Return the file property associated with a tab name.
java.lang.String	getRealNameForTab(java.lang.String tabName) Return the real name corresponding with a displayed tab name.
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.
default boolean	hasGlobalMessageArea() Return true if there is one global message area..
default boolean	hasPerTabMessageArea() Return true if there is one message area for each tab.
boolean	isClosableTab() Return true if this applications use tabs closable with a button on the tabs header.
boolean	isModified(java.lang.String name) Return true if the tab is modified.
boolean	removeApplicationListener(MDIApplicationListener listener) Remove an application listener.
SwingFileProperties	removeSelectedTab() Called when removing the selected tab.
SwingFileProperties	removeTab(java.lang.String name) Remove a tab of the specified name.
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.
void	setModified(java.lang.String name, boolean isModified) Set the modified state of a tab.
default SwingFileProperties	setSelectedTab(java.lang.String name) Set the selected tab.

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

appendError, appendMessage, applyDialog, cancelDialog, getApplicationWindow, getComponent, getComponent, getDefaultDialogOpenType, getDialogHelper, getFileProperties, getMenuBar, getMenuFactory, getMessageArea, getMessageArea, getMessageAreaType, getPluginsEDTSupport, getProperties, getSelectedComponent, getSelectedProperties, getStatusBar, getToolBarPanel, hasSelectedTab, isDialogOpened, setDefaultDialogOpenType, setDialogHelper, showDialog, showDialog, showDialog, showDialog, showDialog, showDialog, showMessageDialog, showMessageDialog, showMessageDialog, updateMenus, updateUI

Methods inherited from interface org.mdi.bootstrap.MDIApplication

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

Field Detail

FORCE_CLOSE_NONE

static final char FORCE_CLOSE_NONE

Specify that none of the closeCurrentTab(), closeAllTabs(), and closeOtherTabs() methods will force close by default.

See Also:

Constant Field Values

FORCE_CLOSE_OTHER_TABS

static final char FORCE_CLOSE_OTHER_TABS

Specify that only the closeOtherTabs() method will force close by default.

See Also:

Constant Field Values

FORCE_CLOSE_ALL_TABS

static final char FORCE_CLOSE_ALL_TABS

Specify that only the closeOtherTabs() and closeAllTabs() methods will force close by default.

See Also:

Constant Field Values

FORCE_CLOSE_ALL

static final char FORCE_CLOSE_ALL

Specify that all of the closeCurrentTab(), closeAllTabs(), and closeOtherTabs() methods will force close by default.

See Also:

Constant Field Values

Method Detail

getDefaultForceCloseTab

default char getDefaultForceCloseTab()

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

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

Returns:

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

hasGlobalMessageArea

default boolean hasGlobalMessageArea()

Return true if there is one global message area.. Return true by default.

Returns:

true if there is one global message area

See Also:

GUIApplication.getMessageAreaType()

hasPerTabMessageArea

default boolean hasPerTabMessageArea()

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

Returns:

true if there is one message area for each tab

See Also:

GUIApplication.getMessageAreaType()

setComponenAt

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

Set the component to use for a selected Tab name.

Parameters:

name - the tab name

comp - the component

Returns:

true if the tab with this name exist

addApplicationListener

void addApplicationListener(MDIApplicationListener listener)

Add an application listener.

Parameters:

listener - the application listener

removeApplicationListener

boolean removeApplicationListener(MDIApplicationListener listener)

Remove an application listener.

Parameters:

listener - the application listener

Returns:

true if it was in the listeners list

getApplicationListeners

java.util.List<MDIApplicationListener> getApplicationListeners()

Return the list of application listeners.

Returns:

the list of application listeners

removeSelectedTab

SwingFileProperties removeSelectedTab()

Called when removing the selected tab.

Returns:

the FileProperties for removed tab

setSelectedTab

default SwingFileProperties setSelectedTab(java.lang.String name)

Set the selected tab. Do nothing and return the properties of the selected tab by default.

Parameters:

name - the tab name

Returns:

the file properties for the tab if it exists

isClosableTab

boolean isClosableTab()

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

Returns:

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

getTabList

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.

Returns:

the list of tabs as a Map

setCurrentTabModified

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.

Parameters:

isModified - true if the current tab is modified

See Also:

setModified(java.lang.String, boolean)

setModified

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.

Parameters:

name - thr tab name

isModified - true if the tab is modified

getRealNameForTab

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

Return the real name corresponding with a displayed 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 "*".

Parameters:

tabName - the tab displayed name

Returns:

the real tab name

getTabDisplayedName

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 "*".

Parameters:

name - the tab name

Returns:

the tab displayed name

isModified

boolean isModified(java.lang.String name)

Return true if the tab is modified.

Parameters:

name - the tab name

Returns:

true if the tab is modified

See Also:

setModified(java.lang.String, boolean)

acceptRemoveTab

boolean acceptRemoveTab(java.lang.String name)

Return true if the tab of the specified name can be removed.

Parameters:

name - the tab name

Returns:

true if the tab of the specified name can be removed

getTabPropertiesList

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

Return the list of tabs properties as a Map.

Returns:

the list of tabs properties as a Map

getFilePropertyForTab

default SwingFileProperties getFilePropertyForTab(java.lang.String name)

Return the file property associated with a tab name.

Parameters:

name - the tab name

Returns:

the file property

getCompatibleTabs

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.

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

addTab

default SwingFileProperties addTab(javax.swing.JComponent comp,
                                   SwingFileProperties properties)

Add a tab with a specified name and panel.

Parameters:

comp - the component to add

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

Returns:

the FileProperties of the tab

addTab

default SwingFileProperties addTab(SwingFileProperties properties)

Add a tab with a specified name and panel.

Parameters:

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

Returns:

the FileProperties of the tab

addTab

default SwingFileProperties addTab(javax.swing.Icon icon,
                                   SwingFileProperties properties,
                                   java.lang.String tooltip)

Add a tab with a specified name and panel.

Parameters:

icon - the icon

properties - 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

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

Add a tab with a specified name and panel.

Parameters:

comp - the component to add

icon - the icon

properties - 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

default SwingFileProperties addTab(javax.swing.JComponent comp,
                                   java.lang.Object obj,
                                   java.lang.String name)

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

Parameters:

comp - the component to add

obj - the associated object

name - the name of the tab

Returns:

the FileProperties of the tab

addTab

default SwingFileProperties addTab(javax.swing.JComponent comp,
                                   java.lang.Object obj,
                                   java.lang.String name,
                                   boolean isCloseable)

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

Parameters:

comp - the component to add

obj - the associated object

name - the name of the tab

isCloseable - true if the tab is closeable

Returns:

the FileProperties of the tab

addTab

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

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

Parameters:

comp - the component to add

icon - the icon

obj - the associated object

name - the name of the tab

tooltip - the tooltip

Returns:

the FileProperties of the tab

addTab

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.

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

getTabbedPane

javax.swing.JTabbedPane getTabbedPane()

Return the tabbed pane used by the MDI Application.

Returns:

the tabbed pane used by the MDI Application

removeTab

SwingFileProperties removeTab(java.lang.String name)

Remove a tab of the specified name.

Parameters:

name - the tab name

Returns:

the FileProperties of the tab

getTabCount

int getTabCount()

Return the number of tabs.

Returns:

the number of tabs

closeAllTabs

default void closeAllTabs()

Close all tabs. The behavior dfpend on the result of getDefaultForceCloseTab(). This means that the application will check for the result of acceptRemoveTab(java.lang.String) before closing for each modified tab.

closeAllTabs

void closeAllTabs(boolean forceClose)

Close all tabs.

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

default void closeOtherTabs()

Close all Tabs except the current one. The behavior dfpend on the result of getDefaultForceCloseTab().

closeOtherTabs

void closeOtherTabs(boolean forceClose)

Close all Tabs except the current one.

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

default boolean closeCurrentTab()

Close the currently opened Tab. The behavior dfend on the result of getDefaultForceCloseTab().

Returns:

true if the tab could be closed

closeCurrentTab

boolean closeCurrentTab(boolean forceClose)

Close the currently opened Tab.

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