Static2DTools (cismet Commons [9.2-SNAPSHOT] 9.2-SNAPSHOT API)

java.lang.Object
- de.cismet.tools.Static2DTools

```
public class Static2DTools
extends Object
```
DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

thorsten.hell@cismet.de

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOTTOM`
`static int`	`CENTER`
`static int`	`HORIZONTAL`
`static int`	`LEFT`
`static int`	`RIGHT`
`static int`	`TOP`
`static int`	`VERTICAL`

Constructor Summary

Constructors
Constructor and Description

Static2DTools()

Constructors
Constructor and Description
`Static2DTools()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static BufferedImage`	`appendImage(Image base, Image append)` Appends the second image to the first image.
`static Icon`	`borderIcon(Icon icon, int left, int right, int top, int bottom)` DOCUMENT ME!
`static ImageIcon`	`createOverlayIcon(ImageIcon overlayIcon, int width, int heigth)` DOCUMENT ME!
`static Color`	`getAlphaColor(Color c, int alpha)` DOCUMENT ME!
`static BufferedImage`	`getFasterScaledInstance(BufferedImage img, int targetWidth, int targetHeight, Object hint, boolean progressiveBilinear)` Convenience method that returns a scaled instance of the provided BufferedImage.
`static Color`	`getOffsetAlphaColor(Color c, Color offset, int alpha)` DOCUMENT ME!
`static Color`	`getOffsetAlphaColor(Color c, int offset, int alpha)` DOCUMENT ME!
`static boolean`	`hasAlpha(Image image)` This method returns true if the specified image has transparent pixels.
`static Icon`	`joinIcons(Icon[] icons, int gap, int orientation, int alignment)` DOCUMENT ME!
`static Icon`	`mergeIcons(Icon base, Icon overlay)` DOCUMENT ME!
`static Image`	`removeUnusedBorder(Image i, int borderPixelsAfterwards, double scalingFactor)` DOCUMENT ME!
`static BufferedImage`	`rotate(BufferedImage image, double angle, boolean radian, Color backgroundColor)` Rotates the given `BufferedImage` in the given angle around the icon's center point.
`static ImageIcon`	`rotate(ImageIcon icon, double angle, boolean radian)` Rotates the given `ImageIcon` in the given angle around the icon's center point.
`static Image`	`scaleImage(Image i, double scalingFactor)` DOCUMENT ME!
`static BufferedImage`	`toBufferedImage(Image image)` Creates a `BufferedImage` from the given `Image`.
`static BufferedImage`	`toCompatibleImage(Image image)` DOCUMENT ME!

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

- Field Detail
  - HORIZONTAL
```
public static int HORIZONTAL
```
  - VERTICAL
```
public static int VERTICAL
```
  - LEFT
```
public static int LEFT
```
  - RIGHT
```
public static int RIGHT
```
  - TOP
```
public static int TOP
```
  - BOTTOM
```
public static int BOTTOM
```
  - CENTER
```
public static int CENTER
```
- Constructor Detail
  - Static2DTools
```
public Static2DTools()
```
- Method Detail
  - joinIcons
```
public static Icon joinIcons(Icon[] icons,
                             int gap,
                             int orientation,
                             int alignment)
```
    DOCUMENT ME!
    
    Parameters:
    
    icons - DOCUMENT ME!
    
    gap - DOCUMENT ME!
    
    orientation - DOCUMENT ME!
    
    alignment - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
    
    Throws:
    
    IllegalArgumentException - DOCUMENT ME!
  - createOverlayIcon
```
public static ImageIcon createOverlayIcon(ImageIcon overlayIcon,
                                          int width,
                                          int heigth)
```
    DOCUMENT ME!
    
    Parameters:
    
    overlayIcon - DOCUMENT ME!
    
    width - DOCUMENT ME!
    
    heigth - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - mergeIcons
```
public static Icon mergeIcons(Icon base,
                              Icon overlay)
```
    DOCUMENT ME!
    
    Parameters:
    
    base - DOCUMENT ME!
    
    overlay - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - toBufferedImage
```
public static BufferedImage toBufferedImage(Image image)
```
    Creates a BufferedImage from the given Image.
    
    Parameters:
    
    image - the Image to be turned into
    
    Returns:
    
    a BufferedImage that is identical to the given Image
  - hasAlpha
```
public static boolean hasAlpha(Image image)
```
    This method returns true if the specified image has transparent pixels.
    
    Parameters:
    
    image - the image to test for alpha values
    
    Returns:
    
    true if the image has alpha, false otherwise
  - rotate
```
public static ImageIcon rotate(ImageIcon icon,
                               double angle,
                               boolean radian)
```
    Rotates the given ImageIcon in the given angle around the icon's center point. Rotation is clock-wise if the given angle is positive or counter clock-wise if the given angle is negative. There is no necessity to stick to the bounds described for the angle parameter but there is no sense to rotate in an angle of e.g 765 degrees because in this case a rotation in an angle of 45 degrees is more senseful. However, this method will accept any double values as an angle. Special double values such as Double.NaN Double.NEGATIVE_INFINITY and Double.POSITIVE_INFINITY will be handle as if angle is 0.
    
    Parameters:
    
    icon - the ImageIcon to rotate
    
    angle - the rotation angle, presumably a value between 0 and +/-PI if angle is in radian measure or 0 and +/-180 degrees.
    
    radian - determines whether the given angle will be handles as an radian measure or not
    
    Returns:
    
    the rotated ImageIcon
    
    Throws:
    
    IllegalArgumentException - if the given icon is null
  - rotate
```
public static BufferedImage rotate(BufferedImage image,
                                   double angle,
                                   boolean radian,
                                   Color backgroundColor)
```
    Rotates the given BufferedImage in the given angle around the icon's center point. Rotation is clock-wise if the given angle is positive or counter clock-wise if the given angle is negative. There is no necessity to stick to the bounds described for the angle parameter but there is no sense to rotate in an angle of e.g 765 degrees because in this case a rotation in an angle of 45 degrees is more senseful. However, this method will accept any double values as an angle. Special double values such as Double.NaN Double.NEGATIVE_INFINITY and Double.POSITIVE_INFINITY will be handle as if angle is 0.
    This method uses AffineTransform to rotate the image, but without using any AffineTransform.rotate() method. It's not that easy to specify the rotation center of the given image, because you have to use whether (image.getHeight() / 2, image.getHeight() / 2) or (image.getWidth() / 2, image.getWidth() / 2) depending on the angle. It's easier to simulate the steps necessary to rotate the image. See http://stackoverflow.com/questions/2257141/problems-rotating-bufferedimage for further information.
    
    Parameters:
    
    image - the BufferedImage to rotate
    
    angle - the rotation angle, presumably a value between 0 and +/-PI if angle is in radian measure or 0 and +/-180 degrees.
    
    radian - determines whether the given angle will be handles as an radian measure or not
    
    backgroundColor - the color to be used as background
    
    Returns:
    
    the rotated BufferedImage
    
    Throws:
    
    IllegalArgumentException - if the given image is null
  - borderIcon
```
public static Icon borderIcon(Icon icon,
                              int left,
                              int right,
                              int top,
                              int bottom)
```
    DOCUMENT ME!
    
    Parameters:
    
    icon - DOCUMENT ME!
    
    left - DOCUMENT ME!
    
    right - DOCUMENT ME!
    
    top - DOCUMENT ME!
    
    bottom - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - removeUnusedBorder
```
public static Image removeUnusedBorder(Image i,
                                       int borderPixelsAfterwards,
                                       double scalingFactor)
```
    DOCUMENT ME!
    
    Parameters:
    
    i - DOCUMENT ME!
    
    borderPixelsAfterwards - DOCUMENT ME!
    
    scalingFactor - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - scaleImage
```
public static Image scaleImage(Image i,
                               double scalingFactor)
```
    DOCUMENT ME!
    
    Parameters:
    
    i - DOCUMENT ME!
    
    scalingFactor - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - toCompatibleImage
```
public static BufferedImage toCompatibleImage(Image image)
```
    DOCUMENT ME!
    
    Parameters:
    
    image - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getAlphaColor
```
public static Color getAlphaColor(Color c,
                                  int alpha)
```
    DOCUMENT ME!
    
    Parameters:
    
    c - DOCUMENT ME!
    
    alpha - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getOffsetAlphaColor
```
public static Color getOffsetAlphaColor(Color c,
                                        int offset,
                                        int alpha)
```
    DOCUMENT ME!
    
    Parameters:
    
    c - DOCUMENT ME!
    
    offset - DOCUMENT ME!
    
    alpha - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getOffsetAlphaColor
```
public static Color getOffsetAlphaColor(Color c,
                                        Color offset,
                                        int alpha)
```
    DOCUMENT ME!
    
    Parameters:
    
    c - DOCUMENT ME!
    
    offset - DOCUMENT ME!
    
    alpha - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getFasterScaledInstance
```
public static BufferedImage getFasterScaledInstance(BufferedImage img,
                                                    int targetWidth,
                                                    int targetHeight,
                                                    Object hint,
                                                    boolean progressiveBilinear)
```
    Convenience method that returns a scaled instance of the provided BufferedImage.
    
    Parameters:
    
    img - the original image to be scaled
    
    targetWidth - the desired width of the scaled instance, in pixels
    
    targetHeight - the desired height of the scaled instance, in pixels
    
    hint - one of the rendering hints that corresponds to RenderingHints.KEY_INTERPOLATION (e.g. RenderingHints.VALUE_INTERPOLATION_NEAREST_NEIGHBOR, RenderingHints.VALUE_INTERPOLATION_BILINEAR, RenderingHints.VALUE_INTERPOLATION_BICUBIC)
    
    progressiveBilinear - if true, this method will use a multi-step scaling technique that provides higher quality than the usual one-step technique (only useful in down-scaling cases, where targetWidth or targetHeight is smaller than the original dimensions)
    
    Returns:
    
    a scaled version of the original BufferedImage
  - appendImage
```
public static BufferedImage appendImage(Image base,
                                        Image append)
```
    Appends the second image to the first image.
    
    Parameters:
    
    base - the base image
    
    append - the image that should be appended to the base
    
    Returns:
    
    the appended image

Class Static2DTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HORIZONTAL

VERTICAL

LEFT

RIGHT

TOP

BOTTOM

CENTER

Constructor Detail

Static2DTools

Method Detail

joinIcons

createOverlayIcon

mergeIcons

toBufferedImage

hasAlpha

rotate

rotate

borderIcon

removeUnusedBorder

scaleImage

toCompatibleImage

getAlphaColor

getOffsetAlphaColor

getOffsetAlphaColor

getFasterScaledInstance

appendImage