org.agentgui.gui.swing

Class MainWindowExtension

java.lang.Object

org.agentgui.gui.swing.MainWindowExtension

public abstract class MainWindowExtension
extends java.lang.Object

The Class MainWindowExtension can be extended to define individual menus, menu items and toolbar components to the Swing main window of Agent.Workbench.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MainWindowExtension.MainWindowMenu The Class MainWindowMenu describes the JMenu and it index position that is to be added to the MainWindow of Agent.Workbench.
class	MainWindowExtension.MainWindowMenuItem The Class MainWindowMenuItem describes single menu items that are to be added to MainWindow of Agent.Workbench.
class	MainWindowExtension.MainWindowToolbarComponent The Class MainWindowToolbarComponent describes single components that are to be added to the main tool bar of Agent.Workbench.
static class	MainWindowExtension.SeparatorPosition

Constructor Summary

Constructors

Constructor and Description
MainWindowExtension()

Method Summary

Modifier and Type	Method and Description
protected void	addJMenu(javax.swing.JMenu jMenu, java.lang.Integer indexPosition) Adds the specified JMenu to the MainWindow.
protected void	addJMenuItem(MainWindow.WorkbenchMenu workbenchMenuToAddTo, javax.swing.JMenuItem menuItemToAdd, java.lang.Integer indexPosition, MainWindowExtension.SeparatorPosition separatorPosition) Adds the specified JMenuItem to the specified workbench window at the given index position.
protected void	addToolbarComponent(javax.swing.JComponent toolbarComponentToAdd, java.lang.Integer indexPosition, MainWindowExtension.SeparatorPosition separatorPosition) Adds the specified toolbar component to the toolbar.
java.util.Vector<MainWindowExtension.MainWindowMenuItem>	getMainWindowMenuItemVector() Returns the vector of menu items that are to be added to the MainWindow.
java.util.Vector<MainWindowExtension.MainWindowMenu>	getMainWindowMenuVector() Returns the vector of JMenus to be added to the MainWindow.
java.util.Vector<MainWindowExtension.MainWindowToolbarComponent>	getMainWindowToolBarComponentVector() Returns the main window tool bar component vector.
abstract void	initialize() Initializes the extension.

Methods inherited from class java.lang.Object

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

Constructor Detail

MainWindowExtension

public MainWindowExtension()

Method Detail

initialize

public abstract void initialize()

Initializes the extension. Use this method to add your individual elements to the main window of the workbench.

getMainWindowMenuVector

public java.util.Vector<MainWindowExtension.MainWindowMenu> getMainWindowMenuVector()

Returns the vector of JMenus to be added to the MainWindow.

Returns:

the main window menu vector

addJMenu

protected void addJMenu(javax.swing.JMenu jMenu,
                        java.lang.Integer indexPosition)

Adds the specified JMenu to the MainWindow.

Parameters:

jMenu - the JMmenu to be added

indexPosition - the index position for the menu (may be null also)

getMainWindowMenuItemVector

public java.util.Vector<MainWindowExtension.MainWindowMenuItem> getMainWindowMenuItemVector()

Returns the vector of menu items that are to be added to the MainWindow.

Returns:

the main window menu item vector

addJMenuItem

protected void addJMenuItem(MainWindow.WorkbenchMenu workbenchMenuToAddTo,
                            javax.swing.JMenuItem menuItemToAdd,
                            java.lang.Integer indexPosition,
                            MainWindowExtension.SeparatorPosition separatorPosition)

Adds the specified JMenuItem to the specified workbench window at the given index position.

Parameters:

workbenchMenuToAddTo - the workbench menu to add to

menuItemToAdd - the menu item to add

indexPosition - the index position for the menu item (may be null also)

separatorPosition - the separator position (may be null also)

getMainWindowToolBarComponentVector

public java.util.Vector<MainWindowExtension.MainWindowToolbarComponent> getMainWindowToolBarComponentVector()

Returns the main window tool bar component vector.

Returns:

the main window tool bar component vector

addToolbarComponent

protected void addToolbarComponent(javax.swing.JComponent toolbarComponentToAdd,
                                   java.lang.Integer indexPosition,
                                   MainWindowExtension.SeparatorPosition separatorPosition)

Adds the specified toolbar component to the toolbar.

Parameters:

toolbarComponentToAdd - the toolbar component to add

indexPosition - the index position of the component (may be null also)

separatorPosition - the separator position (may be null also)