org.mdi.bootstrap.swing

Interface MDISettings

All Superinterfaces:

javax.swing.Action, java.awt.event.ActionListener, java.util.EventListener

All Known Implementing Classes:

AbstractSettingsAction, DefaultSettingsAction

public interface MDISettings
extends javax.swing.Action

The component which manage the Settings menu.

Field Summary

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Method Summary

Modifier and Type	Method and Description
default javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String childName, javax.swing.tree.DefaultMutableTreeNode childNode, javax.swing.Icon icon) Add a node to the settings component.
default javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String childName, javax.swing.JComponent comp) Add a node with a component as user Object to the settings component.
default javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String childName, javax.swing.JComponent comp, javax.swing.Icon icon) Add a node with a component as user Object to the settings component.
default javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String childName, javax.swing.JComponent comp, java.lang.String label, javax.swing.Icon icon) Add a node with a component as user Object to the settings component.
default javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String childName, MDISettingsNode node) Add a node with a component as user Object to the settings component.
javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String parentName, java.lang.String childName, javax.swing.tree.DefaultMutableTreeNode childNode, javax.swing.Icon icon) Add a node to the settings component.
default javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String parentName, java.lang.String childName, javax.swing.JComponent comp, javax.swing.Icon icon) Add a node with a component as user Object to the settings component.
default javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String parentName, java.lang.String childName, javax.swing.JComponent comp, java.lang.String label, javax.swing.Icon icon) Add a node with a component as user Object to the settings component.
javax.swing.tree.DefaultMutableTreeNode	addNode(java.lang.String parentName, java.lang.String childName, MDISettingsNode node) Add a node with a component as user Object to the settings component.
javax.swing.JComponent	getSettingsComponent() Return the component associated with the settings.
default void	hideTreeRoot() Specify that the tree root of the settings must be hidden.
void	initialize() Initialize the settings menu, after all components have been added.
default void	setApplication(GUIApplication appli) Set the application.
default void	setDimension(java.awt.Dimension dim) Set the settings dimension.
void	showSettings() Show the Settings.

Methods inherited from interface javax.swing.Action

addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Method Detail

showSettings

void showSettings()

Show the Settings.

hideTreeRoot

default void hideTreeRoot()

Specify that the tree root of the settings must be hidden. Do ntohing by default.

setApplication

default void setApplication(GUIApplication appli)

Set the application. Do nothing by default.

Parameters:

appli - the application

getSettingsComponent

javax.swing.JComponent getSettingsComponent()

Return the component associated with the settings.

Returns:

the component

setDimension

default void setDimension(java.awt.Dimension dim)

Set the settings dimension. Do nothing by default.

Parameters:

dim - the dimension

addNode

default javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String childName,
                                                        javax.swing.JComponent comp)

Add a node with a component as user Object to the settings component.

Parameters:

childName - the name of the child node to add

comp - the component associated with the child node. It will be added as the user object of a new child node

Returns:

the Node

addNode

default javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String childName,
                                                        javax.swing.JComponent comp,
                                                        javax.swing.Icon icon)

Add a node with a component as user Object to the settings component.

Parameters:

childName - the name of the child node to add

comp - the component associated with the child node. It will be added as the user object of a new child node

icon - the icon associated with the node, or null if there is no icon

Returns:

the Node

addNode

default javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String parentName,
                                                        java.lang.String childName,
                                                        javax.swing.JComponent comp,
                                                        javax.swing.Icon icon)

Add a node with a component as user Object to the settings component.

Parameters:

parentName - the name of the parent of the node

childName - the name of the child node to add

comp - the component associated with the child node. It will be added as the user object of a new child node

icon - the icon associated with the node, or null if there is no icon

Returns:

the Node

addNode

default javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String childName,
                                                        MDISettingsNode node)

Add a node with a component as user Object to the settings component.

Parameters:

childName - the name of the child node to add

node - the settings node

Returns:

the Node

addNode

javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String parentName,
                                                java.lang.String childName,
                                                MDISettingsNode node)

Add a node with a component as user Object to the settings component.

Parameters:

parentName - the name of the parent of the node

childName - the name of the child node to add

node - the settings node

Returns:

the Node

addNode

default javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String childName,
                                                        javax.swing.JComponent comp,
                                                        java.lang.String label,
                                                        javax.swing.Icon icon)

Add a node with a component as user Object to the settings component.

Parameters:

childName - the name of the child node to add

comp - the component associated with the child node. It will be added as the user object of a new child node

label - the label associated with the node

icon - the icon associated with the node, or null if there is no icon

Returns:

the Node

addNode

default javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String parentName,
                                                        java.lang.String childName,
                                                        javax.swing.JComponent comp,
                                                        java.lang.String label,
                                                        javax.swing.Icon icon)

Add a node with a component as user Object to the settings component. Defer by default to addNode(java.lang.String, java.lang.String, javax.swing.JComponent, javax.swing.Icon).

Parameters:

parentName - the name of the parent of the node

childName - the name of the child node to add

comp - the component associated with the child node. It will be added as the user object of a new child node

label - the label associated with the node

icon - the icon associated with the node, or null if there is no icon

Returns:

the Node

addNode

default javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String childName,
                                                        javax.swing.tree.DefaultMutableTreeNode childNode,
                                                        javax.swing.Icon icon)

Add a node to the settings component.

Parameters:

childName - the name of the child node to add

childNode - the child node

icon - the icon associated with the node, or null if there is no icon

Returns:

the Node

addNode

javax.swing.tree.DefaultMutableTreeNode addNode(java.lang.String parentName,
                                                java.lang.String childName,
                                                javax.swing.tree.DefaultMutableTreeNode childNode,
                                                javax.swing.Icon icon)

Add a node to the settings component.

Parameters:

parentName - the name of the parent of the node

childName - the name of the child node to add

childNode - the child node

icon - the icon associated with the node, or null if there is no icon

Returns:

the Node

initialize

void initialize()

Initialize the settings menu, after all components have been added.