Package gov.nih.mipav.model.scripting.parameters

Class ParameterImage

  • Direct Known Subclasses:
    ParameterExternalImage
    public class ParameterImage
extends ParameterString
    A image placeholder variable parameter used in either the recording or execution of a script action.

    • Constructor Detail

      • ParameterImage

        public ParameterImage​(java.lang.String paramLabel)
               throws ParserException
        Creates a new ParameterImage object.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        Throws:
        ParserException - If there is a problem creating the parameter.

      • ParameterImage

        public ParameterImage​(java.lang.String paramLabel,
                      int paramType)
               throws ParserException
        Creates a new ParameterImage object.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        paramType - The type of this parameter (should be PARAM_IMAGE).
        Throws:
        ParserException - If there is a problem creating the parameter.

      • ParameterImage

        public ParameterImage​(java.lang.String paramLabel,
                      java.lang.String paramTypeString,
                      java.lang.String paramValueString)
               throws ParserException
        Creates a new ParameterImage object.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        paramTypeString - The type of this parameter, in string form.
        paramValueString - The new parameter value.
        Throws:
        ParserException - If there is a problem creating the parameter.

      • ParameterImage

        public ParameterImage​(java.lang.String paramLabel,
                      int paramType,
                      java.lang.String paramValueString)
               throws ParserException
        Creates a new ParameterImage object.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        paramType - The type of this parameter (should be PARAM_IMAGE).
        paramValueString - The new parameter value.
        Throws:
        ParserException - If there is a problem creating the parameter.

    • Method Detail

      • getFrame

        public ViewJFrameImage getFrame()
        Return the frame containing the image that this image placeholder refers to.
        Returns:
        The frame containing the image assigned to this image placeholder variable.

      • getImage

        public ModelImage getImage()
        Return the image that this image placeholder refers to.
        Returns:
        The image assigned to this image placeholder variable.

      • isSameImageAs

        public boolean isSameImageAs​(ParameterImage secondImageParam)
        Checks to see if this image placeholder variable is the same as another image placeholder (e.g., '$image1' == '$image1'; does not check image name).
        Parameters:
        secondImageParam - Another image variable parameter.
        Returns:
        True if the parameters have the same image placeholder, false otherwise.