magick
Class ImageInfo

java.lang.Object
  extended by magick.Magick
      extended by magick.ImageInfo

public class ImageInfo
extends Magick

Corresponds to the ImageMagick ImageInfo structure.

Author:
Eric Yeo

Constructor Summary
ImageInfo()
          Constructor.
ImageInfo(java.lang.String fileName)
          Constructor.
 
Method Summary
protected  void finalize()
          To release memory on cleanup.
 int getAdjoin()
           
 boolean getAffirm()
          Get the affirm attribute.
 PixelPacket getBorderColor()
          Get the current border colour..
 int getColorspace()
           
 int getCompression()
           
 java.lang.String getDensity()
           
 int getDepth()
          Return the depth of the image.
 int getDither()
           
 java.lang.String getFileName()
          Return the file name attribute of the handle.
 java.lang.String getFont()
           
 int getInterlace()
           
 java.lang.String getMagick()
          Return the magick attribute of the handle.
 int getMonochrome()
           
 java.lang.String getPage()
           
 boolean getPing()
          Get the ping attribute.
 int getPointSize()
           
 int getPreviewType()
          Get the preview_type attribute.
 int getQuality()
           
 java.lang.String getServerName()
           
 java.lang.String getSize()
           
 int getSubimage()
           
 int getSubrange()
           
 java.lang.String getTexture()
           
 java.lang.String getTile()
           
 int getUnits()
          Get the units attribute of the ImageInfo.
 int getVerbose()
          Get the verbose attribute.
 java.lang.String getView()
           
 void init()
          Initialises the internal native handle.
 void setAdjoin(int value)
           
 void setAffirm(boolean affirm)
          Set the affirm attribute.
 void setBorderColor(PixelPacket color)
          Set the border colour..
 void setColorspace(int value)
           
 void setCompression(int value)
           
 void setDensity(java.lang.String density)
           
 void setDepth(int depth)
          Set the depth of the image.
 void setDither(int value)
           
 void setFileName(java.lang.String fileName)
          Set the file name attribute of the handle.
 void setFont(java.lang.String font)
           
 void setInterlace(int value)
           
 void setMagick(java.lang.String magick)
          Set the magick attribute of the handle.
 void setMonochrome(int value)
           
 void setPage(java.lang.String page)
           
 void setPing(boolean value)
          Set the ping attribute.
 void setPointSize(int value)
           
 void setPreviewType(int value)
          Set the preview_type attribute.
 void setQuality(int value)
           
 void setServerName(java.lang.String name)
           
 void setSize(java.lang.String size)
           
 void setSubimage(int value)
           
 void setSubrange(int value)
           
 void setTexture(java.lang.String texture)
           
 void setTile(java.lang.String tile)
           
 void setUnits(int resolutionType)
          Set the units attribute of the ImageInfo.
 void setVerbose(int value)
          Set the verbose attribute.
 void setView(java.lang.String view)
           
 
Methods inherited from class magick.Magick
parseImageGeometry
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageInfo

public ImageInfo()
          throws MagickException
Constructor.

Throws:
MagickException

ImageInfo

public ImageInfo(java.lang.String fileName)
          throws MagickException
Constructor.

Parameters:
fileName - initial value of the file_name attribute
Throws:
MagickException
Method Detail

finalize

protected void finalize()
To release memory on cleanup.

Overrides:
finalize in class java.lang.Object

init

public void init()
          throws MagickException
Initialises the internal native handle.

Throws:
MagickException

setFileName

public void setFileName(java.lang.String fileName)
                 throws MagickException
Set the file name attribute of the handle.

Parameters:
fileName - the new file name
Throws:
MagickException

getFileName

public java.lang.String getFileName()
                             throws MagickException
Return the file name attribute of the handle.

Throws:
MagickException

setAffirm

public void setAffirm(boolean affirm)
               throws MagickException
Set the affirm attribute.

Parameters:
affirm - new value of affirm
Throws:
MagickException

getAffirm

public boolean getAffirm()
                  throws MagickException
Get the affirm attribute.

Throws:
MagickException

setSubimage

public void setSubimage(int value)
                 throws MagickException
Throws:
MagickException

getSubimage

public int getSubimage()
                throws MagickException
Throws:
MagickException

setSubrange

public void setSubrange(int value)
                 throws MagickException
Throws:
MagickException

getSubrange

public int getSubrange()
                throws MagickException
Throws:
MagickException

setServerName

public void setServerName(java.lang.String name)
                   throws MagickException
Throws:
MagickException

getServerName

public java.lang.String getServerName()
                               throws MagickException
Throws:
MagickException

setFont

public void setFont(java.lang.String font)
             throws MagickException
Throws:
MagickException

getFont

public java.lang.String getFont()
                         throws MagickException
Throws:
MagickException

setSize

public void setSize(java.lang.String size)
             throws MagickException
Throws:
MagickException

getSize

public java.lang.String getSize()
                         throws MagickException
Throws:
MagickException

setTile

public void setTile(java.lang.String tile)
             throws MagickException
Throws:
MagickException

getTile

public java.lang.String getTile()
                         throws MagickException
Throws:
MagickException

setDensity

public void setDensity(java.lang.String density)
                throws MagickException
Throws:
MagickException

getDensity

public java.lang.String getDensity()
                            throws MagickException
Throws:
MagickException

setPage

public void setPage(java.lang.String page)
             throws MagickException
Throws:
MagickException

getPage

public java.lang.String getPage()
                         throws MagickException
Throws:
MagickException

setTexture

public void setTexture(java.lang.String texture)
                throws MagickException
Throws:
MagickException

getTexture

public java.lang.String getTexture()
                            throws MagickException
Throws:
MagickException

setView

public void setView(java.lang.String view)
             throws MagickException
Throws:
MagickException

getView

public java.lang.String getView()
                         throws MagickException
Throws:
MagickException

setAdjoin

public void setAdjoin(int value)
               throws MagickException
Throws:
MagickException

getAdjoin

public int getAdjoin()
              throws MagickException
Throws:
MagickException

setColorspace

public void setColorspace(int value)
                   throws MagickException
Throws:
MagickException

getColorspace

public int getColorspace()
                  throws MagickException
Throws:
MagickException

setCompression

public void setCompression(int value)
                    throws MagickException
Throws:
MagickException

getCompression

public int getCompression()
                   throws MagickException
Throws:
MagickException

setDither

public void setDither(int value)
               throws MagickException
Throws:
MagickException

getDither

public int getDither()
              throws MagickException
Throws:
MagickException

setInterlace

public void setInterlace(int value)
                  throws MagickException
Throws:
MagickException

getInterlace

public int getInterlace()
                 throws MagickException
Throws:
MagickException

setMonochrome

public void setMonochrome(int value)
                   throws MagickException
Throws:
MagickException

getMonochrome

public int getMonochrome()
                  throws MagickException
Throws:
MagickException

setPointSize

public void setPointSize(int value)
                  throws MagickException
Throws:
MagickException

getPointSize

public int getPointSize()
                 throws MagickException
Throws:
MagickException

setQuality

public void setQuality(int value)
                throws MagickException
Throws:
MagickException

getQuality

public int getQuality()
               throws MagickException
Throws:
MagickException

setVerbose

public void setVerbose(int value)
                throws MagickException
Set the verbose attribute. This makes writeImage print out information about the written image on standard output, like:
 TIFF Directory at offset 0x0
           Image Width: 102 Image Length: 68
           Resolution: 72, 72 pixels/inch
           Bits/Sample: 8
           Compression Scheme: None
           Photometric Interpretation: RGB color
           FillOrder: msb-to-lsb
           Document Name: "test/output/black_and_White_In_RGBRGB.tif"
           Orientation: row 0 top, col 0 lhs
           Samples/Pixel: 3
           Rows/Strip: 26
           Planar Configuration: single image plane
           ICC Profile: , 560 bytes
           Software: ImageMagick 6.2.6 10/06/06 Q8 http://www.imagemagick.org
 

Note: The verbose setting is primarily for use with the utility programs. it is equivalent to the -verbose option for ImageMagick command line tool. The delegates subsystem does observe verbose, which is why setting verbose to true causes some output when loading a PDF or PS file.

Throws:
MagickException
See Also:
MagickImage.writeImage(ImageInfo)

getVerbose

public int getVerbose()
               throws MagickException
Get the verbose attribute. @see #setVerbose(int)

Throws:
MagickException

setPreviewType

public void setPreviewType(int value)
                    throws MagickException
Set the preview_type attribute.

Parameters:
value - new value of the preview_type attribute
Throws:
MagickException

getPreviewType

public int getPreviewType()
                   throws MagickException
Get the preview_type attribute.

Throws:
MagickException

setPing

public void setPing(boolean value)
             throws MagickException
Set the ping attribute. Used to get information about an image without having to read the image into memory. Afterwards you can use readImage to get the width, height, file size in bytes, and the file format of the image, without loading the pixels.

Parameters:
value - new value of the ping attribute
Throws:
MagickException

getPing

public boolean getPing()
                throws MagickException
Get the ping attribute. @see #setPing(boolean)

Throws:
MagickException

setMagick

public void setMagick(java.lang.String magick)
               throws MagickException
Set the magick attribute of the handle. author: Abdulbaset Gaddah

Throws:
MagickException

getMagick

public java.lang.String getMagick()
                           throws MagickException
Return the magick attribute of the handle. author: Abdulbaset Gaddah

Throws:
MagickException

setUnits

public void setUnits(int resolutionType)
              throws MagickException
Set the units attribute of the ImageInfo.

Parameters:
resolutionType - the resolution type as defined in ResolutionType
Throws:
MagickException - on error
See Also:
ResolutionType

getUnits

public int getUnits()
             throws MagickException
Get the units attribute of the ImageInfo.

Returns:
A integer representing the resolution type as defined in ResolutionType
Throws:
MagickException - on error
See Also:
ResolutionType

setBorderColor

public void setBorderColor(PixelPacket color)
                    throws MagickException
Set the border colour..

Parameters:
color - the border colour
Throws:
MagickException - on error
See Also:
MagickImage.borderImage(java.awt.Rectangle)

getBorderColor

public PixelPacket getBorderColor()
                           throws MagickException
Get the current border colour..

Returns:
the current border colour
Throws:
MagickException - on error
See Also:
MagickImage.borderImage(java.awt.Rectangle)

getDepth

public int getDepth()
             throws MagickException
Return the depth of the image.

Returns:
the depth of the image.
Throws:
MagickException - on error

setDepth

public void setDepth(int depth)
              throws MagickException
Set the depth of the image.

Parameters:
depth - the depth of the image
Throws:
MagickException - on error