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

Class ParameterImage

java.lang.Object

gov.nih.mipav.model.scripting.parameters.Parameter

gov.nih.mipav.model.scripting.parameters.ParameterString

gov.nih.mipav.model.scripting.parameters.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.

Field Summary

Fields inherited from class gov.nih.mipav.model.scripting.parameters.ParameterString

value

Fields inherited from class gov.nih.mipav.model.scripting.parameters.Parameter

PARAM_BOOLEAN, PARAM_DOUBLE, PARAM_EXTERNAL_IMAGE, PARAM_FILE, PARAM_FLOAT, PARAM_IMAGE, PARAM_INT, PARAM_LIST, PARAM_LONG, PARAM_SHORT, PARAM_STRING, PARAM_USHORT

Constructor Summary

Constructors

Constructor	Description
ParameterImage(java.lang.String paramLabel)	Creates a new ParameterImage object.
ParameterImage(java.lang.String paramLabel, int paramType)	Creates a new ParameterImage object.
ParameterImage(java.lang.String paramLabel, int paramType, java.lang.String paramValueString)	Creates a new ParameterImage object.
ParameterImage(java.lang.String paramLabel, java.lang.String paramTypeString, java.lang.String paramValueString)	Creates a new ParameterImage object.

Method Summary

Modifier and Type	Method	Description
ViewJFrameImage	getFrame()	Return the frame containing the image that this image placeholder refers to.
ModelImage	getImage()	Return the image that this image placeholder refers to.
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).

Methods inherited from class gov.nih.mipav.model.scripting.parameters.ParameterString

getValue, getValueString, setValue

Methods inherited from class gov.nih.mipav.model.scripting.parameters.Parameter

convertToString, getLabel, getParent, getParentConditionValueString, getType, getTypeFromString, getTypeString, getTypeString, isOptional, isParentConditionValueMet, isValueAssigned, setOptional, setParent, setParentCondition, setParentConditionValue, setValueAssigned

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.