lacam.gui
Class MainGUIForm

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Frame
                  extended byjavax.swing.JFrame
                      extended bylacam.gui.MainGUIForm
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class MainGUIForm
extends javax.swing.JFrame

Represents the main window of the system. This class handles the desktop functionality and the menu linking of tasks.

Author:
Dimitrij Zub
See Also:
Serialized Form

Field Summary
static int STATUS_STEP_DESCRIPTION
           
static int STATUS_STEP_LABEL
           
static int STATUS_STEP_PROGRESS
           
static int STATUS_TASK_LABEL
           
 
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Method Summary
static void addTool(javax.swing.JButton button, java.lang.String description)
          Adds the JButton button with the given description to the toolbar of the main window.
static void addTool(javax.swing.JButton button, java.lang.String description, int index)
          Adds the JButton button with the given description to the toolbar of the main window at the index index.
static void addTool(javax.swing.JMenuItem item, java.lang.String description, java.lang.String path, java.lang.String icon_path)
          Adds a JMenuItem to the main menu.
static void addTool(TaskDescriptor task)
          Adds a task as a JMenuItem to the main menu.
static dbis.util.graphic.GraphicsPanel getGraphicsPanel()
           
static MainGUIForm getInstance()
          Creates the JFrame instance of the Main GUI if necessery and returns the JFrame Object representing the Main GUI.
static javax.swing.JComponent[] getStatutsBarItems()
          Returns the status bar components of the main window
static void removeTaskFromMenu(TaskDescriptor task)
          Deprecated.  
static void resetGraphicsPanel()
          Resets the desktop of the main window. !
static void resetPluginAddons()
          Resets all plugin addons (basicly rebuilds the main window)
static void resetStatusBar()
          Resets the status bar of the main window.
static void setAccessible(boolean value)
          Deprecated.  
static void showForm()
          Shows the Main GUI
static void shutdown()
          Use this method to shutdown the system.
static void updateDesktopItems()
          Updates the linked desktop items.
static void updateMenuState(javax.swing.JMenu menu)
          Updates the state of the given JMenu, which means that this method set an empty menu to disabled and a not empty menu to enabled.
 
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, update
 
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

STATUS_TASK_LABEL

public static final int STATUS_TASK_LABEL
See Also:
Constant Field Values

STATUS_STEP_LABEL

public static final int STATUS_STEP_LABEL
See Also:
Constant Field Values

STATUS_STEP_DESCRIPTION

public static final int STATUS_STEP_DESCRIPTION
See Also:
Constant Field Values

STATUS_STEP_PROGRESS

public static final int STATUS_STEP_PROGRESS
See Also:
Constant Field Values
Method Detail

getInstance

public static MainGUIForm getInstance()
Creates the JFrame instance of the Main GUI if necessery and returns the JFrame Object representing the Main GUI.


showForm

public static void showForm()
Shows the Main GUI


shutdown

public static void shutdown()
Use this method to shutdown the system. Please do not use System.exit() anywhere else!


addTool

public static void addTool(javax.swing.JButton button,
                           java.lang.String description)
Adds the JButton button with the given description to the toolbar of the main window.

Parameters:
button - The JButton to be added
description - The description of the action of the button.

addTool

public static void addTool(javax.swing.JButton button,
                           java.lang.String description,
                           int index)
Adds the JButton button with the given description to the toolbar of the main window at the index index.

Parameters:
button - The JButton to add.
description - The dscription of the buttons action
index - The index, where to add the button

addTool

public static void addTool(TaskDescriptor task)
Adds a task as a JMenuItem to the main menu.

Parameters:
task - The task to add as a JButton
See Also:
addTool(JMenuItem, String, String, String)

addTool

public static void addTool(javax.swing.JMenuItem item,
                           java.lang.String description,
                           java.lang.String path,
                           java.lang.String icon_path)
Adds a JMenuItem to the main menu. The path where to add the JMenuItem is specified by the String path. In addition a list of icons can be specified by icon_path, so that all needed newly generated JMenus will get an icon if any was assigned.

Parameters:
item - The JMenuItem to add
description - The description of the item
path - The path, where to add the item
icon_path - The icon path of the item

resetPluginAddons

public static void resetPluginAddons()
Resets all plugin addons (basicly rebuilds the main window)


resetStatusBar

public static void resetStatusBar()
Resets the status bar of the main window.


resetGraphicsPanel

public static void resetGraphicsPanel()
Resets the desktop of the main window. !Does not rebuild the linked desktop objects! Use updateDesktopItems() right after this method, if you need the desktop items to be placed on the desktop.


updateDesktopItems

public static void updateDesktopItems()
Updates the linked desktop items.


removeTaskFromMenu

public static void removeTaskFromMenu(TaskDescriptor task)
Deprecated.  

Removes a task from the main menu. This method is deprecated, because it has never been really tested.

Parameters:
task - The task to remove

updateMenuState

public static void updateMenuState(javax.swing.JMenu menu)
Updates the state of the given JMenu, which means that this method set an empty menu to disabled and a not empty menu to enabled.

Parameters:
menu - The JMenu to update.

setAccessible

public static void setAccessible(boolean value)
Deprecated.  

Sets the main window to accessible or not. This method is deprecated. Only kept because its hard to let go. Use getInstance().setVisible() instead.

Parameters:
value - true if accessable, false if not.

getStatutsBarItems

public static javax.swing.JComponent[] getStatutsBarItems()
Returns the status bar components of the main window

Returns:
Hmm.. lets see...

getGraphicsPanel

public static dbis.util.graphic.GraphicsPanel getGraphicsPanel()
Returns:
The desktop of the main window