Package org.jorigin.task

Class ActivityMonitor

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
    public class ActivityMonitor
extends javax.swing.JDialog
    A class that enables to graphically monitor tasks.
    Author:
    Julien Seinturier
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JDialog

        javax.swing.JDialog.AccessibleJDialog

      • Nested classes/interfaces inherited from class java.awt.Dialog

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

      • Nested classes/interfaces inherited from class java.awt.Window

        java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

      • 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
      static int SHOW_PROGRESS_ALL
      Show all progress flag.
      static int SHOW_PROGRESS_COUNT
      Show the progress count flag.
      static int SHOW_PROGRESS_PERCENT
      Show the progress percent flag.

      • Fields inherited from class javax.swing.JDialog

        accessibleContext, rootPane, rootPaneCheckingEnabled

      • Fields inherited from class java.awt.Dialog

        DEFAULT_MODALITY_TYPE

      • 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

      • Fields inherited from interface javax.swing.WindowConstants

        DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

    • Constructor Summary

      Constructors 
      Constructor Description
      ActivityMonitor​(javax.swing.JFrame owner)
      Creates a new default activity monitor attached to the given owner component.
      ActivityMonitor​(javax.swing.JFrame owner, boolean activityTracerVisible, boolean progressLabelVisible, boolean progressBarVisible)
      Create a new activity monitor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void disposeTasks()
      Dispose all active tasks displayed within the monitor.
      int getActivityTracerHeight()
      Get the desired height of the activity tracer in pixels.
      int getProgressBarHeight()
      Get the desired height of the progress bars in pixels.
      int getProgressLabelHeight()
      Get the desired height of the progress labels in pixels.
      void init​(boolean activityVisible, boolean progressBarVisible)
      Init the activity monitor.
      protected void initGUI()  
      boolean isActivityTracerVisible()
      Get if the activity tracer that log progress details is visible.
      boolean isPersistenceCheckBoxVisible()
      Get if the persistence check box is visible.
      boolean isPersistent()
      Get the persistence value of the activity monitor.
      boolean isProgessBarVisible()
      Get if the progress bars are visible.
      boolean isProgessLabelVisible()
      Get if the progress labels (textual labels above progress bars) are visible.
      boolean isShowProgressionText()
      Set if the progression labels has to be visible.
      boolean isUseNewLine()
      Is the monitor use new line for writing task informations.
      void processTaskEvent​(TaskEvent event)
      Process a task event.
      void processTaskEvent​(TaskEvent event, boolean progressBarVisible)
      Process a task event.
      protected void refreshGUI()
      Refresh the graphical user interface components.
      void setActivityTracerHeight​(int height)
      Set the the desired height of the activity tracer in pixels.
      void setActivityTracerVisible​(boolean visible)
      Set if the activity tracer that log progress details has to be visible.
      void setPersistenceCheckBoxVisible​(boolean visible)
      Set if the persistence check box has to be visible.
      void setPersistent​(boolean isPersistent)
      Specify if the activity monitor is persistent.
      void setProgressBarHeight​(int height)
      Set the desired height of the progress bars in pixels.
      void setProgressBarVisible​(boolean visible)
      Set if the progress bars are visible.
      void setProgressLabelHeight​(int height)
      Set the desired height of the progress labels in pixels.
      void setProgressLabelVisible​(boolean visible)
      Set if the progress labels (textual labels above progress bars) are visible.
      void setShowProgressionText​(boolean showProgressionText)
      Get if the progression labels are visible.
      void setUseNewLine​(boolean useNewLine)
      Set if the monitor use new line for writing task informations.

      • Methods inherited from class javax.swing.JDialog

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

      • Methods inherited from class java.awt.Dialog

        addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

      • Methods inherited from class java.awt.Window

        addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, 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

    • Field Detail

      • SHOW_PROGRESS_PERCENT

        public static final int SHOW_PROGRESS_PERCENT
        Show the progress percent flag.
        See Also:
        Constant Field Values

      • SHOW_PROGRESS_COUNT

        public static final int SHOW_PROGRESS_COUNT
        Show the progress count flag.
        See Also:
        Constant Field Values

      • SHOW_PROGRESS_ALL

        public static final int SHOW_PROGRESS_ALL
        Show all progress flag.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ActivityMonitor

        public ActivityMonitor​(javax.swing.JFrame owner,
                       boolean activityTracerVisible,
                       boolean progressLabelVisible,
                       boolean progressBarVisible)
        Create a new activity monitor.
        Parameters:
        owner - the owner of the component.
        activityTracerVisible - is the activity tracer has to be visible.
        progressLabelVisible - is the progress labels have to be visible.
        progressBarVisible - is the progress bars have to be visible.

      • ActivityMonitor

        public ActivityMonitor​(javax.swing.JFrame owner)
        Creates a new default activity monitor attached to the given owner component.
        Parameters:
        owner - the owner component.

    • Method Detail

      • isUseNewLine

        public boolean isUseNewLine()
        Is the monitor use new line for writing task informations.
        Returns:
        true if the monitor has to use new line for writing task information of false otherwise.
        See Also:
        setUseNewLine(boolean)

      • setUseNewLine

        public void setUseNewLine​(boolean useNewLine)
        Set if the monitor use new line for writing task informations.
        Parameters:
        useNewLine - true if the monitor has to use new line for writing task information of false otherwise.
        See Also:
        isUseNewLine()

      • setActivityTracerHeight

        public void setActivityTracerHeight​(int height)
        Set the the desired height of the activity tracer in pixels.
        Parameters:
        height - the the desired height of the activity tracer in pixels.
        See Also:
        getActivityTracerHeight(), isActivityTracerVisible()

      • isActivityTracerVisible

        public boolean isActivityTracerVisible()
        Get if the activity tracer that log progress details is visible.
        Returns:
        true if the text area that log progress details is visible and false otherwise.
        See Also:
        setActivityTracerVisible(boolean)

      • setActivityTracerVisible

        public void setActivityTracerVisible​(boolean visible)
        Set if the activity tracer that log progress details has to be visible.
        Parameters:
        visible - true if the text area that log progress details has to be visible and false otherwise.
        See Also:
        isActivityTracerVisible()

      • isPersistenceCheckBoxVisible

        public boolean isPersistenceCheckBoxVisible()
        Get if the persistence check box is visible.
        Returns:
        true if the persistence check box is visible and false otherwise.
        See Also:
        setPersistenceCheckBoxVisible(boolean)

      • setPersistenceCheckBoxVisible

        public void setPersistenceCheckBoxVisible​(boolean visible)
        Set if the persistence check box has to be visible.
        Parameters:
        visible - true if the persistence check box is visible and false otherwise.
        See Also:
        isPersistenceCheckBoxVisible()

      • isProgessLabelVisible

        public boolean isProgessLabelVisible()
        Get if the progress labels (textual labels above progress bars) are visible.
        Returns:
        true if the progress label are visible and false otherwise.
        See Also:
        setProgressLabelVisible(boolean)

      • setProgressLabelVisible

        public void setProgressLabelVisible​(boolean visible)
        Set if the progress labels (textual labels above progress bars) are visible.
        Parameters:
        visible - true if the progress label are visible and false otherwise.
        See Also:
        isProgessLabelVisible()

      • isProgessBarVisible

        public boolean isProgessBarVisible()
        Get if the progress bars are visible.
        Returns:
        true if the progress bar are visible and false otherwise.
        See Also:
        setProgressBarVisible(boolean)

      • setProgressBarVisible

        public void setProgressBarVisible​(boolean visible)
        Set if the progress bars are visible.
        Parameters:
        visible - true if the progress bar are visible and false otherwise.
        See Also:
        isProgessBarVisible()

      • isShowProgressionText

        public boolean isShowProgressionText()
        Set if the progression labels has to be visible.
        Returns:
        true if the progression labels are visible and false otherwise.
        See Also:
        isProgessLabelVisible()

      • setShowProgressionText

        public void setShowProgressionText​(boolean showProgressionText)
        Get if the progression labels are visible.
        Parameters:
        showProgressionText - true if the progression labels are visible and false otherwise.
        See Also:
        setProgressLabelVisible(boolean)

      • setPersistent

        public void setPersistent​(boolean isPersistent)
        Specify if the activity monitor is persistent. If it's the case, the monitor is always displayed. If the isPersistent value is equals to false, the activity monitor is hiden when all monitored tasks are finished.
        Parameters:
        isPersistent - the persistence value of the activity monitor

      • isPersistent

        public boolean isPersistent()
        Get the persistence value of the activity monitor. If the isPersistent value is equals to false, the activity monitor is hiden when all monitored tasks are finished. Otherwise, the monotor is always visible.
        Returns:
        the persistence value of the monitor.

      • initGUI

        protected void initGUI()

      • refreshGUI

        protected void refreshGUI()
        Refresh the graphical user interface components.

      • init

        public void init​(boolean activityVisible,
                 boolean progressBarVisible)
        Init the activity monitor.
        Parameters:
        activityVisible - is the activity tracer is visible.
        progressBarVisible - is the progress bar is visible.

      • processTaskEvent

        public void processTaskEvent​(TaskEvent event,
                             boolean progressBarVisible)
        Process a task event. The boolean progressBarVisible can be used to override the isProgessBarVisible() and isProgessLabelVisible() values for the specified task.
        Parameters:
        event - The task Event to process.
        progressBarVisible - true if a task progress (progress bar plus label) has to be created for this task.

      • disposeTasks

        public void disposeTasks()
        Dispose all active tasks displayed within the monitor. You can use this method is the monitored process has failed.