Image (iText, a Free Java-PDF library 5.4.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.itextpdf.text
Class Image

java.lang.Object
  com.itextpdf.text.Rectangle
      com.itextpdf.text.Image

All Implemented Interfaces:: Indentable, Spaceable, Element, IAccessibleElement

Direct Known Subclasses:: ImgCCITT, ImgJBIG2, ImgRaw, ImgTemplate, ImgWMF, Jpeg, Jpeg2000

public abstract class Image
extends Rectangle
implements Indentable, Spaceable, IAccessibleElement
extends Rectangle
implements Indentable, Spaceable, IAccessibleElement

An Image is the representation of a graphic element (JPEG, PNG or GIF) that has to be inserted into the document

See Also:: Element, Rectangle

Field Summary
`protected float`	`absoluteX` This is the absolute X-position of the image.
`protected float`	`absoluteY` This is the absolute Y-position of the image.
`protected HashMap<PdfName,PdfObject>`	`accessibleAttributes`
`protected int`	`alignment` The alignment of the Image.
`protected String`	`alt` Text that can be shown instead of the image.
`protected Annotation`	`annotation` if the annotation is not null the image will be clickable.
`static int`	`AX` This represents a coordinate in the transformation matrix.
`static int`	`AY` This represents a coordinate in the transformation matrix.
`protected int`	`bpc` The bits per component of the raw image.
`static int`	`BX` This represents a coordinate in the transformation matrix.
`static int`	`BY` This represents a coordinate in the transformation matrix.
`protected int`	`colorspace` this is the colorspace of a jpeg-image.
`protected int`	`compressionLevel` The compression level of the content streams.
`static int`	`CX` This represents a coordinate in the transformation matrix.
`static int`	`CY` This represents a coordinate in the transformation matrix.
`static int`	`DEFAULT` this is a kind of image alignment.
`protected boolean`	`deflated` Holds value of property deflated.
`protected int`	`dpiX` Holds value of property dpiX.
`protected int`	`dpiY` Holds value of property dpiY.
`static int`	`DX` This represents a coordinate in the transformation matrix.
`static int`	`DY` This represents a coordinate in the transformation matrix.
`protected Image`	`imageMask` The image that serves as a mask for this image.
`protected float`	`indentationLeft` the indentation to the left.
`protected float`	`indentationRight` the indentation to the right.
`protected boolean`	`interpolation` Holds value of property interpolation.
`protected boolean`	`invert` Image color inversion
`protected PdfOCG`	`layer` Optional Content layer to which we want this Image to belong.
`static int`	`LEFT` this is a kind of image alignment.
`protected boolean`	`mask` Is this image a mask?
`static int`	`MIDDLE` this is a kind of image alignment.
`protected Long`	`mySerialId` an iText attributed unique id for this image.
`static int`	`ORIGINAL_BMP` type of image
`static int`	`ORIGINAL_GIF` type of image
`static int`	`ORIGINAL_JBIG2` type of image
`static int`	`ORIGINAL_JPEG` type of image
`static int`	`ORIGINAL_JPEG2000` type of image
`static int`	`ORIGINAL_NONE` type of image
`static int`	`ORIGINAL_PNG` type of image
`static int`	`ORIGINAL_PS` type of image
`static int`	`ORIGINAL_TIFF` type of image
`static int`	`ORIGINAL_WMF` type of image
`protected byte[]`	`originalData` Holds value of property originalData.
`protected int`	`originalType` Holds value of property originalType.
`protected float`	`plainHeight` This is the width of the image without rotation.
`protected float`	`plainWidth` This is the width of the image without rotation.
`protected ICC_Profile`	`profile` ICC Profile attached
`protected byte[]`	`rawData` The raw data of the image.
`static int`	`RIGHT` this is a kind of image alignment.
`protected PdfName`	`role`
`protected float`	`rotationRadians` This is the rotation of the image in radians.
`protected float`	`scaledHeight` This is the original height of the image taking rotation into account.
`protected float`	`scaledWidth` This is the scaled width of the image taking rotation into account.
`protected boolean`	`scaleToFitHeight` Indicates if the image should be scaled to fit when the image exceeds the available height.
`protected boolean`	`scaleToFitLineWhenOverflow` Indicates if the image should be scaled to fit the line when the image exceeds the available width.
`protected float`	`spacingAfter` The spacing after the image.
`protected float`	`spacingBefore` The spacing before the image.
`protected PdfTemplate[]`	`template` The template to be treated as an image.
`static int`	`TEXTWRAP` this is a kind of image alignment.
`protected int[]`	`transparency` this is the transparency information of the raw image
`protected int`	`type` The image type.
`static int`	`UNDERLYING` this is a kind of image alignment.
`protected URL`	`url` The URL of the image.

Fields inherited from class com.itextpdf.text.Rectangle
`backgroundColor, border, borderColor, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, llx, lly, NO_BORDER, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders`

Fields inherited from interface com.itextpdf.text.Element
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CHAPTER, CHUNK, CREATIONDATE, CREATOR, DIV, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LANGUAGE, LIST, LISTITEM, MARKED, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, SECTION, SUBJECT, TITLE, WRITABLE_DIRECT, YMARK

Fields inherited from interface com.itextpdf.text.Element

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CHAPTER, CHUNK, CREATIONDATE, CREATOR, DIV, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LANGUAGE, LIST, LISTITEM, MARKED, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, SECTION, SUBJECT, TITLE, WRITABLE_DIRECT, YMARK

Constructor Summary
`protected`	`Image(Image image)` Constructs an `Image` -object, using an `url` .
	`Image(URL url)` Constructs an `Image` -object, using an `url` .

Method Summary
`float`	`getAbsoluteX()` Returns the absolute X position.
`float`	`getAbsoluteY()` Returns the absolute Y position.
`PdfObject`	`getAccessibleAttribute(PdfName key)` Get the attribute of accessible element (everything in `A` dictionary + `Lang`, `Alt`, `ActualText`, `E`).
`HashMap<PdfName,PdfObject>`	`getAccessibleAttributes()` Gets all the properties of accessible element.
`PdfDictionary`	`getAdditional()` Getter for the dictionary with additional information.
`int`	`getAlignment()` Gets the alignment for the image.
`String`	`getAlt()` Gets the alternative text for the image.
`Annotation`	`getAnnotation()` Gets the annotation.
`int`	`getBpc()` Gets the bpc for the image.
`int`	`getColorspace()` Gets the colorspace for the image.
`int`	`getCompressionLevel()` Returns the compression level used for images written as a compressed stream.
`PdfIndirectReference`	`getDirectReference()` Getter for property directReference.
`int`	`getDpiX()` Gets the dots-per-inch in the X direction.
`int`	`getDpiY()` Gets the dots-per-inch in the Y direction.
`ICC_Profile`	`getICCProfile()` Gets the images ICC profile.
`UUID`	`getId()`
`Image`	`getImageMask()` Gets the explicit masking.
`float`	`getImageRotation()` Gets the current image rotation in radians.
`float`	`getIndentationLeft()` Gets the left indentation.
`float`	`getIndentationRight()` Gets the right indentation.
`float`	`getInitialRotation()` Getter for property initialRotation.
`static Image`	`getInstance(byte[] imgb)`
`static Image`	`getInstance(byte[] imgb, boolean handleIncorrectImage)` gets an instance of an Image
`static Image`	`getInstance(Image image)` gets an instance of an Image
`static Image`	`getInstance(Image image, Color color)` Gets an instance of an Image from a java.awt.Image.
`static Image`	`getInstance(Image image, Color color, boolean forceBW)` Gets an instance of an Image from a java.awt.Image.
`static Image`	`getInstance(int width, int height, boolean reverseBits, int typeCCITT, int parameters, byte[] data)` Creates an Image with CCITT G3 or G4 compression.
`static Image`	`getInstance(int width, int height, boolean reverseBits, int typeCCITT, int parameters, byte[] data, int[] transparency)` Creates an Image with CCITT G3 or G4 compression.
`static Image`	`getInstance(int width, int height, byte[] data, byte[] globals)` Creates a JBIG2 Image.
`static Image`	`getInstance(int width, int height, int components, int bpc, byte[] data)` Gets an instance of an Image in raw mode.
`static Image`	`getInstance(int width, int height, int components, int bpc, byte[] data, int[] transparency)` Gets an instance of an Image in raw mode.
`static Image`	`getInstance(PdfContentByte cb, Image awtImage, float quality)` Gets an instance of a Image from a java.awt.Image.
`static Image`	`getInstance(PdfTemplate template)` gets an instance of an Image
`static Image`	`getInstance(PdfWriter writer, Image awtImage, float quality)` Gets an instance of a Image from a java.awt.Image.
`static Image`	`getInstance(PRIndirectReference ref)` Reuses an existing image.
`static Image`	`getInstance(String filename)` Gets an instance of an Image.
`static Image`	`getInstance(String filename, boolean handleIncorrectImage)`
`static Image`	`getInstance(URL url)`
`static Image`	`getInstance(URL url, boolean handleIncorrectImage)` Gets an instance of an Image.
`PdfOCG`	`getLayer()` Gets the layer this image belongs to.
`Long`	`getMySerialId()` Returns a serial id for the Image (reuse the same image more than once)
`byte[]`	`getOriginalData()` Getter for property originalData.
`int`	`getOriginalType()` Getter for property originalType.
`float`	`getPlainHeight()` Gets the plain height of the image.
`float`	`getPlainWidth()` Gets the plain width of the image.
`byte[]`	`getRawData()` Gets the raw data for the image.
`PdfName`	`getRole()` Gets the role of the accessible element.
`float`	`getScaledHeight()` Gets the scaled height of the image.
`float`	`getScaledWidth()` Gets the scaled width of the image.
`protected static Long`	`getSerialId()` Creates a new serial id.
`float`	`getSpacingAfter()` Gets the spacing before this image.
`float`	`getSpacingBefore()` Gets the spacing before this image.
`PdfTemplate`	`getTemplateData()` Gets the template to be used as an image.
`int[]`	`getTransparency()` Returns the transparency.
`URL`	`getUrl()` Gets the `String` -representation of the reference to the image.
`float`	`getWidthPercentage()` Getter for property widthPercentage.
`float`	`getXYRatio()` Gets the X/Y pixel dimensionless aspect ratio.
`boolean`	`hasAbsoluteX()` Checks if the `Images` has to be added at an absolute X position.
`boolean`	`hasAbsoluteY()` Checks if the `Images` has to be added at an absolute position.
`boolean`	`hasICCProfile()` Checks is the image has an ICC profile.
`boolean`	`isDeflated()` Getter for property deflated.
`boolean`	`isImgRaw()` Returns `true` if the image is a `ImgRaw` -object.
`boolean`	`isImgTemplate()` Returns `true` if the image is an `ImgTemplate` -object.
`boolean`	`isInterpolation()` Getter for property interpolation.
`boolean`	`isInverted()` Getter for the inverted value
`boolean`	`isJpeg()` Returns `true` if the image is a `Jpeg` -object.
`boolean`	`isMask()` Returns `true` if this `Image` is a mask.
`boolean`	`isMaskCandidate()` Returns `true` if this `Image` has the requisites to be a mask.
`boolean`	`isNestable()` Checks if this element is nestable.
`boolean`	`isScaleToFitHeight()` Gets the value of scaleToFitHeight.
`boolean`	`isScaleToFitLineWhenOverflow()` Gets the value of scaleToFitLineWhenOverflow.
`boolean`	`isSmask()` Getter for property smask.
`void`	`makeMask()` Make this `Image` a mask.
`float[]`	`matrix()` Returns the transformation matrix of the image.
`float[]`	`matrix(float scalePercentage)` Returns the transformation matrix of the image.
`void`	`scaleAbsolute(float newWidth, float newHeight)` Scale the image to an absolute width and an absolute height.
`void`	`scaleAbsolute(Rectangle rectangle)` Scale the image to the dimensions of the rectangle
`void`	`scaleAbsoluteHeight(float newHeight)` Scale the image to an absolute height.
`void`	`scaleAbsoluteWidth(float newWidth)` Scale the image to an absolute width.
`void`	`scalePercent(float percent)` Scale the image to a certain percentage.
`void`	`scalePercent(float percentX, float percentY)` Scale the width and height of an image to a certain percentage.
`void`	`scaleToFit(float fitWidth, float fitHeight)` Scales the image so that it fits a certain width and height.
`void`	`scaleToFit(Rectangle rectangle)` Scales the images to the dimensions of the rectangle.
`void`	`setAbsolutePosition(float absoluteX, float absoluteY)` Sets the absolute position of the `Image`.
`void`	`setAccessibleAttribute(PdfName key, PdfObject value)` Set the attribute of accessible element (everything in `A` dictionary + `Lang`, `Alt`, `ActualText`, `E`).
`void`	`setAdditional(PdfDictionary additional)` Sets the /Colorspace key.
`void`	`setAlignment(int alignment)` Sets the alignment for the image.
`void`	`setAlt(String alt)` Sets the alternative information for the image.
`void`	`setAnnotation(Annotation annotation)` Sets the annotation of this Image.
`void`	`setCompressionLevel(int compressionLevel)` Sets the compression level to be used if the image is written as a compressed stream.
`void`	`setDeflated(boolean deflated)` Setter for property deflated.
`void`	`setDirectReference(PdfIndirectReference directReference)` Setter for property directReference.
`void`	`setDpi(int dpiX, int dpiY)` Sets the dots per inch value
`void`	`setId(UUID id)`
`void`	`setImageMask(Image mask)` Sets the explicit masking.
`void`	`setIndentationLeft(float f)` Sets the left indentation.
`void`	`setIndentationRight(float f)` Sets the right indentation.
`void`	`setInitialRotation(float initialRotation)` Some image formats, like TIFF may present the images rotated that have to be compensated.
`void`	`setInterpolation(boolean interpolation)` Sets the image interpolation.
`void`	`setInverted(boolean invert)` Sets inverted true or false
`void`	`setLayer(PdfOCG layer)` Sets the layer this image belongs to.
`void`	`setOriginalData(byte[] originalData)` Setter for property originalData.
`void`	`setOriginalType(int originalType)` Setter for property originalType.
`void`	`setRole(PdfName role)` Sets the role of the accessiblee element.
`void`	`setRotation(float r)` Sets the rotation of the image in radians.
`void`	`setRotationDegrees(float deg)` Sets the rotation of the image in degrees.
`void`	`setScaleToFitHeight(boolean scaleToFitHeight)` Sets the value of scaleToFitHeight
`void`	`setScaleToFitLineWhenOverflow(boolean scaleToFitLineWhenOverflow)` Sets the value of scaleToFitLineWhenOverflow
`void`	`setSmask(boolean smask)` Setter for property smask.
`void`	`setSpacingAfter(float spacing)` Sets the spacing after this image.
`void`	`setSpacingBefore(float spacing)` Sets the spacing before this image.
`void`	`setTemplateData(PdfTemplate template)` Sets data from a PdfTemplate
`void`	`setTransparency(int[] transparency)` Sets the transparency values
`void`	`setUrl(URL url)` Sets the url of the image
`void`	`setWidthPercentage(float widthPercentage)` Setter for property widthPercentage.
`void`	`setXYRatio(float XYRatio)` Sets the X/Y pixel dimensionless aspect ratio.
`void`	`simplifyColorspace()` Replaces CalRGB and CalGray colorspaces with DeviceRGB and DeviceGray.
`void`	`tagICC(ICC_Profile profile)` Tags this image with an ICC profile.
`int`	`type()` Returns the type.

Methods inherited from class com.itextpdf.text.Rectangle
cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getBottom, getChunks, getGrayFill, getHeight, getLeft, getLeft, getRight, getRight, getRotation, getTop, getTop, getWidth, hasBorder, hasBorders, isContent, isUseVariableBorders, normalize, process, rectangle, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setRight, setRotation, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString

Methods inherited from class com.itextpdf.text.Rectangle

cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getBottom, getChunks, getGrayFill, getHeight, getLeft, getLeft, getRight, getRight, getRotation, getTop, getTop, getWidth, hasBorder, hasBorders, isContent, isUseVariableBorders, normalize, process, rectangle, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setRight, setRotation, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString

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

Field Detail

DEFAULT

public static final int DEFAULT

this is a kind of image alignment.

See Also:: Constant Field Values

RIGHT

public static final int RIGHT

this is a kind of image alignment.

See Also:: Constant Field Values

LEFT

public static final int LEFT

this is a kind of image alignment.

See Also:: Constant Field Values

MIDDLE

public static final int MIDDLE

this is a kind of image alignment.

See Also:: Constant Field Values

TEXTWRAP

public static final int TEXTWRAP

this is a kind of image alignment.

See Also:: Constant Field Values

UNDERLYING

public static final int UNDERLYING

this is a kind of image alignment.

See Also:: Constant Field Values