magick

Class ImageInfo

java.lang.Object

magick.Magick

magick.ImageInfo

public class ImageInfo
extends Magick

Corresponds to the ImageMagick ImageInfo structure.

Author:

Eric Yeo

Constructor Summary

Constructors

Constructor and Description
ImageInfo() Constructor.
ImageInfo(String fileName) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	finalize() To release memory on cleanup.
int	getAdjoin()
boolean	getAffirm() Get the affirm attribute.
int	getAntialias()
PixelPacket	getBorderColor() Get the current border colour..
int	getColorspace()
int	getCompression()
String	getDensity()
int	getDepth() Return the depth of the image.
int	getDither()
String	getFileName() Return the file name attribute of the handle.
String	getFont()
int	getInterlace()
String	getMagick() Return the magick attribute of the handle.
int	getMonochrome()
String	getPage()
boolean	getPing() Get the ping attribute.
int	getPointSize()
int	getPreviewType() Get the preview_type attribute.
int	getQuality()
String	getServerName()
String	getSize()
int	getSubimage()
int	getSubrange()
String	getTexture()
String	getTile()
int	getUnits() Get the units attribute of the ImageInfo.
int	getVerbose() Get the verbose attribute.
String	getView()
void	init() Initialises the internal native handle.
void	setAdjoin(int value)
void	setAffirm(boolean affirm) Set the affirm attribute.
void	setAntialias(int value)
void	setBorderColor(PixelPacket color) Set the border colour..
void	setColorspace(int value)
void	setCompression(int value)
void	setDensity(String density)
void	setDepth(int depth) Set the depth of the image.
void	setDither(int value)
void	setFileName(String fileName) Set the file name attribute of the handle.
void	setFont(String font)
void	setImageOption(String option, String value) Associates a value with an image option.
void	setInterlace(int value)
void	setMagick(String magick) Set the magick attribute of the handle.
void	setMonochrome(int value)
void	setPage(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(String name)
void	setSize(String size)
void	setSubimage(int value)
void	setSubrange(int value)
void	setTexture(String texture)
void	setTile(String tile)
void	setUnits(int resolutionType) Set the units attribute of the ImageInfo.
void	setVerbose(int value) Set the verbose attribute.
void	setView(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(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 Object

init

public void init()
          throws MagickException

Initialises the internal native handle.

Throws:

MagickException

setFileName

public void setFileName(String fileName)
                 throws MagickException

Set the file name attribute of the handle.

Parameters:

fileName - the new file name

Throws:

MagickException

setImageOption

public void setImageOption(String option,
                           String value)
                    throws MagickException

Associates a value with an image option. Example:

 ImageInfo info = new ImageInfo(...)
 info.setImageOption("quantum:polarity", "min-is-white");
 

This then ensures that our tiffs come out in a way that works with Microsofts Tiff Viewer.

Parameters:

option - the image option

value - the image option value

Throws:

MagickException

Since:

JMagick 6.4.3 (2008-08-05)

getFileName

public 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(String name)
                   throws MagickException

Throws:

MagickException

getServerName

public String getServerName()
                     throws MagickException

Throws:

MagickException

setFont

public void setFont(String font)
             throws MagickException

Throws:

MagickException

getFont

public String getFont()
               throws MagickException

Throws:

MagickException

setSize

public void setSize(String size)
             throws MagickException

Throws:

MagickException

getSize

public String getSize()
               throws MagickException

Throws:

MagickException

setTile

public void setTile(String tile)
             throws MagickException

Throws:

MagickException

getTile

public String getTile()
               throws MagickException

Throws:

MagickException

setDensity

public void setDensity(String density)
                throws MagickException

Throws:

MagickException

getDensity

public String getDensity()
                  throws MagickException

Throws:

MagickException

setPage

public void setPage(String page)
             throws MagickException

Throws:

MagickException

getPage

public String getPage()
               throws MagickException

Throws:

MagickException

setTexture

public void setTexture(String texture)
                throws MagickException

Throws:

MagickException

getTexture

public String getTexture()
                  throws MagickException

Throws:

MagickException

setView

public void setView(String view)
             throws MagickException

Throws:

MagickException

getView

public 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

setAntialias

public void setAntialias(int value)
                  throws MagickException

Throws:

MagickException

getAntialias

public int getAntialias()
                 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(String magick)
               throws MagickException

Set the magick attribute of the handle. author: Abdulbaset Gaddah

Throws:

MagickException

getMagick

public String getMagick()
                 throws MagickException

Return the magick attribute of the handle.

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