com.itextpdf.layout.properties

Class BackgroundImage

java.lang.Object

com.itextpdf.layout.properties.BackgroundImage

public class BackgroundImage
extends Object

Class to hold background-image property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackgroundImage.Builder BackgroundImage builder class.

Field Summary

Fields

Modifier and Type	Field and Description
protected PdfXObject	image
protected AbstractLinearGradientBuilder	linearGradientBuilder

Constructor Summary

Constructors

Constructor and Description
BackgroundImage(BackgroundImage backgroundImage) Creates a copy of passed BackgroundImage instance.

Method Summary

Modifier and Type	Method and Description
BackgroundBox	getBackgroundClip() Gets background-clip.
BackgroundBox	getBackgroundOrigin() Gets background-origin.
BackgroundPosition	getBackgroundPosition() Gets background-position.
BackgroundSize	getBackgroundSize() Gets the background size property.
BlendMode	getBlendMode() Get the image's blend mode.
PdfFormXObject	getForm() Gets initial image if it is instanceof PdfFormXObject, otherwise returns null.
PdfImageXObject	getImage() Gets initial image if it is instanceof PdfImageXObject, otherwise returns null.
float	getImageHeight() Gets initial image height.
float	getImageWidth() Gets initial image width.
AbstractLinearGradientBuilder	getLinearGradientBuilder() Gets linearGradientBuilder.
BackgroundRepeat	getRepeat() Gets image BackgroundRepeat instance.
boolean	isBackgroundSpecified() Returns is background specified.

Methods inherited from class java.lang.Object

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

Field Detail

image

protected PdfXObject image

linearGradientBuilder

protected AbstractLinearGradientBuilder linearGradientBuilder

Constructor Detail

BackgroundImage

public BackgroundImage(BackgroundImage backgroundImage)

Creates a copy of passed BackgroundImage instance.

Parameters:

backgroundImage - BackgroundImage for cloning

Method Detail

getImage

public PdfImageXObject getImage()

Gets initial image if it is instanceof PdfImageXObject, otherwise returns null.

Returns:

PdfImageXObject

getForm

public PdfFormXObject getForm()

Gets initial image if it is instanceof PdfFormXObject, otherwise returns null.

Returns:

PdfFormXObject

getBackgroundPosition

public BackgroundPosition getBackgroundPosition()

Gets background-position.

Returns:

BackgroundPosition

getLinearGradientBuilder

public AbstractLinearGradientBuilder getLinearGradientBuilder()

Gets linearGradientBuilder.

Returns:

AbstractLinearGradientBuilder

isBackgroundSpecified

public boolean isBackgroundSpecified()

Returns is background specified.

Returns:

true if background is specified, otherwise false

getBackgroundSize

public BackgroundSize getBackgroundSize()

Gets the background size property.

Returns:

BackgroundSize instance

getImageWidth

public float getImageWidth()

Gets initial image width.

Returns:

the initial image width

getImageHeight

public float getImageHeight()

Gets initial image height.

Returns:

the initial image height

getRepeat

public BackgroundRepeat getRepeat()

Gets image BackgroundRepeat instance.

Returns:

the image background repeat

getBlendMode

public BlendMode getBlendMode()

Get the image's blend mode.

Returns:

the BlendMode representation of the image's blend mode

getBackgroundClip

public BackgroundBox getBackgroundClip()

Gets background-clip.

Returns:

BackgroundBox

getBackgroundOrigin

public BackgroundBox getBackgroundOrigin()

Gets background-origin.

Returns:

BackgroundBox