com.dlsc.flexgantt.swing

## Class GanttChartFrame<T extends AbstractGanttChart>

- java.lang.Object
- - java.awt.Component
  - - java.awt.Container
    - - java.awt.Window
      - - java.awt.Frame
        - - javax.swing.JFrame
          - - com.dlsc.flexgantt.swing.GanttChartFrame<T>

- Type Parameters:
    `T` - the Gantt chart type (see `GanttChart`, `DualGanttChart`).
  All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
  Direct Known Subclasses:
    MacGanttChartFrame

      public class GanttChartFrame<T extends AbstractGanttChart>
      extends JFrame

  A frame implementation specifically designed for use with a Gantt chart. The frame adds a `GanttChartGlassPane` as a glass pane to itself. The panel will be used to block user input whenever the Gantt chart is busy (that is usually while a command gets executed).
  Since:
    1.0
  Version:
    $Revision: 1.9 $
  Author:
    Dirk Lemmermann
  See Also:
    Serialized Form

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class javax.swing.JFrame

      `JFrame.AccessibleJFrame`

    - ### Nested classes/interfaces inherited from class java.awt.Frame

      `Frame.AccessibleAWTFrame`

    - ### Nested classes/interfaces inherited from class java.awt.Window

      `Window.AccessibleAWTWindow, Window.Type`

    - ### Nested classes/interfaces inherited from class java.awt.Container

      `Container.AccessibleAWTContainer`

    - ### Nested classes/interfaces inherited from class java.awt.Component

      `Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy`

  - ### Field Summary

    - ### Fields inherited from class javax.swing.JFrame

      `accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled`

    - ### 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`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `GanttChartFrame(String title, T gc)` Constructs a new frame and adds the given Gantt chart, a toolbar, a status bar and a glass pane.
    `GanttChartFrame(String title, T gc, boolean showStatusBar, boolean showToolBar)` Constructs a new frame and adds the given Gantt chart, a toolbar, a status bar and a glass pane.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `center()` Centers the frame on the screen.
    `protected JComponent` | `createStatusBar(T gc)` Creates a specialized statusbar for the given Gantt chart.
    `protected JToolBar` | `createToolBar(T gc)` Creates a specialized toolbar for the given Gantt chart.
    `void` | `dispose()`
    `T` | `getGanttChart()` Returns the Gantt chart that is displayed inside the frame.
    `JComponent` | `getStatusBar()` Returns the statusbar used for showing Gantt chart specific properties and status information.
    `JToolBar` | `getToolBar()` Returns the toolbar used for displaying the Gantt chart's actions.
    `boolean` | `isTearingDownWindowOnDispose()` Determines whether the Gantt chart will be torn down when the window closes or not.
    `void` | `setTearingDownWindowOnDispose(boolean tearDown)` Specifies whether the Gantt chart will be torn down when the window closes or not.
    `void` | `showBusy()` Sets the Gantt chart glass pane to be visible, hence blocking all input events.
    `void` | `showReady()` Sets the Gantt chart glass pane to be invisible, hence allowing input events to be received by the Gantt chart components.

    - ### Methods inherited from class javax.swing.JFrame

      `addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update`

    - ### Methods inherited from class java.awt.Frame

      `addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated`

    - ### Methods inherited from class java.awt.Window

      `addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree`

    - ### Methods inherited from class java.awt.Component

      `action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, 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, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle`

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface java.awt.MenuContainer

      `getFont, postEvent`

- - ### Constructor Detail

    - #### GanttChartFrame

          public GanttChartFrame(String title,
                                 T gc,
                                 boolean showStatusBar,
                                 boolean showToolBar)

      Constructs a new frame and adds the given Gantt chart, a toolbar, a status bar and a glass pane.
      Parameters:
        `title` - the frame's title
        `gc` - the Gantt chart that is displayed in the frame
        `showStatusBar` - determines if a status bar will be added to the frame
        `showToolBar` - determines if a tool bar will be added to the frame
      Since:
        1.0

    - #### GanttChartFrame

          public GanttChartFrame(String title,
                                 T gc)

      Constructs a new frame and adds the given Gantt chart, a toolbar, a status bar and a glass pane.
      Parameters:
        `title` - the frame's title
        `gc` - the Gantt chart that is displayed in the frame
      Since:
        1.0

  - ### Method Detail

    - #### getGanttChart

          public T getGanttChart()

      Returns the Gantt chart that is displayed inside the frame.
      Returns:
        the frame's main component, the Gantt chart.
      Since:
        1.0

    - #### getStatusBar

          public JComponent getStatusBar()

      Returns the statusbar used for showing Gantt chart specific properties and status information.
      Returns:
        the frame's statusbar
      Since:
        1.0

    - #### getToolBar

          public JToolBar getToolBar()

      Returns the toolbar used for displaying the Gantt chart's actions.
      Returns:
        the frame's toolbar
      Since:
        1.0

    - #### createToolBar

          protected JToolBar createToolBar(T gc)

      Creates a specialized toolbar for the given Gantt chart.
      Parameters:
        `gc` - the Gantt chart that will be controlled by the toolbar
      Returns:
        a toolbar for the given Gantt chart
      Since:
        1.0

    - #### createStatusBar

          protected JComponent createStatusBar(T gc)

      Creates a specialized statusbar for the given Gantt chart.
      Parameters:
        `gc` - the Gantt chart for which information will be displayed in the status bar
      Returns:
        a statusbar for the given Gantt chart
      Since:
        1.0

    - #### center

          public void center()

      Centers the frame on the screen.
      Since:
        1.0

    - #### showBusy

          public void showBusy()

      Sets the Gantt chart glass pane to be visible, hence blocking all input events. The glass pane shows the busy cursor.
      Since:
        1.0

    - #### showReady

          public void showReady()

      Sets the Gantt chart glass pane to be invisible, hence allowing input events to be received by the Gantt chart components.
      Since:
        1.0

    - #### setTearingDownWindowOnDispose

          public void setTearingDownWindowOnDispose(boolean tearDown)

      Specifies whether the Gantt chart will be torn down when the window closes or not.
      Parameters:
        `tearDown` - if TRUE the Gantt chart will be torn down when the window gets disposed
      Since:
        1.1
      See Also:
        `AbstractGanttChart.tearDown()`, `AbstractLayer.tearDown()`, `LayerContainer.tearDown()`

    - #### isTearingDownWindowOnDispose

          public boolean isTearingDownWindowOnDispose()

      Determines whether the Gantt chart will be torn down when the window closes or not.
      Returns:
        TRUE if the Gantt chart gets torn down when the window gets disposed
      Since:
        1.1
      See Also:
        `setTearingDownWindowOnDispose(boolean)`

    - #### dispose

          public void dispose()

      Overrides:
        `dispose` in class `Window`

Copyright © 2006–2020 Dirk Lemmermann Software & Consulting. All rights reserved.