com.dlsc.flexgantt.swing.timeline
Class TimeGranularityTimelineControlPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.dlsc.flexgantt.swing.timeline.AbstractTimelineControlPanel<TimeGranularity>
                      com.dlsc.flexgantt.swing.timeline.TimeGranularityTimelineControlPanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ChangeListener

public class TimeGranularityTimelineControlPanel
extends AbstractTimelineControlPanel<TimeGranularity>

A timeline control panel implementation that can be used in situations where the dateline model is an instance of TimeGranularityDatelineModel.

Since:

1.0

Author:

Dirk Lemmermann

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

TimeGranularityTimelineControlPanel(Timeline timeline)
Constructs a new control panel.

TimeGranularityTimelineControlPanel(Timeline timeline, boolean showGranularity)
Constructs a new control panel.

Method Summary

void	applySettings() Applys the settings made in the control panel to the timeline.
protected javax.swing.SpinnerModel	createEndTimeModel() Creates the model for the end time spinner.
protected javax.swing.ComboBoxModel	createGranularityModel() Creates the model for the granularity combo box.
protected javax.swing.SpinnerModel	createStartTimeModel() Creates the model for the start time spinner.
ITimeSpan	getTimeSpan() Returns the time span shown by the panel (not the timeline)
boolean	isValidSettings() Checks whether the current settings are valid (end time is larger or equal to start time).
static void	openDialog(java.awt.Component comp, Timeline timeline) A utility method to quickly bring up a dialog that contains the control panel.
protected void	setTimeSpan(ITimeSpan span) Sets the time span shown by the panel (not on the timeline, updates the start and end spinner).
void	updateControlPanel() Updates the control panel to reflect the current settings of the timeline.

Methods inherited from class com.dlsc.flexgantt.swing.timeline.AbstractTimelineControlPanel

actionPerformed, getApplyButton, getEndTimeModel, getEndTimeSpinner, getFromLabel, getGranularity, getGranularityBox, getGranularityLabel, getGranularityModel, getStartTimeModel, getStartTimeSpinner, getTimeline, getToLabel, setGranularity, stateChanged

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeGranularityTimelineControlPanel

public TimeGranularityTimelineControlPanel(Timeline timeline,
                                           boolean showGranularity)

Constructs a new control panel.

Parameters:

timeline - the timeline controlled by the panel

showGranularity - if TRUE the controls for changing the granularity will be shown

Since:

1.0

TimeGranularityTimelineControlPanel

public TimeGranularityTimelineControlPanel(Timeline timeline)

Constructs a new control panel.

Parameters:

timeline - the timeline controlled by the panel

Since:

1.0

Method Detail

updateControlPanel

public void updateControlPanel()

Description copied from class: AbstractTimelineControlPanel

Updates the control panel to reflect the current settings of the timeline.

Specified by:

updateControlPanel in class AbstractTimelineControlPanel<TimeGranularity>

setTimeSpan

protected void setTimeSpan(ITimeSpan span)

Description copied from class: AbstractTimelineControlPanel

Sets the time span shown by the panel (not on the timeline, updates the start and end spinner).

Specified by:

setTimeSpan in class AbstractTimelineControlPanel<TimeGranularity>

Parameters:

span - the timeline's time span

getTimeSpan

public ITimeSpan getTimeSpan()

Description copied from class: AbstractTimelineControlPanel

Returns the time span shown by the panel (not the timeline)

Specified by:

getTimeSpan in class AbstractTimelineControlPanel<TimeGranularity>

Returns:

the panel's time span

isValidSettings

public boolean isValidSettings()

Description copied from class: AbstractTimelineControlPanel

Checks whether the current settings are valid (end time is larger or equal to start time).

Specified by:

isValidSettings in class AbstractTimelineControlPanel<TimeGranularity>

Returns:

TRUE if the current settings made in the panel are consistent / valid

createStartTimeModel

protected javax.swing.SpinnerModel createStartTimeModel()

Description copied from class: AbstractTimelineControlPanel

Creates the model for the start time spinner.

Specified by:

createStartTimeModel in class AbstractTimelineControlPanel<TimeGranularity>

Returns:

a spinner model

createEndTimeModel

protected javax.swing.SpinnerModel createEndTimeModel()

Description copied from class: AbstractTimelineControlPanel

Creates the model for the end time spinner.

Specified by:

createEndTimeModel in class AbstractTimelineControlPanel<TimeGranularity>

Returns:

a spinner model

createGranularityModel

protected javax.swing.ComboBoxModel createGranularityModel()

Description copied from class: AbstractTimelineControlPanel

Creates the model for the granularity combo box.

Specified by:

createGranularityModel in class AbstractTimelineControlPanel<TimeGranularity>

Returns:

a combo box model

applySettings

public void applySettings()

Description copied from class: AbstractTimelineControlPanel

Applys the settings made in the control panel to the timeline.

Specified by:

applySettings in class AbstractTimelineControlPanel<TimeGranularity>

openDialog

public static void openDialog(java.awt.Component comp,
                              Timeline timeline)

A utility method to quickly bring up a dialog that contains the control panel.

Parameters:

comp - a component that will be used to lookup a parent frame for the dialog

timeline - the timeline that will be modified by the control

Since:

1.0