Package gov.nih.mipav.view.dialogs
Class JDialogCropPointParam
- 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.JDialogCropPointParam
 
 
 
 
 
 
 
 
- 
- All Implemented Interfaces:
- AlgorithmInterface,- ScriptableActionInterface,- DialogDefaultsInterface,- ActionDiscovery,- java.awt.event.ActionListener,- java.awt.event.FocusListener,- java.awt.event.ItemListener,- java.awt.event.WindowListener,- java.awt.image.ImageObserver,- java.awt.MenuContainer,- java.io.Serializable,- java.util.EventListener,- javax.accessibility.Accessible,- javax.swing.RootPaneContainer,- javax.swing.WindowConstants
 
 public class JDialogCropPointParam extends JDialogScriptableBase implements AlgorithmInterface, ScriptableActionInterface, ActionDiscovery Creates the dialog to crop pixels around the selected point.User selects: - Point around which pixels are retained
- Pixels retained on each side
- Pixels retained on top and bottom
- Slices retained at the front and back
 A new image or replacement of the old image may be selected. - See Also:
- Serialized Form
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class gov.nih.mipav.view.dialogs.JDialogBaseJDialogBase.CancelAction, JDialogBase.HelpAction, JDialogBase.OKAction
 - 
Nested classes/interfaces inherited from class javax.swing.JDialogjavax.swing.JDialog.AccessibleJDialog
 - 
Nested classes/interfaces inherited from class java.awt.Dialogjava.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
 - 
Nested classes/interfaces inherited from class java.awt.Windowjava.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
 
- 
 - 
Field SummaryFields Modifier and Type Field Description private intbackDOCUMENT ME!private javax.swing.JTextFieldbackInputDOCUMENT ME!private javax.swing.JTextFieldbottomInputDOCUMENT ME!private intbottomSideDOCUMENT ME!private AlgorithmAddMarginscropAlgoDOCUMENT ME!private javax.swing.ButtonGroupdestinationGroupDOCUMENT ME!private intdisplayLocDOCUMENT ME!private intfrontDOCUMENT ME!private javax.swing.JTextFieldfrontInputDOCUMENT ME!private ModelImageimageDOCUMENT ME!private intleftSideDOCUMENT ME!private javax.swing.JTextFieldleftSideInputDOCUMENT ME!private javax.swing.JRadioButtonnewImageDOCUMENT ME!private javax.swing.JRadioButtonreplaceImageDOCUMENT ME!private ModelImageresultImageDOCUMENT ME!private intrightSideDOCUMENT ME!private javax.swing.JTextFieldrightSideInputDOCUMENT ME!private java.lang.String[]titlesDOCUMENT ME!private javax.swing.JTextFieldtopInputDOCUMENT ME!private inttopSideDOCUMENT ME!private ViewUserInterfaceuserInterfaceDOCUMENT ME!private int[]xBoundsDOCUMENT ME!private intxPointprivate javax.swing.JTextFieldxPointInputprivate int[]yBoundsDOCUMENT ME!private intyPointprivate javax.swing.JTextFieldyPointInputprivate int[]zBoundsDOCUMENT ME!private intzPointprivate javax.swing.JTextFieldzPointInput- 
Fields inherited from class gov.nih.mipav.view.dialogs.JDialogScriptableBasedisplayInNewFrame, isComplete, scriptParameters
 - 
Fields inherited from class gov.nih.mipav.view.dialogs.JDialogBaseapplyButton, bar, cancelButton, cancelFlag, closeButton, HELP, helpButton, mainDialogPanel, NEW, OKButton, parentFrame, progressBar, REPLACE, runInSeparateThread, runningScriptFlag, runQuiet, serif12, serif12B, voiManager
 - 
Fields inherited from class javax.swing.JDialogaccessibleContext, rootPane, rootPaneCheckingEnabled
 - 
Fields inherited from class java.awt.ComponentBOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
- 
 - 
Constructor SummaryConstructors Constructor Description JDialogCropPointParam()Empty constructor needed for dynamic instantiation (used during scripting).JDialogCropPointParam(java.awt.Frame theParentFrame, ModelImage im)Constructor that makes dialog and displays it.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidactionPerformed(java.awt.event.ActionEvent event)Closes dialog box when the OK button is pressed and calls the algorithm.voidalgorithmPerformed(AlgorithmBase algorithm)This method is required if the AlgorithmPerformed interface is implemented.protected voidcallAlgorithm()DOCUMENT ME!ParameterTablecreateInputParameters()Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used insetGUIFromParams()).ParameterTablecreateOutputParameters()Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).protected javax.swing.JTextFielddetermineNull()When one of the text inputs has been left blank, trying to convert them to ints results in throwing a null pointer exception.protected voiddoPostAlgorithmActions()Store the result image in the script runner's image table now that the action execution is finished.ActionMetadatagetActionMetadata()Return meta-information about this discoverable action for categorization and labeling purposes.java.lang.StringgetOutputImageName(java.lang.String imageParamName)Returns the name of an image output by this algorithm, the image returned depends on the parameter label given (which can be used to retrieve the image object from the image registry).ModelImagegetResultImage()Accessor that returns the image after adding image margins.private voidinit()Initializes the GUI components and places them in the dialog.booleanisActionComplete()Returns whether the action has successfully completed its execution.voidsetBack(int x)Accessor that sets the back value.voidsetBottom(int x)Accessor that sets the bottom side value.voidsetDisplayLocNew()Accessor that sets the display loc variable to new, so that a new image is created once the algorithm completes.voidsetDisplayLocReplace()Accessor that sets the display loc variable to replace, so the current image is replaced once the algorithm completes.voidsetFront(int x)Accessor that sets the front value.protected voidsetGUIFromParams()Set the dialog GUI using the script parameters while running this algorithm as part of a script.voidsetLeft(int x)Accessor that sets the left side value.voidsetRight(int x)Accessor that sets the right side value.voidsetTop(int x)Accessor that sets the top side value.private booleansetVariables()Use the GUI results to set up the variables needed to run the algorithm.voidsetXPoint(int xPoint)voidsetYPoint(int yPoint)voidsetZPoint(int zPoint)protected voidstoreParamsFromGUI()Record the parameters just used to run this algorithm in a script.- 
Methods inherited from class gov.nih.mipav.view.dialogs.JDialogScriptableBasegetDialogActionString, insertScriptLine, isComplete, scriptRun, setComplete
 - 
Methods inherited from class gov.nih.mipav.view.dialogs.JDialogBasebuildApplyButton, buildButtons, buildCancelButton, buildCancelButton, buildCloseButton, buildHelpButton, buildImageComboBox, buildOKButton, buildOKButton, buildOKCancelButtons, buildTitledBorder, buildTitledBorder, createLabel, createProgressBar, createProgressBar, createTextField, focusGained, focusLost, getDialogName, isCancelled, isQuietRunning, isRunInSeparateThread, isScriptRunning, itemStateChanged, loadDefaults, loadDefaults, makeImageName, makeString, openNewFrame, saveDefaults, saveDefaults, setLeftHandSystem, setQuietRunning, setScriptRunning, setSeparateThread, setVisible, setVisible, setVisibleMenuBar, setVisibleStandard, setVOIManager, setWCSystem, testParameter, testParameterMin, updateFFTFileInfo, updateFileInfo, updateFileInfoOtherModality, updateFileInfoStatic, updateFileInfoStatic, updateFileTypeInfo, updateFileTypeInfo, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened
 - 
Methods inherited from class javax.swing.JDialogaddImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 - 
Methods inherited from class java.awt.DialogaddNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack
 - 
Methods inherited from class java.awt.WindowaddPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
 - 
Methods inherited from class java.awt.Containeradd, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
 - 
Methods inherited from class java.awt.Componentaction, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface gov.nih.mipav.view.dialogs.ActionDiscoveryscriptRun
 - 
Methods inherited from interface gov.nih.mipav.model.scripting.ScriptableActionInterfaceinsertScriptLine, scriptRun
 
- 
 
- 
- 
- 
Field Detail- 
backprivate int back DOCUMENT ME!
 - 
backInputprivate javax.swing.JTextField backInput DOCUMENT ME!
 - 
bottomInputprivate javax.swing.JTextField bottomInput DOCUMENT ME!
 - 
bottomSideprivate int bottomSide DOCUMENT ME!
 - 
cropAlgoprivate AlgorithmAddMargins cropAlgo DOCUMENT ME!
 - 
destinationGroupprivate javax.swing.ButtonGroup destinationGroup DOCUMENT ME!
 - 
displayLocprivate int displayLoc DOCUMENT ME!
 - 
frontprivate int front DOCUMENT ME!
 - 
frontInputprivate javax.swing.JTextField frontInput DOCUMENT ME!
 - 
imageprivate ModelImage image DOCUMENT ME!
 - 
leftSideprivate int leftSide DOCUMENT ME!
 - 
leftSideInputprivate javax.swing.JTextField leftSideInput DOCUMENT ME!
 - 
newImageprivate javax.swing.JRadioButton newImage DOCUMENT ME!
 - 
replaceImageprivate javax.swing.JRadioButton replaceImage DOCUMENT ME!
 - 
resultImageprivate ModelImage resultImage DOCUMENT ME!
 - 
rightSideprivate int rightSide DOCUMENT ME!
 - 
rightSideInputprivate javax.swing.JTextField rightSideInput DOCUMENT ME!
 - 
xPointprivate int xPoint 
 - 
xPointInputprivate javax.swing.JTextField xPointInput 
 - 
yPointprivate int yPoint 
 - 
yPointInputprivate javax.swing.JTextField yPointInput 
 - 
zPointprivate int zPoint 
 - 
zPointInputprivate javax.swing.JTextField zPointInput 
 - 
titlesprivate java.lang.String[] titles DOCUMENT ME!
 - 
topInputprivate javax.swing.JTextField topInput DOCUMENT ME!
 - 
topSideprivate int topSide DOCUMENT ME!
 - 
userInterfaceprivate ViewUserInterface userInterface DOCUMENT ME!
 - 
xBoundsprivate int[] xBounds DOCUMENT ME!
 - 
yBoundsprivate int[] yBounds DOCUMENT ME!
 - 
zBoundsprivate int[] zBounds DOCUMENT ME!
 
- 
 - 
Constructor Detail- 
JDialogCropPointParampublic JDialogCropPointParam() Empty constructor needed for dynamic instantiation (used during scripting).
 - 
JDialogCropPointParampublic JDialogCropPointParam(java.awt.Frame theParentFrame, ModelImage im)Constructor that makes dialog and displays it.- Parameters:
- theParentFrame- Parent frame.
- im- Source image.
 
 
- 
 - 
Method Detail- 
actionPerformedpublic void actionPerformed(java.awt.event.ActionEvent event) Closes dialog box when the OK button is pressed and calls the algorithm.- Specified by:
- actionPerformedin interface- java.awt.event.ActionListener
- Overrides:
- actionPerformedin class- JDialogBase
- Parameters:
- event- Event that triggers function.
 
 - 
algorithmPerformedpublic 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:
- algorithmPerformedin interface- AlgorithmInterface
- Parameters:
- algorithm- Algorithm that caused the event.
 
 - 
getResultImagepublic ModelImage getResultImage() Accessor that returns the image after adding image margins.- Returns:
- The result image.
 
 - 
setBackpublic void setBack(int x) Accessor that sets the back value.- Parameters:
- x- Value to set back value to.
 
 - 
setBottompublic void setBottom(int x) Accessor that sets the bottom side value.- Parameters:
- x- Value to set bottom side value to.
 
 - 
setDisplayLocNewpublic void setDisplayLocNew() Accessor that sets the display loc variable to new, so that a new image is created once the algorithm completes.
 - 
setDisplayLocReplacepublic void setDisplayLocReplace() Accessor that sets the display loc variable to replace, so the current image is replaced once the algorithm completes.
 - 
setFrontpublic void setFront(int x) Accessor that sets the front value.- Parameters:
- x- Value to set front value to.
 
 - 
setLeftpublic void setLeft(int x) Accessor that sets the left side value.- Parameters:
- x- Value to set left side value to.
 
 - 
setRightpublic void setRight(int x) Accessor that sets the right side value.- Parameters:
- x- Value to set right side value to.
 
 - 
setToppublic void setTop(int x) Accessor that sets the top side value.- Parameters:
- x- Value to set top side value to.
 
 - 
setXPointpublic void setXPoint(int xPoint) - Parameters:
- xPoint-
 
 - 
setYPointpublic void setYPoint(int yPoint) - Parameters:
- yPoint-
 
 - 
setZPointpublic void setZPoint(int zPoint) - Parameters:
- zPoint-
 
 - 
callAlgorithmprotected void callAlgorithm() DOCUMENT ME!- Specified by:
- callAlgorithmin class- JDialogScriptableBase
 
 - 
determineNullprotected javax.swing.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.
 
 - 
doPostAlgorithmActionsprotected void doPostAlgorithmActions() Store the result image in the script runner's image table now that the action execution is finished.- Overrides:
- doPostAlgorithmActionsin class- JDialogScriptableBase
 
 - 
setGUIFromParamsprotected void setGUIFromParams() Set the dialog GUI using the script parameters while running this algorithm as part of a script.- Specified by:
- setGUIFromParamsin class- JDialogScriptableBase
 
 - 
storeParamsFromGUIprotected void storeParamsFromGUI() throws ParserExceptionRecord the parameters just used to run this algorithm in a script.- Specified by:
- storeParamsFromGUIin class- JDialogScriptableBase
- Throws:
- ParserException- If there is a problem creating/recording the new parameters.
 
 - 
initprivate void init() Initializes the GUI components and places them in the dialog.
 - 
setVariablesprivate boolean setVariables() Use the GUI results to set up the variables needed to run the algorithm.- Returns:
- trueif parameters set successfully,- falseotherwise.
 
 - 
getActionMetadatapublic ActionMetadata getActionMetadata() Return meta-information about this discoverable action for categorization and labeling purposes.- Specified by:
- getActionMetadatain interface- ActionDiscovery
- Returns:
- Metadata for this action.
 
 - 
createInputParameterspublic ParameterTable createInputParameters() Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used insetGUIFromParams()).- Specified by:
- createInputParametersin interface- ActionDiscovery
- Returns:
- A parameter table listing the inputs of this algorithm.
 
 - 
createOutputParameterspublic ParameterTable createOutputParameters() Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).- Specified by:
- createOutputParametersin interface- ActionDiscovery
- Returns:
- A parameter table listing the outputs of this algorithm.
 
 - 
getOutputImageNamepublic java.lang.String getOutputImageName(java.lang.String imageParamName) Returns the name of an image output by this algorithm, the image returned depends on the parameter label given (which can be used to retrieve the image object from the image registry).- Specified by:
- getOutputImageNamein interface- ActionDiscovery
- Parameters:
- imageParamName- The output image parameter label for which to get the image name.
- Returns:
- The image name of the requested output image parameter label.
 
 - 
isActionCompletepublic boolean isActionComplete() Returns whether the action has successfully completed its execution.- Specified by:
- isActionCompletein interface- ActionDiscovery
- Returns:
- True, if the action is complete. False, if the action failed or is still running.
 
 
- 
 
-