DasProgressPanel

java.lang.Object
- org.das2.components.DasProgressPanel

All Implemented Interfaces:: ProgressMonitor

public class DasProgressPanel
extends java.lang.Object
implements ProgressMonitor

ProgressMonitor component used throughout das2. Here's an Autoplot script demoing its operation:


monitor.setTaskSize( 100 )
monitor.started()

for i in range(100):
  if ( i>50 and monitor.isCancelled() ):
    raise Exception('cancel pressed')
  print i
  java.lang.Thread.sleep(100)
  monitor.setTaskProgress(i)

monitor.finished()

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`MSG_CANCEL_TASK`
`static java.lang.String`	`MSG_TASK_CANNOT_BE_CANCELED`
`static java.lang.String`	`PROP_CANCELLED` true if the task is cancelled.
`static java.lang.String`	`PROP_FINISHED`
`static java.lang.String`	`PROP_STARTED`

Fields inherited from interface org.das2.util.monitor.ProgressMonitor
SIZE_INDETERMINATE

Constructor Summary

Constructors
Modifier Constructor and Description

protected DasProgressPanel(java.lang.String label)

Constructors
Modifier	Constructor and Description
`protected`	`DasProgressPanel(java.lang.String label)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
`boolean`	`canBeCancelled()` return true if the process appears to support cancel.
`void`	`cancel()` Notifies the `ProgressMonitor` that the task being monitored should be canceled.
`static DasProgressPanel`	`createComponent(java.lang.String label)` return a progress panel which can be embedded within a GUI.
`static DasProgressPanel`	`createComponentPanel(DasCanvasComponent component, java.lang.String initialMessage)` return a new progress panel with component indicating status for the component.
`static DasProgressPanel`	`createComponentPanel(DasCanvas canvas, java.lang.String initialMessage)` return a new progress panel with component indicating status for the canvas.
`static DasProgressPanel`	`createFramed(java.lang.String label)` this may be called from off the event thread, but it does assume that the event thread is free.
`static DasProgressPanel`	`createFramed(java.awt.Window parent, java.lang.String label)` creates a dialog object that follows a parent
`void`	`finished()` Notifies the `ProgressMonitor` that the task being monitored has finished.
`java.awt.Component`	`getComponent()` returns the JPanel component.
`java.lang.Exception`	`getConsumer()`
`java.lang.String`	`getLabel()` Return the label string displayed, which is a concise string that describes the task being performed.
`java.lang.Exception`	`getSource()`
`ProgressMonitor`	`getSubtaskMonitor(int start, int end, java.lang.String label)` return a monitor to use for a subtask.
`ProgressMonitor`	`getSubtaskMonitor(java.lang.String label)` get the subtask monitor when the current task length is indeterminate.
`long`	`getTaskProgress()` Returns the current progress of the monitored task.
`long`	`getTaskSize()` Return the size of the task.
`boolean`	`isCancelled()` Returns `true` if the operation being tracked should be cancelled.
`boolean`	`isFinished()` true if the process has indicated that it is finished
`boolean`	`isStarted()` true if the process has indicated that it has started.
`boolean`	`isValidateRoot()` Returning true here keeps the progress bar from forcing the whole canvas to repaint when the label of the progress bar changes.
`boolean`	`isVisible()`
`static void`	`maybeCenter(ProgressMonitor mon, java.awt.Component window)` provide convenient code which will center DasProgressMonitors on window.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
`void`	`setAdditionalInfo(java.lang.String s)` Deprecated.
`void`	`setContextComponent(java.awt.Component window)` set the component where this progress monitor is understood.
`void`	`setLabel(java.lang.String label)` Set a concise string that describes the task being performed.
`void`	`setProgressMessage(java.lang.String message)` Provides additional feedback as to what's going on in the process.
`void`	`setShowProgressRate(boolean showProgressRate)` Setter for property showProgressRate.
`void`	`setTaskProgress(long position)` Notifies the ProgressMonitor of a change in the progress of the task.
`void`	`setTaskSize(long taskSize)` Sets the maximum value for the task progress of this `ProgressMonitor`.
`void`	`setVisible(boolean visible)` make the progressPanel visible or hide it.
`void`	`started()` Notifies the `ProgressMonitor` that the task being monitored has started.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MSG_CANCEL_TASK
```
public static final java.lang.String MSG_CANCEL_TASK
```
    See Also:
    
    Constant Field Values
  - MSG_TASK_CANNOT_BE_CANCELED
```
public static final java.lang.String MSG_TASK_CANNOT_BE_CANCELED
```
    See Also:
    
    Constant Field Values
  - PROP_STARTED
```
public static final java.lang.String PROP_STARTED
```
    See Also:
    
    Constant Field Values
  - PROP_FINISHED
```
public static final java.lang.String PROP_FINISHED
```
    See Also:
    
    Constant Field Values
  - PROP_CANCELLED
```
public static final java.lang.String PROP_CANCELLED
```
    true if the task is cancelled. Note cancelled will be set before finished.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DasProgressPanel
```
protected DasProgressPanel(java.lang.String label)
```
- Method Detail
  - getSubtaskMonitor
```
public ProgressMonitor getSubtaskMonitor(int start,
                                         int end,
                                         java.lang.String label)
```
    Description copied from interface: ProgressMonitor
    
    return a monitor to use for a subtask. This is provided mostly as a convenience. setTaskProgress calls to the subtask monitor are mapped to this monitor. A label can also be specified for the subtask to improve user experience. If the parent process is not supporting cancel, then subprocesses cannot support cancel.
    
    Specified by:
    
    getSubtaskMonitor in interface ProgressMonitor
    
    Parameters:
    
    start - start position on this monitor.
    
    end - end position on this monitor (exclusive).
    
    label - a label for the subtask, often this is handled as progress message; or null.
    
    Returns:
    
    a new progress monitor. (generally type SubTaskMonitor)
  - getSubtaskMonitor
```
public ProgressMonitor getSubtaskMonitor(java.lang.String label)
```
    Description copied from interface: ProgressMonitor
    
    get the subtask monitor when the current task length is indeterminate. This avoids clients having to put in dummy numbers that will cause problems in the future. The subtask can set the taskSize and taskProgress and these should be conveyed to the parent.
    
    Specified by:
    
    getSubtaskMonitor in interface ProgressMonitor
    
    Parameters:
    
    label - a label for the subtask, often this is handled as progress message; or null.
    
    Returns:
    
    a new progress monitor. (generally type SubTaskMonitor)
  - getComponent
```
public java.awt.Component getComponent()
```
    returns the JPanel component.
    
    Returns:
    
    the JPanel component.
  - setContextComponent
```
public void setContextComponent(java.awt.Component window)
```
    set the component where this progress monitor is understood. This is typically the DasCanvas.
    
    Parameters:
    
    window -
  - maybeCenter
```
public static void maybeCenter(ProgressMonitor mon,
                               java.awt.Component window)
```
    provide convenient code which will center DasProgressMonitors on window.
    
    Parameters:
    
    mon - the monitor, which may be a DasProgressPanel.
    
    window - the component about which to center the monitor.
  - createComponentPanel
```
public static DasProgressPanel createComponentPanel(DasCanvasComponent component,
                                                    java.lang.String initialMessage)
```
    return a new progress panel with component indicating status for the component.
    
    Parameters:
    
    component - the canvas component providing a context for the progress, for example a DasPlot which will load some data.
    
    initialMessage - initial message for the monitor
    
    Returns:
    
    the new component
  - createComponentPanel
```
public static DasProgressPanel createComponentPanel(DasCanvas canvas,
                                                    java.lang.String initialMessage)
```
    return a new progress panel with component indicating status for the canvas.
    
    Parameters:
    
    canvas - the canvas client providing a context for the task.
    
    initialMessage - initial message for the monitor
    
    Returns:
  - isValidateRoot
```
public boolean isValidateRoot()
```
    Returning true here keeps the progress bar from forcing the whole canvas to repaint when the label of the progress bar changes.
    
    Returns:
    
    this always returns true
  - createFramed
```
public static DasProgressPanel createFramed(java.lang.String label)
```
    this may be called from off the event thread, but it does assume that the event thread is free.
    
    Parameters:
    
    label - label describing the task.
    
    Returns:
    
    a DasProgressPanel.
  - createFramed
```
public static DasProgressPanel createFramed(java.awt.Window parent,
                                            java.lang.String label)
```
    creates a dialog object that follows a parent
    
    Parameters:
    
    parent - the Window that owns this popup gui.
    
    label - label describing the task.
    
    Returns:
    
    a DasProgressPanel.
  - createComponent
```
public static DasProgressPanel createComponent(java.lang.String label)
```
    return a progress panel which can be embedded within a GUI. Use getComponent() to return the component which should be embedded.
    
    Parameters:
    
    label - string label for the label.
    
    Returns:
    
    a new DasProgressPanel
    
    See Also:
    
    getComponent()
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Description copied from interface: ProgressMonitor
    
    Set a concise string that describes the task being performed. Monitors don't necessarily need to display this label, and this request may be ignored. It is only provided so a process can describe the task that is going on. This is usually set by the client of the process to indicate what service we are waiting for. e.g. "Loading Data"
    
    Specified by:
    
    setLabel in interface ProgressMonitor
    
    Parameters:
    
    label - the label describing the task.
  - getLabel
```
public java.lang.String getLabel()
```
    Description copied from interface: ProgressMonitor
    
    Return the label string displayed, which is a concise string that describes the task being performed. This is primarily to aid in debugging, and this method need not return the string set by setLabel.
    
    Specified by:
    
    getLabel in interface ProgressMonitor
    
    Returns:
    
    the label.
  - finished
```
public void finished()
```
    Description copied from interface: ProgressMonitor
    
    Notifies the ProgressMonitor that the task being monitored has finished. This must only be called once, and note that isFinished() must return the state of this monitor.
    
    Specified by:
    
    finished in interface ProgressMonitor
  - setTaskProgress
```
public void setTaskProgress(long position)
                     throws java.lang.IllegalStateException
```
    Description copied from interface: ProgressMonitor
    
    Notifies the ProgressMonitor of a change in the progress of the task.
    
    Specified by:
    
    setTaskProgress in interface ProgressMonitor
    
    Parameters:
    
    position - the current task position
    
    Throws:
    
    java.lang.IllegalStateException
  - canBeCancelled
```
public boolean canBeCancelled()
```
    Description copied from interface: ProgressMonitor
    
    return true if the process appears to support cancel. Many processes use a monitor to provide status feedback, but do not check if the human operator has pressed cancel.
    
    Specified by:
    
    canBeCancelled in interface ProgressMonitor
    
    Returns:
  - setAdditionalInfo
```
@Deprecated
public void setAdditionalInfo(java.lang.String s)
```
    Deprecated.
    
    Description copied from interface: ProgressMonitor
    
    additional information to be displayed alongside the progress. That might be of interest. "85 of 100 (50KB/s)"
    
    Specified by:
    
    setAdditionalInfo in interface ProgressMonitor
    
    Parameters:
    
    s - the message, such as (50KB/s)
  - getTaskProgress
```
public long getTaskProgress()
```
    Description copied from interface: ProgressMonitor
    
    Returns the current progress of the monitored task.
    
    Specified by:
    
    getTaskProgress in interface ProgressMonitor
    
    Returns:
    
    the current progress of the monitored task.
  - getTaskSize
```
public long getTaskSize()
```
    Description copied from interface: ProgressMonitor
    
    Return the size of the task. The units are arbitrary
    
    Specified by:
    
    getTaskSize in interface ProgressMonitor
    
    Returns:
    
    the size of the task.
  - setTaskSize
```
public void setTaskSize(long taskSize)
```
    Description copied from interface: ProgressMonitor
    
    Sets the maximum value for the task progress of this ProgressMonitor.
    
    Specified by:
    
    setTaskSize in interface ProgressMonitor
    
    Parameters:
    
    taskSize - maximum value for the task progress. A taskSize of -1 indicates the taskSize is indeterminate.
  - setVisible
```
public void setVisible(boolean visible)
```
    make the progressPanel visible or hide it. This
    
    Parameters:
    
    visible - true if the progressPanel should be visible.
  - isVisible
```
public boolean isVisible()
```
  - started
```
public void started()
```
    Description copied from interface: ProgressMonitor
    
    Notifies the ProgressMonitor that the task being monitored has started. If the ProgressMonitor is in a cancelled state when this method is called, that ProgressMonitor should be 'uncancelled'.
    
    Specified by:
    
    started in interface ProgressMonitor
  - cancel
```
public void cancel()
```
    Description copied from interface: ProgressMonitor
    
    Notifies the ProgressMonitor that the task being monitored should be canceled. After this method is called, implementations should return true on any subsequent calls to ProgressMonitor.isCancelled() and should throw an IllegalStateException on any subsequent calls to ProgressMonitor.setTaskProgress(long).
    
    Specified by:
    
    cancel in interface ProgressMonitor
  - isCancelled
```
public boolean isCancelled()
```
    Description copied from interface: ProgressMonitor
    
    Returns true if the operation being tracked should be cancelled. For example, the human operator has pressed the cancel button indicating that the process should be stopped. Note that if the process is not checking the cancel status, the cancel button should be disabled.
    
    Specified by:
    
    isCancelled in interface ProgressMonitor
    
    Returns:
    
    true if the operation being tracked should be cancelled.
  - getSource
```
public java.lang.Exception getSource()
```
  - getConsumer
```
public java.lang.Exception getConsumer()
```
  - setShowProgressRate
```
public void setShowProgressRate(boolean showProgressRate)
```
    Setter for property showProgressRate.
    
    Parameters:
    
    showProgressRate - New value of property showProgressRate.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setProgressMessage
```
public void setProgressMessage(java.lang.String message)
```
    Description copied from interface: ProgressMonitor
    
    Provides additional feedback as to what's going on in the process. This message should be set by the service provider, not the client, and refer to the implementation of the task. e.g. "Reading file myData.dat"
    
    Specified by:
    
    setProgressMessage in interface ProgressMonitor
    
    Parameters:
    
    message - the message describing the state of progress.
  - isStarted
```
public boolean isStarted()
```
    Description copied from interface: ProgressMonitor
    
    true if the process has indicated that it has started.
    
    Specified by:
    
    isStarted in interface ProgressMonitor
    
    Returns:
    
    true if the process has indicated that it has started.
  - isFinished
```
public boolean isFinished()
```
    Description copied from interface: ProgressMonitor
    
    true if the process has indicated that it is finished
    
    Specified by:
    
    isFinished in interface ProgressMonitor
    
    Returns:
    
    true if the process has indicated that it is finished
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
```
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
```

Class DasProgressPanel

Field Summary

Fields inherited from interface org.das2.util.monitor.ProgressMonitor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MSG_CANCEL_TASK

MSG_TASK_CANNOT_BE_CANCELED

PROP_STARTED

PROP_FINISHED

PROP_CANCELLED

Constructor Detail

DasProgressPanel

Method Detail

getSubtaskMonitor

getSubtaskMonitor

getComponent

setContextComponent

maybeCenter

createComponentPanel

createComponentPanel

isValidateRoot

createFramed

createFramed

createComponent

setLabel

getLabel

finished

setTaskProgress

canBeCancelled

setAdditionalInfo

getTaskProgress

getTaskSize

setTaskSize

setVisible

isVisible

started

cancel

isCancelled

getSource

getConsumer

setShowProgressRate

toString

setProgressMessage

isStarted

isFinished

addPropertyChangeListener

removePropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener