Package gov.nih.mipav.view

Class JPanelProgressBar

  • All Implemented Interfaces:
    ProgressBarInterface, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    public class JPanelProgressBar
extends javax.swing.JPanel
implements ProgressBarInterface

    Title: JPanelProgressBar

    Description: simple jpanel containing a JProgressBar (similar to ViewJProgressBar but in a panel, not a frame)

    Version:
    1.0
    Author:
    blink
    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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private javax.swing.JProgressBar pBar
      Actual bar which fills with color as the percentage of completion increases.
      private static long serialVersionUID
      Use serialVersionUID for interoperability.

      • 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 Description
      JPanelProgressBar()
      Creates a new JPanelProgressBar object.
      JPanelProgressBar​(int min, int max)
      Creates a new JPanelProgressBar object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void appendMessage​(java.lang.String message)
      DOCUMENT ME!
      void dispose()
      DOCUMENT ME!
      void finalize()
      DOCUMENT ME!
      javax.swing.JProgressBar getProgressBar()
      Get the progress bar.
      int getValue()
      Used to get the present value of the progress bar.
      boolean isComplete()
      Used to determine if the progress bar is at 100%.
      void setMessage​(java.lang.String message)
      DOCUMENT ME!
      void setTitle​(java.lang.String title)
      DOCUMENT ME!
      void setValue​(int value)
      Used to set the present value of the progress bar.
      void setValue​(int value, boolean separateThread)
      DOCUMENT ME!
      void setValueImmed​(int value)
      Used to set the present value of the progress bar.
      void setVisible​(boolean vis)
      DOCUMENT ME!
      void updateValue​(int value)
      Used to set the present value of the progress bar.
      void updateValue​(int value, boolean separateThread)
      DOCUMENT ME!
      void updateValueImmed​(int value)
      Used to set the present value of the progress bar.

      • 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        Use serialVersionUID for interoperability.
        See Also:
        Constant Field Values

      • pBar

        private javax.swing.JProgressBar pBar
        Actual bar which fills with color as the percentage of completion increases.

    • Constructor Detail

      • JPanelProgressBar

        public JPanelProgressBar()
        Creates a new JPanelProgressBar object.

      • JPanelProgressBar

        public JPanelProgressBar​(int min,
                         int max)
        Creates a new JPanelProgressBar object.
        Parameters:
        min - int
        max - int

    • Method Detail

      • appendMessage

        public void appendMessage​(java.lang.String message)
        DOCUMENT ME!
        Specified by:
        appendMessage in interface ProgressBarInterface
        Parameters:
        message - DOCUMENT ME!

      • finalize

        public void finalize()
        DOCUMENT ME!
        Overrides:
        finalize in class java.lang.Object

      • getProgressBar

        public javax.swing.JProgressBar getProgressBar()
        Get the progress bar.
        Specified by:
        getProgressBar in interface ProgressBarInterface
        Returns:
        pBar the progress bar.

      • getValue

        public int getValue()
        Used to get the present value of the progress bar.
        Specified by:
        getValue in interface ProgressBarInterface
        Returns:
        Value of progress bar.

      • isComplete

        public boolean isComplete()
        Used to determine if the progress bar is at 100%.
        Specified by:
        isComplete in interface ProgressBarInterface
        Returns:
        true if progress bar is at 100%, false if not.

      • setMessage

        public void setMessage​(java.lang.String message)
        DOCUMENT ME!
        Specified by:
        setMessage in interface ProgressBarInterface
        Parameters:
        message - DOCUMENT ME!

      • setTitle

        public void setTitle​(java.lang.String title)
        DOCUMENT ME!
        Specified by:
        setTitle in interface ProgressBarInterface
        Parameters:
        title - DOCUMENT ME!

      • setValue

        public void setValue​(int value)
        Used to set the present value of the progress bar. Changes the percentage label and title of the frame as well.
        Parameters:
        value - Set the progress bar to the given value.

      • setValue

        public void setValue​(int value,
                     boolean separateThread)
        DOCUMENT ME!
        Parameters:
        value - DOCUMENT ME!
        separateThread - DOCUMENT ME!

      • setValueImmed

        public void setValueImmed​(int value)
        Used to set the present value of the progress bar. Changes the percentage label and title of the frame as well.
        Parameters:
        value - Set the progress bar to the given value.

      • setVisible

        public void setVisible​(boolean vis)
        DOCUMENT ME!
        Specified by:
        setVisible in interface ProgressBarInterface
        Overrides:
        setVisible in class javax.swing.JComponent
        Parameters:
        vis - DOCUMENT ME!

      • updateValue

        public void updateValue​(int value)
        Used to set the present value of the progress bar. Changes the percentage label and title of the frame as well.
        Parameters:
        value - Set the progress bar to the given value.

      • updateValue

        public void updateValue​(int value,
                        boolean separateThread)
        DOCUMENT ME!
        Specified by:
        updateValue in interface ProgressBarInterface
        Parameters:
        value - DOCUMENT ME!
        separateThread - DOCUMENT ME!

      • updateValueImmed

        public void updateValueImmed​(int value)
        Used to set the present value of the progress bar. Changes the percentage label and title of the frame as well. It also forces an immediate update of the frame. Typically used when using IO functions.
        Parameters:
        value - Set the progress bar to the given value.