com.itextpdf.layout.element

Class Image

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement<Image>

com.itextpdf.layout.element.Image

All Implemented Interfaces:

IAccessibleElement, IElement, ILeafElement, IPropertyContainer

public class Image
extends AbstractElement<Image>
implements ILeafElement, IAccessibleElement

A layout element that represents an image for inclusion in the document model.

Field Summary

Fields

Modifier and Type	Field and Description
protected PdfName	role
protected AccessibilityProperties	tagProperties
protected PdfXObject	xObject

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor and Description
Image(ImageData img) Creates an Image from an image resource, read in from a file with the iText I/O module.
Image(ImageData img, float x, float y) Creates an Image from an image resource, read in from a file with the iText I/O module, on a fixed position.
Image(ImageData img, float x, float y, float width) Creates an Image from an image resource, read in from a file with the iText I/O module, with a custom width and on a fixed position.
Image(PdfFormXObject xObject) Creates an Image from a form XObject, the representation of a form in PDF syntax.
Image(PdfFormXObject xObject, float x, float y) Creates an Image from a form XObject, the representation of a form in PDF syntax.
Image(PdfImageXObject xObject) Creates an Image from an image XObject, the representation of an image in PDF syntax.
Image(PdfImageXObject xObject, float width) Creates an Image from an image XObject, the representation of an image in PDF syntax, with a custom width.
Image(PdfImageXObject xObject, float x, float y) Creates an Image from an image XObject, the representation of an image in PDF syntax, on a fixed position.
Image(PdfImageXObject xObject, float x, float y, float width) Creates an Image from an image XObject, the representation of an image in PDF syntax, with a custom width and on a fixed position.

Method Summary

Modifier and Type	Method and Description
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility properties.
float	getImageHeight() Gets height of the image.
float	getImageScaledHeight() Gets scaled height of the image.
float	getImageScaledWidth() Gets scaled width of the image.
float	getImageWidth() Gets width of the image.
Float	getMarginBottom() Gets the current bottom margin width of the element.
Float	getMarginLeft() Gets the current left margin width of the element.
Float	getMarginRight() Gets the current right margin width of the element.
Float	getMarginTop() Gets the current top margin width of the element.
PdfName	getRole() Gets the element's role.
PdfXObject	getXObject() Gets the XObject contained in this image object
protected IRenderer	makeNewRenderer()
Image	scale(float horizontalScaling, float verticalScaling) Scale the image relative to its default size.
Image	scaleAbsolute(float fitWidth, float fitHeight) Scale the image to an absolute size.
Image	scaleToFit(float fitWidth, float fitHeight) Scale the image to an absolute size.
Image	setAutoScale(boolean autoScale) Sets the autoscale property for both width and height.
Image	setAutoScaleHeight(boolean autoScale) Sets the autoscale property for the height of the image.
Image	setAutoScaleWidth(boolean autoScale) Sets the autoscale property for the width of the image.
Image	setFixedPosition(float x, float y) Sets values for a absolute repositioning of the Element.
Image	setFixedPosition(int pageNumber, float x, float y) Sets values for a absolute repositioning of the Element, on a specific page.
Image	setMarginBottom(float value) Sets the bottom margin width of the element.
Image	setMarginLeft(float value) Sets the left margin width of the element.
Image	setMarginRight(float value) Sets the right margin width of the element.
Image	setMargins(float marginTop, float marginRight, float marginBottom, float marginLeft) Sets the margins around the element to a series of new widths.
Image	setMarginTop(float value) Sets the top margin width of the element.
Image	setMaxHeight(float maxHeight)
Image	setMaxWidth(float maxWidth)
Image	setMinHeight(float minHeight)
Image	setMinWidth(float minWidth)
void	setRole(PdfName role) Sets the element's role.
Image	setRotationAngle(double radAngle) Sets the rotation radAngle.

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, propagateArtifactRoleToChildElements, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getDefaultProperty, getHeight, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getWidth, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFont, setFontColor, setFontColor, setFontKerning, setFontScript, setFontSize, setHeight, setHeight, setHeightPercent, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setWidth, setWidth, setWidthPercent, setWordSpacing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Detail

xObject

protected PdfXObject xObject

role

protected PdfName role

tagProperties

protected AccessibilityProperties tagProperties

Constructor Detail

Image

public Image(PdfImageXObject xObject)

Creates an Image from an image XObject, the representation of an image in PDF syntax.

Parameters:

xObject - an internal PdfImageXObject

Image

public Image(PdfFormXObject xObject)

Creates an Image from a form XObject, the representation of a form in PDF syntax.

Parameters:

xObject - an internal PdfFormXObject

Image

public Image(PdfImageXObject xObject,
             float width)

Creates an Image from an image XObject, the representation of an image in PDF syntax, with a custom width.

Parameters:

xObject - an internal PdfImageXObject

width - a float value

Image

public Image(PdfImageXObject xObject,
             float x,
             float y,
             float width)

Creates an Image from an image XObject, the representation of an image in PDF syntax, with a custom width and on a fixed position.

Parameters:

xObject - an internal PdfImageXObject

x - a float value representing the horizontal offset of the lower left corner of the image

y - a float value representing the vertical offset of the lower left corner of the image

width - a float value

Image

public Image(PdfImageXObject xObject,
             float x,
             float y)

Creates an Image from an image XObject, the representation of an image in PDF syntax, on a fixed position.

Parameters:

xObject - an internal PdfImageXObject

x - a float value representing the horizontal offset of the lower left corner of the image

y - a float value representing the vertical offset of the lower left corner of the image

Image

public Image(PdfFormXObject xObject,
             float x,
             float y)

Creates an Image from a form XObject, the representation of a form in PDF syntax.

Parameters:

xObject - an internal PdfFormXObject

x - a float value representing the horizontal offset of the lower left corner of the form

y - a float value representing the vertical offset of the lower left corner of the form

Image

public Image(ImageData img)

Creates an Image from an image resource, read in from a file with the iText I/O module.

Parameters:

img - an internal representation of the image resource

Image

public Image(ImageData img,
             float x,
             float y)

Creates an Image from an image resource, read in from a file with the iText I/O module, on a fixed position.

Parameters:

img - an internal representation of the image resource

x - a float value representing the horizontal offset of the lower left corner of the image

y - a float value representing the vertical offset of the lower left corner of the image

Image

public Image(ImageData img,
             float x,
             float y,
             float width)

Creates an Image from an image resource, read in from a file with the iText I/O module, with a custom width and on a fixed position.

Parameters:

img - an internal representation of the image resource

x - a float value representing the horizontal offset of the lower left corner of the image

y - a float value representing the vertical offset of the lower left corner of the image

width - a float value

Method Detail

getXObject

public PdfXObject getXObject()

Gets the XObject contained in this image object

Returns:

a PdfXObject

setRotationAngle

public Image setRotationAngle(double radAngle)

Sets the rotation radAngle.

Parameters:

radAngle - a value in radians

Returns:

this element

getMarginLeft

public Float getMarginLeft()

Gets the current left margin width of the element.

Returns:

the left margin width, as a float

setMarginLeft

public Image setMarginLeft(float value)

Sets the left margin width of the element.

Parameters:

value - the new left margin width

Returns:

this element

getMarginRight

public Float getMarginRight()

Gets the current right margin width of the element.

Returns:

the right margin width, as a float

setMarginRight

public Image setMarginRight(float value)

Sets the right margin width of the element.

Parameters:

value - the new right margin width

Returns:

this element

getMarginTop

public Float getMarginTop()

Gets the current top margin width of the element.

Returns:

the top margin width, as a float

setMarginTop

public Image setMarginTop(float value)

Sets the top margin width of the element.

Parameters:

value - the new top margin width

Returns:

this element

getMarginBottom

public Float getMarginBottom()

Gets the current bottom margin width of the element.

Returns:

the bottom margin width, as a float

setMarginBottom

public Image setMarginBottom(float value)

Sets the bottom margin width of the element.

Parameters:

value - the new bottom margin width

Returns:

this element

setMargins

public Image setMargins(float marginTop,
                        float marginRight,
                        float marginBottom,
                        float marginLeft)

Sets the margins around the element to a series of new widths.

Parameters:

marginTop - the new margin top width

marginRight - the new margin right width

marginBottom - the new margin bottom width

marginLeft - the new margin left width

Returns:

this element

scale

public Image scale(float horizontalScaling,
                   float verticalScaling)

Scale the image relative to its default size.

Parameters:

horizontalScaling - the horizontal scaling coefficient. default value 1 = 100%

verticalScaling - the vertical scaling coefficient. default value 1 = 100%

Returns:

this element

scaleToFit

public Image scaleToFit(float fitWidth,
                        float fitHeight)

Scale the image to an absolute size. This method will preserve the width-height ratio of the image.

Parameters:

fitWidth - the new maximum width of the image

fitHeight - the new maximum height of the image

Returns:

this element

scaleAbsolute

public Image scaleAbsolute(float fitWidth,
                           float fitHeight)

Scale the image to an absolute size. This method will not preserve the width-height ratio of the image.

Parameters:

fitWidth - the new absolute width of the image

fitHeight - the new absolute height of the image

Returns:

this element

setAutoScale

public Image setAutoScale(boolean autoScale)

Sets the autoscale property for both width and height.

Parameters:

autoScale - whether or not to let the image resize automatically

Returns:

this image

setAutoScaleHeight

public Image setAutoScaleHeight(boolean autoScale)

Sets the autoscale property for the height of the image. Is currently bugged and will not work as expected.

Parameters:

autoScale - whether or not to let the image height resize automatically

Returns:

this image

setAutoScaleWidth

public Image setAutoScaleWidth(boolean autoScale)

Sets the autoscale property for the width of the image.

Parameters:

autoScale - whether or not to let the image width resize automatically

Returns:

this image

setFixedPosition

public Image setFixedPosition(float x,
                              float y)

Sets values for a absolute repositioning of the Element. Also has as a side effect that the Element's Property.POSITION is changed to fixed.

Parameters:

x - horizontal position on the page

y - vertical position on the page

Returns:

this image.

setFixedPosition

public Image setFixedPosition(int pageNumber,
                              float x,
                              float y)

Sets values for a absolute repositioning of the Element, on a specific page. Also has as a side effect that the Element's Property.POSITION is changed to fixed.

Parameters:

pageNumber - the page where the element must be positioned

x - horizontal position on the page

y - vertical position on the page

Returns:

this Element.

getImageWidth

public float getImageWidth()

Gets width of the image. It returns width of image or form XObject, not the width set by one of the #setWidth methods

Returns:

the original width of the image

getImageHeight

public float getImageHeight()

Gets height of the image. It returns height of image or form XObject, not the height set by one of the #setHeight methods

Returns:

the original height of the image

setMaxHeight

public Image setMaxHeight(float maxHeight)

setMinHeight

public Image setMinHeight(float minHeight)

setMaxWidth

public Image setMaxWidth(float maxWidth)

setMinWidth

public Image setMinWidth(float minWidth)

getImageScaledWidth

public float getImageScaledWidth()

Gets scaled width of the image.

Returns:

the current scaled width

getImageScaledHeight

public float getImageScaledHeight()

Gets scaled height of the image.

Returns:

the current scaled height

getRole

public PdfName getRole()

Description copied from interface: IAccessibleElement

Gets the element's role.

Specified by:

getRole in interface IAccessibleElement

Returns:

a PdfName containing the name of the role

setRole

public void setRole(PdfName role)

Description copied from interface: IAccessibleElement

Sets the element's role.

Specified by:

setRole in interface IAccessibleElement

Parameters:

role - the new role which the IAccessibleElement should take

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties.

Specified by:

getAccessibilityProperties in interface IAccessibleElement

Returns:

a properties wrapper object specific to a tagged element in Tagged PDF

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<Image>