Module org.jcommon
Package org.jorigin.swing.task

Class JActivityMonitor

    • 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

      • JActivityMonitor

        public JActivityMonitor​(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.

      • JActivityMonitor

        public JActivityMonitor​(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()
        Initialize the Graphical User Interface (GUI) components.

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