Package gov.nih.mipav.view.dialogs

Class JDialogAddMargins

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
javax.swing.JDialog
gov.nih.mipav.view.dialogs.JDialogBase
gov.nih.mipav.view.dialogs.JDialogScriptableBase
gov.nih.mipav.view.dialogs.JDialogAddMargins
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogAddMargins extends JDialogScriptableBase implements AlgorithmInterface
Creates the dialog to add margins around the image.

User selects:

  1. Pixels on each side
  2. Pixels on top and bottom
  3. Slices at the front of the image
  4. Slices at the back of the image

The user chooses a value for the margins, with the image minimum the default. If Color, values are chosen for red, green, and blue. A new image or replacement of the old image may be selected.

See Also:

  • Field Details

    • serialVersionUID

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

    • backInput

      private JTextField backInput
      DOCUMENT ME!

    • blueValue

      private double blueValue
      DOCUMENT ME!

    • bottomInput

      private JTextField bottomInput
      DOCUMENT ME!

    • colorFactor

      private int colorFactor
      DOCUMENT ME!

    • defaultBlueInput

      private JTextField defaultBlueInput
      DOCUMENT ME!

    • defaultGreenInput

      private JTextField defaultGreenInput
      DOCUMENT ME!

    • defaultRedInput

      private JTextField defaultRedInput
      DOCUMENT ME!

    • defaultRealInput

      private JTextField defaultRealInput

    • defaultImaginaryInput

      private JTextField defaultImaginaryInput

    • defaultValue

      private double defaultValue
      DOCUMENT ME!

    • defaultValueInput

      private JTextField defaultValueInput
      DOCUMENT ME!

    • destinationGroup

      private ButtonGroup destinationGroup
      DOCUMENT ME!

    • displayLoc

      private int displayLoc
      DOCUMENT ME!

    • frontInput

      private JTextField frontInput
      DOCUMENT ME!

    • greenValue

      private double greenValue
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • imageMarginsAlgo

      private AlgorithmAddMargins imageMarginsAlgo
      DOCUMENT ME!

    • leftSideInput

      private JTextField leftSideInput
      DOCUMENT ME!

    • newImage

      private JRadioButton newImage
      DOCUMENT ME!

    • redValue

      private double redValue
      DOCUMENT ME!

    • replaceImage

      private JRadioButton replaceImage
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • rightSideInput

      private JTextField rightSideInput
      DOCUMENT ME!

    • topInput

      private JTextField topInput
      DOCUMENT ME!

    • realValue

      private double realValue

    • imaginaryValue

      private double imaginaryValue

    • marginX

      private int[] marginX
      DOCUMENT ME!

    • marginY

      private int[] marginY

    • marginZ

      private int[] marginZ

  • Constructor Details

    • JDialogAddMargins

      public JDialogAddMargins()
      Empty constructor needed for dynamic instantiation (used during scripting).

    • JDialogAddMargins

      public JDialogAddMargins(Frame theParentFrame, ModelImage im)
      Constructor that makes dialog and displays it.
      Parameters:
      theParentFrame - Parent frame.
      im - Source image.

  • Method Details

    • actionPerformed

      public void actionPerformed(ActionEvent event)
      Closes dialog box when the OK button is pressed and calls the algorithm.
      Specified by:
      actionPerformed in interface ActionListener
      Overrides:
      actionPerformed in class JDialogBase
      Parameters:
      event - Event that triggers function.

    • algorithmPerformed

      public void algorithmPerformed(AlgorithmBase algorithm)
      This method is required if the AlgorithmPerformed interface is implemented. It is called by the algorithms when it has completed or failed to to complete, so that the dialog can be display the result image and/or clean up.
      Specified by:
      algorithmPerformed in interface AlgorithmInterface
      Parameters:
      algorithm - Algorithm that caused the event.

    • getResultImage

      public ModelImage getResultImage()
      Accessor that returns the image after adding image margins.
      Returns:
      The result image.

    • setBlue

      public void setBlue(double x)
      Accessor that sets the blue value.
      Parameters:
      x - Value to set blue value to.

    • setDefault

      public void setDefault(double x)
      Accessor that sets the default value.
      Parameters:
      x - Value to set default value to.

    • setDisplayLocNew

      public void setDisplayLocNew()
      Accessor that sets the display loc variable to new, so that a new image is created once the algorithm completes.

    • setDisplayLocReplace

      public void setDisplayLocReplace()
      Accessor that sets the display loc variable to replace, so the current image is replaced once the algorithm completes.

    • setGreen

      public void setGreen(double x)
      Accessor that sets the green value.
      Parameters:
      x - Value to set green value to.

    • setRed

      public void setRed(double x)
      Accessor that sets the red value.
      Parameters:
      x - Value to set red value to.

    • callAlgorithm

      protected void callAlgorithm()
      Once all the necessary variables are set, call the Image Margins algorithm based on what type of image this is and whether or not there is a separate destination image.
      Specified by:
      callAlgorithm in class JDialogScriptableBase

    • determineNull

      protected JTextField determineNull()
      When one of the text inputs has been left blank, trying to convert them to ints results in throwing a null pointer exception. This method determines which one of the JTextFields threw the null pointer Exception.
      Returns:
      The text field that returned null.

    • doPostAlgorithmActions

      protected void doPostAlgorithmActions()
      Used to perform actions after the execution of the algorithm is completed (e.g., put the result image in the image table). Defaults to no action, override to actually have it do something.
      Overrides:
      doPostAlgorithmActions in class JDialogScriptableBase

    • setGUIFromParams

      protected void setGUIFromParams()
      Set the dialog GUI using the script parameters while running this algorithm as part of a script.
      Specified by:
      setGUIFromParams in class JDialogScriptableBase

    • storeParamsFromGUI

      protected void storeParamsFromGUI() throws ParserException
      Record the parameters just used to run this algorithm in a script.
      Specified by:
      storeParamsFromGUI in class JDialogScriptableBase
      Throws:
      ParserException - If there is a problem creating/recording the new parameters.

    • init

      private void init()
      Initializes the GUI components and places them in the dialog.

    • setVariables

      private boolean setVariables()
      Use the GUI results to set up the variables needed to run the algorithm.
      Returns:
      true if parameters set successfully, false otherwise.