CommonTools (IQM 3.5 API)

java.lang.Object
- at.mug.iqm.commons.util.CommonTools

```
public final class CommonTools
extends Object
```
This class provides tools for common usage.

Author:

Philipp Kainz

Field Summary

Fields
Modifier and Type	Field and Description
`private static org.apache.log4j.Logger`	`logger` Custom class logger.
`private static int`	`toolTipDismissDelay` The dismiss delay for the ToolTipManager.
`private static int`	`toolTipInitDelay` The initial delay for the ToolTipManager.
`private static int`	`toolTipReshowDelay` The re-show delay for the `ToolTipManager`.

Constructor Summary

Constructors
Constructor and Description

CommonTools()

Constructors
Constructor and Description
`CommonTools()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`arrayToString(Object[] array)` Aligns all elements of an `Object` array in a single one-line `String`.
`static double[]`	`calcAngleAndLegLenghts(AngleROI s)` This method calculates the angle value of a given shape object.
`static double`	`calcLength(Vector<Float> coords)` This method prints the length value of a line
`static void`	`centerFrameOnScreen(Window w)` Centers a specified `Window` on the screen.
`static boolean`	`checkModifiers(int modifiers, int mask)` Checks the modifier for a given mask.
`static BufferedImage`	`createSnapshot(Component component)` Creates a buffered image of a given `Component`'s graphics.
`static void`	`disableMainFrameInteraction()` Starts a wait cursor on the the `IMainFrame`.
`static void`	`disableUserInteraction(JFrame window)` Starts a wait cursor on the specified `JFrame`.
`static String`	`doubleArrayToString(double[] array)` Aligns all elements of a double array in a single one-line `String` .
`static void`	`enableMainFrameInteraction()` Stops the wait cursor and re-enables the user interaction on the `IMainFrame`.
`static void`	`enableUserInteraction(JFrame window)` Stops the wait cursor and re-enables the user interaction on a given `JFrame`.
`static int`	`getDefaultToolTipDismissDelay()` This method gets the default toolTipDismissDelay It is called e.g after jFreeChart
`static int`	`getDefaultToolTipInitDelay()` This method gets the default toolTipInitDelay It is called e.g after jFreeChart
`static int`	`getDefaultToolTipReshowDelay()` This method gets the default toolTipReshowDelay It is called e.g after jFreeChart
`static Point`	`getRealPixelPosition(Point2D p, double zoom)` This method calculates the real image pixel position.
`static Point`	`getRealPixelPosition(Point p, double zoom)` This method calculates the real image pixel position.
`static Vector<Float>`	`getShapeCoordinates(javax.media.jai.ROIShape roiShape)` This method gets the Polygon (shape) coordinates.
`static String`	`intArrayToString(int[] array)` Aligns all elements of the integer array in a single one-line `String`.
`static void`	`setDefaultToolTipDelays()` This method sets the default toolTipDelays It is called at startup
`static void`	`setTabForDataType(DataType dataType)` This method sets the tab index in the main frame according to the given data type.
`static File`	`showFileDialog(int dialogType)` Show a dialog in order to locate a single file.
`static File`	`showFileDialog(int dialogType, String filename)` Show a dialog in order to locate a single file, optionally stating the file name.
`static void`	`showImage(BufferedImage image, String title)` Displays the `BufferedImage` in a separate `JFrame`.
`static void`	`showImage(ImageIcon image, String title)` Displays the `ImageIcon` in a separate `JFrame`.
`static void`	`showImage(Image image, String title)` Displays the `Image` in a separate `JFrame`.
`static javax.media.jai.PlanarImage`	`zoomImage(javax.media.jai.PlanarImage pi, double zoom)` This method zooms an image.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
private static final org.apache.log4j.Logger logger
```
    Custom class logger.
  - toolTipReshowDelay
```
private static int toolTipReshowDelay
```
    The re-show delay for the ToolTipManager. Default is '0'.
  - toolTipDismissDelay
```
private static int toolTipDismissDelay
```
    The dismiss delay for the ToolTipManager. Default is '0'.
  - toolTipInitDelay
```
private static int toolTipInitDelay
```
    The initial delay for the ToolTipManager. Default is '0'.
- Constructor Detail
  - CommonTools
```
public CommonTools()
```
- Method Detail
  - setDefaultToolTipDelays
```
public static void setDefaultToolTipDelays()
```
    This method sets the default toolTipDelays It is called at startup
  - getDefaultToolTipInitDelay
```
public static int getDefaultToolTipInitDelay()
```
    This method gets the default toolTipInitDelay It is called e.g after jFreeChart
    
    Returns:
    
    int toolTipInitDelay
  - getDefaultToolTipReshowDelay
```
public static int getDefaultToolTipReshowDelay()
```
    This method gets the default toolTipReshowDelay It is called e.g after jFreeChart
    
    Returns:
    
    int toolTipReshowDelay
  - getDefaultToolTipDismissDelay
```
public static int getDefaultToolTipDismissDelay()
```
    This method gets the default toolTipDismissDelay It is called e.g after jFreeChart
    
    Returns:
    
    int toolTipDismissDelay
  - centerFrameOnScreen
```
public static void centerFrameOnScreen(Window w)
```
    Centers a specified Window on the screen.
  - showImage
```
public static void showImage(BufferedImage image,
                             String title)
```
    Displays the BufferedImage in a separate JFrame.
    
    Parameters:
    
    image -
  - showImage
```
public static void showImage(ImageIcon image,
                             String title)
```
    Displays the ImageIcon in a separate JFrame.
    
    Parameters:
    
    image -
  - showImage
```
public static void showImage(Image image,
                             String title)
```
    Displays the Image in a separate JFrame.
    
    Parameters:
    
    image -
  - createSnapshot
```
public static BufferedImage createSnapshot(Component component)
```
    Creates a buffered image of a given Component's graphics.
    
    Parameters:
    
    component - the component to be rendered
    
    Returns:
    
    a BufferedImage of type BufferedImage.TYPE_INT_RGB.
  - disableUserInteraction
```
public static void disableUserInteraction(JFrame window)
```
    Starts a wait cursor on the specified JFrame.
    
    Parameters:
    
    window - the frame to be locked
  - enableUserInteraction
```
public static void enableUserInteraction(JFrame window)
```
    Stops the wait cursor and re-enables the user interaction on a given JFrame.
    
    Parameters:
    
    window - the frame to be unlocked
  - disableMainFrameInteraction
```
public static void disableMainFrameInteraction()
```
    Starts a wait cursor on the the IMainFrame.
  - enableMainFrameInteraction
```
public static void enableMainFrameInteraction()
```
    Stops the wait cursor and re-enables the user interaction on the IMainFrame.
  - intArrayToString
```
public static String intArrayToString(int[] array)
```
    Aligns all elements of the integer array in a single one-line String.
    
    Parameters:
    
    array -
    
    Returns:
    
    a String
  - doubleArrayToString
```
public static String doubleArrayToString(double[] array)
```
    Aligns all elements of a double array in a single one-line String .
    
    Parameters:
    
    array -
    
    Returns:
    
    a String
  - arrayToString
```
public static String arrayToString(Object[] array)
```
    Aligns all elements of an Object array in a single one-line String. The standard Object.toString() method is applied to each element.
    
    Parameters:
    
    array -
    
    Returns:
    
    a String
  - checkModifiers
```
public static boolean checkModifiers(int modifiers,
                                     int mask)
```
    Checks the modifier for a given mask.
    
    Parameters:
    
    modifiers -
    
    mask -
    
    Returns:
    
    true if the modifier matches, false otherwise
  - zoomImage
```
public static javax.media.jai.PlanarImage zoomImage(javax.media.jai.PlanarImage pi,
                                                    double zoom)
```
    This method zooms an image.
    
    Parameters:
    
    pi - - the source image
    
    Returns:
    
    the zoomed image
  - getRealPixelPosition
```
public static Point getRealPixelPosition(Point p,
                                         double zoom)
```
    This method calculates the real image pixel position.
    
    Parameters:
    
    p - pixel position of device
    
    zoom - the zoom value in double precision
    
    Returns:
    
    the image pixel position
  - getRealPixelPosition
```
public static Point getRealPixelPosition(Point2D p,
                                         double zoom)
```
    This method calculates the real image pixel position.
    
    Parameters:
    
    p - pixel position of device
    
    zoom - the zoom value in double precision
    
    Returns:
    
    the image pixel position
  - calcLength
```
public static double calcLength(Vector<Float> coords)
```
    This method prints the length value of a line
    
    Parameters:
    
    coords -
    
    Returns:
    
    a double precision length
  - calcAngleAndLegLenghts
```
public static double[] calcAngleAndLegLenghts(AngleROI s)
```
    This method calculates the angle value of a given shape object.
    
    Parameters:
    
    s - a shape object, e.g. AngleROI
    
    Returns:
    
    a double[], containing the small angle on index 0, the large angle on index 1, the first leg length on index 2, and the second leg length on index 3
  - getShapeCoordinates
```
public static Vector<Float> getShapeCoordinates(javax.media.jai.ROIShape roiShape)
```
    This method gets the Polygon (shape) coordinates.
    
    Returns:
    
    vector of ROIShape
  - setTabForDataType
```
public static void setTabForDataType(DataType dataType)
```
    This method sets the tab index in the main frame according to the given data type.
    
    Parameters:
    
    dataType - the DataType
  - showFileDialog
```
public static File showFileDialog(int dialogType)
```
    Show a dialog in order to locate a single file.
    
    Parameters:
    
    dialogType - JFileChooser.SAVE_DIALOG, or JFileChooser.OPEN_DIALOG
    
    Returns:
  - showFileDialog
```
public static File showFileDialog(int dialogType,
                                  String filename)
```
    Show a dialog in order to locate a single file, optionally stating the file name.
    
    Parameters:
    
    dialogType - JFileChooser.SAVE_DIALOG, or JFileChooser.OPEN_DIALOG
    
    filename - the file name to be set to the dialog
    
    Returns:

Class CommonTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

toolTipReshowDelay

toolTipDismissDelay

toolTipInitDelay

Constructor Detail

CommonTools

Method Detail

setDefaultToolTipDelays

getDefaultToolTipInitDelay

getDefaultToolTipReshowDelay

getDefaultToolTipDismissDelay

centerFrameOnScreen

showImage

showImage

showImage

createSnapshot

disableUserInteraction

enableUserInteraction

disableMainFrameInteraction

enableMainFrameInteraction

intArrayToString

doubleArrayToString

arrayToString

checkModifiers

zoomImage

getRealPixelPosition

getRealPixelPosition

calcLength

calcAngleAndLegLenghts

getShapeCoordinates

setTabForDataType

showFileDialog

showFileDialog