magick
Class MontageInfo

java.lang.Object
  extended by magick.MontageInfo

public class MontageInfo
extends java.lang.Object

Encapsulation of the MontageInfo structure.

Author:
Eric Yeo

Constructor Summary
MontageInfo(ImageInfo imageInfo)
          Constructor.
 
Method Summary
protected  void finalize()
          To release memory on cleanup.
 PixelPacket getBackgroundColor()
          Get the background_color PixelPacket value
 PixelPacket getBorderColor()
          Get the border_color PixelPacket value
 int getBorderWidth()
          Get the border_width value.
 java.lang.String getFileName()
          Get the filename value
 PixelPacket getFill()
          Get the fill PixelPacket value
 java.lang.String getFont()
          Get the font string value.
 java.lang.String getFrame()
          Get the frame string value.
 java.lang.String getGeometry()
          Get the geometry string value.
 int getGravity()
          Get the gravity value.
 PixelPacket getMatteColor()
          Get the matte_color PixelPacket value
 double getPointSize()
          Get the pointsize value.
 boolean getShadow()
          Get the shadow flag.
 PixelPacket getStroke()
          Get the stroke PixelPacket value
 java.lang.String getTexture()
          Get the texture string value.
 java.lang.String getTile()
          Get the tile string value.
 java.lang.String getTitle()
          Get the title string value.
 void setBackgroundColor(PixelPacket backgroundColor)
          Set the background_color PixelPacket value.
 void setBorderColor(PixelPacket borderColor)
          Set the border_color PixelPacket value.
 void setBorderWidth(int borderWidth)
          Set the border_width value.
 void setFileName(java.lang.String filename)
          Set the filename value.
 void setFill(PixelPacket fill)
          Set the fill PixelPacket value.
 void setFont(java.lang.String str)
          Set the font string value.
 void setFrame(java.lang.String str)
          Set the frame string value.
 void setGeometry(java.lang.String str)
          Set the geometry string value.
 void setGravity(int gravity)
          Set the gravity value.
 void setMatteColor(PixelPacket matteColor)
          Set the matte_color PixelPacket value.
 void setPointSize(double pointsize)
          Set the pointsize value.
 void setShadow(boolean shadow)
          Set the shadow flag.
 void setStroke(PixelPacket stroke)
          Set the stroke PixelPacket value.
 void setTexture(java.lang.String str)
          Set the texture string value.
 void setTile(java.lang.String str)
          Set the tile string value.
 void setTitle(java.lang.String str)
          Set the title string value.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MontageInfo

public MontageInfo(ImageInfo imageInfo)
            throws MagickException
Constructor.

Parameters:
imageInfo - contains initial values for MontageInfo
Throws:
MagickException - upon irrecoverable errors
Method Detail

finalize

protected void finalize()
To release memory on cleanup.

Overrides:
finalize in class java.lang.Object

setGeometry

public void setGeometry(java.lang.String str)
                 throws MagickException
Set the geometry string value.

Parameters:
str - new geometry value
Throws:
MagickException - upon irrecoverable errors

getGeometry

public java.lang.String getGeometry()
                             throws MagickException
Get the geometry string value.

Returns:
the current geometry value
Throws:
MagickException - upon irrecoverable errors

setTile

public void setTile(java.lang.String str)
             throws MagickException
Set the tile string value.

Parameters:
str - new tile value
Throws:
MagickException - upon irrecoverable errors

getTile

public java.lang.String getTile()
                         throws MagickException
Get the tile string value.

Returns:
the current tile value
Throws:
MagickException - upon irrecoverable errors

setTitle

public void setTitle(java.lang.String str)
              throws MagickException
Set the title string value.

Parameters:
str - new title value
Throws:
MagickException - upon irrecoverable errors

getTitle

public java.lang.String getTitle()
                          throws MagickException
Get the title string value.

Returns:
the current title value
Throws:
MagickException - upon irrecoverable errors

setFrame

public void setFrame(java.lang.String str)
              throws MagickException
Set the frame string value.

Parameters:
str - new frame value
Throws:
MagickException - upon irrecoverable errors

getFrame

public java.lang.String getFrame()
                          throws MagickException
Get the frame string value.

Returns:
the current frame value
Throws:
MagickException - upon irrecoverable errors

setTexture

public void setTexture(java.lang.String str)
                throws MagickException
Set the texture string value.

Parameters:
str - new texture value
Throws:
MagickException - upon irrecoverable errors

getTexture

public java.lang.String getTexture()
                            throws MagickException
Get the texture string value.

Returns:
the current texture value
Throws:
MagickException - upon irrecoverable errors

setFont

public void setFont(java.lang.String str)
             throws MagickException
Set the font string value.

Parameters:
str - new font value
Throws:
MagickException - upon irrecoverable errors

getFont

public java.lang.String getFont()
                         throws MagickException
Get the font string value.

Returns:
the current font value
Throws:
MagickException - upon irrecoverable errors

setPointSize

public void setPointSize(double pointsize)
                  throws MagickException
Set the pointsize value.

Parameters:
pointsize - new pointsize value
Throws:
MagickException - upon irrecoverable errors

getPointSize

public double getPointSize()
                    throws MagickException
Get the pointsize value.

Returns:
the current pointsize value
Throws:
MagickException - upon irrecoverable errors

setBorderWidth

public void setBorderWidth(int borderWidth)
                    throws MagickException
Set the border_width value.

Parameters:
borderWidth - new border_width value
Throws:
MagickException - upon irrecoverable errors

getBorderWidth

public int getBorderWidth()
                   throws MagickException
Get the border_width value.

Returns:
the current border_width value
Throws:
MagickException - upon irrecoverable errors

setGravity

public void setGravity(int gravity)
                throws MagickException
Set the gravity value.

Parameters:
gravity - new gravity value
Throws:
MagickException - upon irrecoverable errors
See Also:
GravityType

getGravity

public int getGravity()
               throws MagickException
Get the gravity value.

Returns:
the current gravity value
Throws:
MagickException - upon irrecoverable errors
See Also:
GravityType

setShadow

public void setShadow(boolean shadow)
               throws MagickException
Set the shadow flag.

Parameters:
shadow - new shadow flag
Throws:
MagickException - upon irrecoverable errors

getShadow

public boolean getShadow()
                  throws MagickException
Get the shadow flag.

Returns:
the current shadow flag
Throws:
MagickException - upon irrecoverable errors

setFill

public void setFill(PixelPacket fill)
             throws MagickException
Set the fill PixelPacket value.

Parameters:
fill - new fill PixelPacket value
Throws:
MagickException - upon irrecoverable errors

getFill

public PixelPacket getFill()
                    throws MagickException
Get the fill PixelPacket value

Returns:
the current fill PixelPacket value
Throws:
MagickException - upon irrecoverable errors

setStroke

public void setStroke(PixelPacket stroke)
               throws MagickException
Set the stroke PixelPacket value.

Parameters:
stroke - new stroke PixelPacket value
Throws:
MagickException - upon irrecoverable errors

getStroke

public PixelPacket getStroke()
                      throws MagickException
Get the stroke PixelPacket value

Returns:
the current stroke PixelPacket value
Throws:
MagickException - upon irrecoverable errors

setBackgroundColor

public void setBackgroundColor(PixelPacket backgroundColor)
                        throws MagickException
Set the background_color PixelPacket value.

Parameters:
backgroundColor - new background_color PixelPacket value
Throws:
MagickException - upon irrecoverable errors

getBackgroundColor

public PixelPacket getBackgroundColor()
                               throws MagickException
Get the background_color PixelPacket value

Returns:
the current background_color PixelPacket value
Throws:
MagickException - upon irrecoverable errors

setBorderColor

public void setBorderColor(PixelPacket borderColor)
                    throws MagickException
Set the border_color PixelPacket value.

Parameters:
borderColor - new border_color PixelPacket value
Throws:
MagickException - upon irrecoverable errors

getBorderColor

public PixelPacket getBorderColor()
                           throws MagickException
Get the border_color PixelPacket value

Returns:
the current border_color PixelPacket value
Throws:
MagickException - upon irrecoverable errors

setMatteColor

public void setMatteColor(PixelPacket matteColor)
                   throws MagickException
Set the matte_color PixelPacket value.

Parameters:
matteColor - new matte_color PixelPacket value
Throws:
MagickException - upon irrecoverable errors

getMatteColor

public PixelPacket getMatteColor()
                          throws MagickException
Get the matte_color PixelPacket value

Returns:
the current matte_color PixelPacket value
Throws:
MagickException - upon irrecoverable errors

setFileName

public void setFileName(java.lang.String filename)
                 throws MagickException
Set the filename value.

Parameters:
filename - new filename value
Throws:
MagickException - upon irrecoverable errors

getFileName

public java.lang.String getFileName()
                             throws MagickException
Get the filename value

Returns:
the current filename value
Throws:
MagickException - upon irrecoverable errors