com.dlsc.flexgantt.swing

## Class ColumnChooser

- java.lang.Object
- - java.awt.Component
  - - java.awt.Container
    - - javax.swing.JComponent
      - - javax.swing.JPanel
        - - com.dlsc.flexgantt.swing.ColumnChooser

- All Implemented Interfaces:
    IColumnModelListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible

      public class ColumnChooser
      extends JPanel
      implements IColumnModelListener, PropertyChangeListener

  A panel used for selecting which columns will be shown in the tree table of the Gantt chart. The panel displays two lists. One list with the available columns and one list with the currently used columns. Columns can be moved from one list to the other. The list with the used columns also allows the user to change the order of the columns.
  Since:
    1.0
  Version:
    $Revision: 1.8 $
  Author:
    Dirk Lemmermann
  See Also:
    `AbstractGanttChart.getAvailableColumns()`, Serialized Form

- - ### Nested Class Summary

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

      `JPanel.AccessibleJPanel`

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

      `JComponent.AccessibleJComponent`

    - ### 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.JComponent

      `listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW`

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

      `accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT`

    - ### Fields inherited from interface java.awt.image.ImageObserver

      `ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ColumnChooser(AbstractGanttChart gc)` Constructs a new chooser for the given Gantt chart.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `columnModelChanged(ColumnModelEvent evt)` The listener's callback method that will be invoked when columns get added, removed, inserted.
    `protected Border` | `createTitledBorder(String title)` Returns a titled border for the two lists.
    `JButton` | `getAddButton()` Returns the button that is being used to add a column to the list of used columns.
    `JList` | `getAvailableList()` Returns the UI list that displays the available columns.
    `JScrollPane` | `getAvailableListScrollPane()` Returns the scrollpane used for scrolling the "available" list.
    `JButton` | `getDownButton()` Returns the button that is being used to move a column down in the list of used columns.
    `AbstractGanttChart` | `getGanttChart()` Returns the Gantt chart that gets edited by the chooser.
    `JButton` | `getRemoveButton()` Returns the button that is being used to remove a column from the list of used columns.
    `JButton` | `getUpButton()` Returns the button that is being used to move a column up in the list of used columns.
    `JList` | `getUsedList()` Returns the UI list that displays the used columns.
    `JScrollPane` | `getUsedListScrollPane()` Returns the scrollpane used for scrolling the "used" list.
    `void` | `propertyChange(PropertyChangeEvent evt)`
    `void` | `updateLists()` Updates the content of the two lists.

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

      `getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI`

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

      `addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update`

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

      `add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle`

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

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

- - ### Constructor Detail

    - #### ColumnChooser

          public ColumnChooser(AbstractGanttChart gc)

      Constructs a new chooser for the given Gantt chart.
      Parameters:
        `gc` - the Gantt chart that is being edited by the chooser
      Since:
        1.0

  - ### Method Detail

    - #### updateLists

          public void updateLists()

      Updates the content of the two lists. This method needs to be called every time before showing the panel.
      Since:
        1.0

    - #### getAvailableList

          public JList getAvailableList()

      Returns the UI list that displays the available columns.
      Returns:
        the UI list for the available columns
      Since:
        1.0

    - #### getGanttChart

          public AbstractGanttChart getGanttChart()

      Returns the Gantt chart that gets edited by the chooser.
      Returns:
        the edited Gantt chart
      Since:
        1.0

    - #### getUsedList

          public JList getUsedList()

      Returns the UI list that displays the used columns.
      Returns:
        the UI list for the used columns
      Since:
        1.0

    - #### getAddButton

          public JButton getAddButton()

      Returns the button that is being used to add a column to the list of used columns.
      Returns:
        the button used to add a column
      Since:
        1.0

    - #### getDownButton

          public JButton getDownButton()

      Returns the button that is being used to move a column down in the list of used columns.
      Returns:
        the button used to move a column down
      Since:
        1.0

    - #### getRemoveButton

          public JButton getRemoveButton()

      Returns the button that is being used to remove a column from the list of used columns.
      Returns:
        the button used to remove a column
      Since:
        1.0

    - #### getUpButton

          public JButton getUpButton()

      Returns the button that is being used to move a column up in the list of used columns.
      Returns:
        the button used to move a column up
      Since:
        1.0

    - #### createTitledBorder

          protected Border createTitledBorder(String title)

      Returns a titled border for the two lists.
      Parameters:
        `title` - the title of the list (e.g. "available columns" vs. "used columns")
      Returns:
        a titled border
      Since:
        2.0

    - #### getAvailableListScrollPane

          public JScrollPane getAvailableListScrollPane()

      Returns the scrollpane used for scrolling the "available" list.
      Returns:
        the "available" scrollpane
      Since:
        2.0

    - #### getUsedListScrollPane

          public JScrollPane getUsedListScrollPane()

      Returns the scrollpane used for scrolling the "used" list.
      Returns:
        the "used" scrollpane
      Since:
        2.0

    - #### columnModelChanged

          public void columnModelChanged(ColumnModelEvent evt)

      Description copied from interface: `IColumnModelListener`
      The listener's callback method that will be invoked when columns get added, removed, inserted.
      Specified by:
        `columnModelChanged` in interface `IColumnModelListener`
      Parameters:
        `evt` - the event description

    - #### propertyChange

          public void propertyChange(PropertyChangeEvent evt)

      Specified by:
        `propertyChange` in interface `PropertyChangeListener`

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