Package offlineProcessing

Class OLProcessDialog

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
javax.swing.JDialog
PamView.dialog.PamDialog
offlineProcessing.OLProcessDialog
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
Direct Known Subclasses:
CTProcessDialog, TMOfflineFunctions.TMOLProcessDialog
public class OLProcessDialog extends PamDialog
Dialog for offline processing of a particular data type.
Will offer the user choices in how to select data (e.g. loaded, or all) and then scroll through those data passing one data unit at a time to a series of tasks which will have been added by the programmer, but can be individually turned off and on by the user. Each task will have a check box to enable it and an optional button to configure it. Bottom part of the dialog shows a progress indicator.
Author:
Douglas Gillespie
See Also:

  • Field Details

    • settings

      public static org.kordamp.ikonli.swing.FontIcon settings

  • Constructor Details

    • OLProcessDialog

      public OLProcessDialog(Window parentFrame, OfflineTaskGroup taskGroup, String title)
      Create dialog to process a group of offline tasks.
      Parameters:
      parentFrame -
      taskGroup -
      title -

    • OLProcessDialog

      public OLProcessDialog(Window parentFrame, OfflineTaskGroup taskGroup, String title, boolean batchMode, TaskMonitor extraMonitor)
      Create dialog to process a group of offline tasks.
      Parameters:
      parentFrame -
      taskGroup -
      title -
      batchMode - only true for batch processing. Will disable everything and start jobs automatically.
      extraMonitor - additional task monitor that will get forwarded task mon messages when tasks running.

  • Method Details

    • removeNotePanel

      public void removeNotePanel()
      Remove the notes panel.

    • getMainPanel

      public JPanel getMainPanel()
      Get the main panel. This can be used to add additional controls if needed.
      Returns:
      the main panel.

    • getDeleteOldDataBox

      public JCheckBox getDeleteOldDataBox()
      Get the delete old data check box
      Returns:
      the delete data check box;

    • getDataSelBox

      public JComboBox<String> getDataSelBox()
      The data selection ComboBox. Use this for changing names.

    • okButtonPressed

      protected void okButtonPressed()
      Overrides:
      okButtonPressed in class PamDialog

    • enableControls

      public void enableControls()
      // * Enable controls within the dialog with the input OfflineTask group being null.

    • enableControls

      public void enableControls(OfflineTask task)
      Enable controls in the dialog.
      Parameters:
      task - - the task group in whihc enable controls has been called from

    • cancelButtonPressed

      public void cancelButtonPressed()
      Description copied from class: PamDialog
      called when the cancel button is pressed before the dialog closes. Generally you should set the parameters returned by the dialog to null or some default value, or in some other way indicate that Cancel was pressed.
      Specified by:
      cancelButtonPressed in class PamDialog

    • getParams

      public boolean getParams()
      Description copied from class: PamDialog
      called when the Ok button is pressed. This must return true in order that the dialog may close. It should also copy all parameters into an object that will be returned by showDialog.
      Specified by:
      getParams in class PamDialog

    • setTaskToolTips

      public void setTaskToolTips()

    • newDataSelection

      public void newDataSelection()

    • restoreDefaultSettings

      public void restoreDefaultSettings()
      Description copied from class: PamDialog
      standard function which should us used to copy default parameters into the dialog controls.
      Specified by:
      restoreDefaultSettings in class PamDialog

    • setVisible

      public void setVisible(boolean visible)
      Overrides:
      setVisible in class PamDialog

    • settingsAction

      public boolean settingsAction(Component component, OfflineTask offlineTask)
      Settings button action.
      Parameters:
      component -
      offlineTask -
      Returns:

    • getCurrentStatus

      public TaskStatus getCurrentStatus()
      Get the current status of the dialog.
      Returns:
      the current status.

    • getSettingsButtons

      public JButton[] getSettingsButtons()
      Get the current list of settings buttons which will mirror the current offline tasks available in the dialog.
      Returns:
      list of settings buttons.

    • getTaskCheckBoxs

      public JCheckBox[] getTaskCheckBoxs()
      Get list of check boxes for the offline tasks
      Returns:
      a list of check boxes.

    • getTaskGroup

      public OfflineTaskGroup getTaskGroup()
      Get the task group for the dialog.
      Returns:
      the taks group.

    • isNeedaNote

      public boolean isNeedaNote()
      Check whether a note is required.
      Returns:
      true if a note is required.

    • setNeedaNote

      public void setNeedaNote(boolean isNeedaNote)
      Set whether a note is required before processing
      Parameters:
      isNeedaNote - - true to require user to input a note.

    • getGlobalProgress

      public JProgressBar getGlobalProgress()

    • getTasksPanel

      public PamAlignmentPanel getTasksPanel()