com.itextpdf.layout.property

Class BackgroundImage

java.lang.Object

com.itextpdf.layout.property.BackgroundImage

public class BackgroundImage
extends Object

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
protected boolean	repeatX Deprecated. replace this field with BackgroundRepeat instance
protected boolean	repeatY Deprecated. replace this field with BackgroundRepeat instance

Constructor Summary

Constructors

Constructor and Description
BackgroundImage(AbstractLinearGradientBuilder linearGradientBuilder) Deprecated. Remove this constructor in 7.2.
BackgroundImage(AbstractLinearGradientBuilder linearGradientBuilder, BlendMode blendMode) Deprecated. Remove this constructor in 7.2.
BackgroundImage(BackgroundImage backgroundImage) Creates a copy of passed BackgroundImage instance.
BackgroundImage(PdfFormXObject image) Deprecated. Remove this constructor in 7.2.
BackgroundImage(PdfFormXObject image, BackgroundRepeat repeat) Deprecated. Remove this constructor in 7.2.
BackgroundImage(PdfFormXObject image, BackgroundRepeat repeat, BlendMode blendMode) Deprecated. Remove this constructor in 7.2.
BackgroundImage(PdfFormXObject image, boolean repeatX, boolean repeatY) Deprecated. Remove this constructor in 7.2.
BackgroundImage(PdfImageXObject image) Deprecated. Remove this constructor in 7.2.
BackgroundImage(PdfImageXObject image, BackgroundRepeat repeat) Deprecated. Remove this constructor in 7.2.
BackgroundImage(PdfImageXObject image, BackgroundRepeat repeat, BlendMode blendMode) Deprecated. Remove this constructor in 7.2.
BackgroundImage(PdfImageXObject image, boolean repeatX, boolean repeatY) Deprecated. Remove this constructor in 7.2.

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()
float	getHeight() Deprecated. To be removed in 7.2. Use getImageHeight() instead.
PdfImageXObject	getImage()
float	getImageHeight() Gets initial image height.
float	getImageWidth() Gets initial image width.
AbstractLinearGradientBuilder	getLinearGradientBuilder()
BackgroundRepeat	getRepeat() Gets image BackgroundRepeat instance.
float	getWidth() Deprecated. To be removed in 7.2. Use getImageWidth() instead.
boolean	isBackgroundSpecified()
boolean	isRepeatX() Deprecated.
boolean	isRepeatY() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

image

protected PdfXObject image

repeatX

@Deprecated
protected boolean repeatX

Deprecated. replace this field with BackgroundRepeat instance

Whether the background-repeat value is not BackgroundRepeat.BackgroundRepeatValue.NO_REPEAT for X axis.

repeatY

@Deprecated
protected boolean repeatY

Deprecated. replace this field with BackgroundRepeat instance

Whether the background-repeat value is not BackgroundRepeat.BackgroundRepeatValue.NO_REPEAT for Y axis.

linearGradientBuilder

protected AbstractLinearGradientBuilder linearGradientBuilder

Constructor Detail

BackgroundImage

public BackgroundImage(BackgroundImage backgroundImage)

Creates a copy of passed BackgroundImage instance.

Parameters:

backgroundImage - BackgroundImage for cloning

BackgroundImage

@Deprecated
public BackgroundImage(PdfImageXObject image,
                                   BackgroundRepeat repeat,
                                   BlendMode blendMode)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance.

Parameters:

image - background image property. PdfImageXObject instance.

repeat - background repeat property. BackgroundRepeat instance.

blendMode - the image's blend mode. BlendMode instance.

BackgroundImage

@Deprecated
public BackgroundImage(PdfFormXObject image,
                                   BackgroundRepeat repeat,
                                   BlendMode blendMode)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance.

Parameters:

image - background image property. PdfFormXObject instance.

repeat - background repeat property. BackgroundRepeat instance.

blendMode - the image's blend mode. BlendMode instance.

BackgroundImage

@Deprecated
public BackgroundImage(PdfImageXObject image,
                                   BackgroundRepeat repeat)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance.

Parameters:

image - background-image property. PdfImageXObject instance.

repeat - background-repeat property. BackgroundRepeat instance.

BackgroundImage

@Deprecated
public BackgroundImage(PdfFormXObject image,
                                   BackgroundRepeat repeat)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance.

Parameters:

image - background-image property. PdfFormXObject instance.

repeat - background-repeat property. BackgroundRepeat instance.

BackgroundImage

@Deprecated
public BackgroundImage(PdfImageXObject image)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance.

Parameters:

image - background-image property. PdfImageXObject instance.

BackgroundImage

@Deprecated
public BackgroundImage(PdfFormXObject image)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance.

Parameters:

image - background-image property. PdfFormXObject instance.

BackgroundImage

@Deprecated
public BackgroundImage(PdfImageXObject image,
                                   boolean repeatX,
                                   boolean repeatY)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance.

Parameters:

image - background-image property. PdfImageXObject instance.

repeatX - defines whether background is repeated in x dimension.

repeatY - defines whether background is repeated in y dimension.

BackgroundImage

@Deprecated
public BackgroundImage(PdfFormXObject image,
                                   boolean repeatX,
                                   boolean repeatY)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance.

Parameters:

image - background-image property. PdfFormXObject instance.

repeatX - defines whether background is repeated in x dimension.

repeatY - defines whether background is repeated in y dimension.

BackgroundImage

@Deprecated
public BackgroundImage(AbstractLinearGradientBuilder linearGradientBuilder)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance with linear gradient.

Parameters:

linearGradientBuilder - the linear gradient builder representing the background image. AbstractLinearGradientBuilder instance.

BackgroundImage

@Deprecated
public BackgroundImage(AbstractLinearGradientBuilder linearGradientBuilder,
                                   BlendMode blendMode)

Deprecated. Remove this constructor in 7.2.

Creates a new BackgroundImage instance with linear gradient and custom blending mode.

Parameters:

linearGradientBuilder - the linear gradient builder representing the background image. AbstractLinearGradientBuilder instance.

blendMode - the image's blend mode. BlendMode instance.

Method Detail

getImage

public PdfImageXObject getImage()

getForm

public PdfFormXObject getForm()

getBackgroundPosition

public BackgroundPosition getBackgroundPosition()

Gets background-position.

Returns:

BackgroundPosition

getLinearGradientBuilder

public AbstractLinearGradientBuilder getLinearGradientBuilder()

isBackgroundSpecified

public boolean isBackgroundSpecified()

isRepeatX

@Deprecated
public boolean isRepeatX()

Deprecated.

isRepeatY

@Deprecated
public boolean isRepeatY()

Deprecated.

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

getWidth

@Deprecated
public float getWidth()

Deprecated. To be removed in 7.2. Use getImageWidth() instead.

Gets initial image width.

Returns:

the initial image width

getHeight

@Deprecated
public float getHeight()

Deprecated. To be removed in 7.2. Use getImageHeight() instead.

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