com.isti.util.gui
Class ManagedJProgressBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JProgressBar
                  com.isti.util.gui.ManagedJProgressBar

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, ProgressIndicatorInterface, java.io.Serializable, javax.swing.SwingConstants

public class ManagedJProgressBar

extends javax.swing.JProgressBar

implements ProgressIndicatorInterface

Class ManagedJProgressBar is an extension of 'JProgressBar' that enforces the paradigm that list changes should only happen via the event-dispatch thread.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JProgressBar

javax.swing.JProgressBar.AccessibleJProgressBar

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes 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.JProgressBar

changeEvent, changeListener, model, orientation, paintBorder, paintString, progressString

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.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ManagedJProgressBar()
Creates a horizontal progress bar.

ManagedJProgressBar(javax.swing.BoundedRangeModel newModel)
Creates a horizontal progress bar, the default orientation.

ManagedJProgressBar(int orient)
Creates a progress bar with the specified orientation.

ManagedJProgressBar(int min, int max)
Creates a horizontal progress bar, which is the default.

ManagedJProgressBar(int orient, int min, int max)
Creates a progress bar using the specified orientation, minimum, and maximum.

Method Summary

void	setMaximum(int val) Sets the model's maximum.
void	setMinimum(int val) Sets the model's minimum.
void	setMinMaxValues(int minVal, int maxVal) Sets the model's minimum and maximum values.
void	setValue(int val) Sets the model's current value.

Methods inherited from class javax.swing.JProgressBar

addChangeListener, createChangeListener, fireStateChanged, getAccessibleContext, getChangeListeners, getMaximum, getMinimum, getModel, getOrientation, getPercentComplete, getString, getUI, getUIClassID, getValue, isBorderPainted, isIndeterminate, isStringPainted, paintBorder, paramString, removeChangeListener, setBorderPainted, setIndeterminate, setModel, setOrientation, setString, setStringPainted, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

Methods inherited from interface com.isti.util.ProgressIndicatorInterface

getMaximum, getMinimum, getOrientation, getValue, setOrientation

Constructor Detail

ManagedJProgressBar

public ManagedJProgressBar()

Creates a horizontal progress bar. The default orientation for progress bars is JProgressBar.HORIZONTAL. By default, the String is set to null and the StringPainted is not painted. The border is painted by default. Uses the defaultMinimum (0) and defaultMaximum (100). Uses the defaultMinimum for the initial value of the progress bar.

ManagedJProgressBar

public ManagedJProgressBar(int orient)

Creates a progress bar with the specified orientation. By default, the String is set to null and the StringPainted is not painted. The border is painted by default. Uses the defaultMinimum (0) and defaultMaximum (100). Uses the defaultMinimum for the initial value of the progress bar.

Parameters:

orient - the orientation to use, which can be either JProgressBar.VERTICAL or JProgressBar.HORIZONTAL.

ManagedJProgressBar

public ManagedJProgressBar(int min,
                           int max)

Creates a horizontal progress bar, which is the default. By default, the String is set to null and the StringPainted is not painted. The border is painted by default. Uses the specified minimum for the initial value of the progress bar.

Parameters:

min - the minimum value to use.

max - the maximum value to use.

ManagedJProgressBar

public ManagedJProgressBar(int orient,
                           int min,
                           int max)

Creates a progress bar using the specified orientation, minimum, and maximum. By default, the String is set to null and the StringPainted is not painted. The border is painted by default. Sets the inital value of the progress bar to the specified minimum. The BoundedRangeModel that sits underneath the progress bar handles any issues that may arrise from improperly setting the minimum, value, and maximum on the progress bar.

Parameters:

orient - the orientation to use, which can be either JProgressBar.VERTICAL or JProgressBar.HORIZONTAL.

min - the minimum value to use.

max - the maximum value to use.

ManagedJProgressBar

public ManagedJProgressBar(javax.swing.BoundedRangeModel newModel)

Creates a horizontal progress bar, the default orientation. By default, the String is set to null and the StringPainted is not painted. The border is painted by default.

Parameters:

newModel - the BoundedRangeModel to use, which holds the minimum, value, and maximum values.

Method Detail

setValue

public void setValue(int val)

Sets the model's current value. If the thread calling this method is not the event-dispatch thread then the action is queued and invoked later by the event-dispatch thread. The underlying BoundedRangeModel will handle any mathematical issues arrising from assigning faulty values.

Specified by:

setValue in interface ProgressIndicatorInterface

Parameters:

val - the new value.

setMinimum

public void setMinimum(int val)

Sets the model's minimum. The underlying BoundedRangeModel will handle any mathematical issues arrising from assigning faulty values. Notifies any listeners if the data changes. If the thread calling this method is not the event-dispatch thread then the action is queued and invoked later by the event-dispatch thread.

Specified by:

setMinimum in interface ProgressIndicatorInterface

Parameters:

val - the new minimum value.

setMaximum

public void setMaximum(int val)

Sets the model's maximum. The underlying BoundedRangeModel will handle any mathematical issues arrising from assigning faulty values. Notifies any listeners if the data changes. If the thread calling this method is not the event-dispatch thread then the action is queued and invoked later by the event-dispatch thread.

Specified by:

setMaximum in interface ProgressIndicatorInterface

Parameters:

val - the new maximum value.

setMinMaxValues

public void setMinMaxValues(int minVal,
                            int maxVal)

Sets the model's minimum and maximum values. The underlying BoundedRangeModel will handle any mathematical issues arrising from assigning faulty values. Notifies any listeners if the data changes. If the thread calling this method is not the event-dispatch thread then the action is queued and invoked later by the event-dispatch thread.

Parameters:

minVal - the new minimum value.

maxVal - the new maximum value.