Package com.itextpdf.layout.properties
Class BackgroundImage.Builder
- java.lang.Object
-
- com.itextpdf.layout.properties.BackgroundImage.Builder
-
- Enclosing class:
- BackgroundImage
public static class BackgroundImage.Builder extends java.lang.Object
BackgroundImage
builder class.
-
-
Field Summary
Fields Modifier and Type Field Description private BackgroundSize
backgroundSize
private BlendMode
blendMode
private BackgroundBox
clip
private PdfXObject
image
private AbstractLinearGradientBuilder
linearGradientBuilder
private BackgroundBox
origin
private BackgroundPosition
position
private BackgroundRepeat
repeat
-
Constructor Summary
Constructors Constructor Description Builder()
Creates a newBackgroundImage.Builder
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BackgroundImage
build()
Builds newBackgroundImage
using set fields.BackgroundImage.Builder
setBackgroundBlendMode(BlendMode blendMode)
Set the image's blend mode.BackgroundImage.Builder
setBackgroundClip(BackgroundBox clip)
Sets background-clip.BackgroundImage.Builder
setBackgroundOrigin(BackgroundBox origin)
Sets background-origin.BackgroundImage.Builder
setBackgroundPosition(BackgroundPosition position)
Sets background-position.BackgroundImage.Builder
setBackgroundRepeat(BackgroundRepeat repeat)
Sets background-repeat.BackgroundImage.Builder
setBackgroundSize(BackgroundSize backgroundSize)
Set the image's backgroundSize.BackgroundImage.Builder
setImage(PdfXObject image)
Sets image.BackgroundImage.Builder
setLinearGradientBuilder(AbstractLinearGradientBuilder linearGradientBuilder)
Sets linearGradientBuilder.
-
-
-
Field Detail
-
image
private PdfXObject image
-
linearGradientBuilder
private AbstractLinearGradientBuilder linearGradientBuilder
-
position
private BackgroundPosition position
-
repeat
private BackgroundRepeat repeat
-
blendMode
private BlendMode blendMode
-
backgroundSize
private BackgroundSize backgroundSize
-
clip
private BackgroundBox clip
-
origin
private BackgroundBox origin
-
-
Constructor Detail
-
Builder
public Builder()
Creates a newBackgroundImage.Builder
instance.
-
-
Method Detail
-
setImage
public BackgroundImage.Builder setImage(PdfXObject image)
Sets image.Makes linearGradientBuilder null as far as we can't have them both.
- Parameters:
image
-PdfXObject
to be set.- Returns:
- this
BackgroundImage.Builder
.
-
setLinearGradientBuilder
public BackgroundImage.Builder setLinearGradientBuilder(AbstractLinearGradientBuilder linearGradientBuilder)
Sets linearGradientBuilder.Makes image null as far as we can't have them both. It also makes background-repeat: no-repeat.
- Parameters:
linearGradientBuilder
-AbstractLinearGradientBuilder
to be set.- Returns:
- this
BackgroundImage.Builder
.
-
setBackgroundRepeat
public BackgroundImage.Builder setBackgroundRepeat(BackgroundRepeat repeat)
Sets background-repeat.- Parameters:
repeat
-BackgroundRepeat
to be set.- Returns:
- this
BackgroundImage.Builder
.
-
setBackgroundPosition
public BackgroundImage.Builder setBackgroundPosition(BackgroundPosition position)
Sets background-position.- Parameters:
position
-BackgroundPosition
to be set.- Returns:
- this
BackgroundImage.Builder
.
-
setBackgroundBlendMode
public BackgroundImage.Builder setBackgroundBlendMode(BlendMode blendMode)
Set the image's blend mode.- Parameters:
blendMode
-BlendMode
to be set.- Returns:
- this
BackgroundImage.Builder
.
-
setBackgroundSize
public BackgroundImage.Builder setBackgroundSize(BackgroundSize backgroundSize)
Set the image's backgroundSize.- Parameters:
backgroundSize
-BackgroundSize
to be set.- Returns:
- this
BackgroundImage.Builder
.
-
setBackgroundClip
public BackgroundImage.Builder setBackgroundClip(BackgroundBox clip)
Sets background-clip.- Parameters:
clip
-BackgroundBox
to be set.- Returns:
- this
BackgroundImage.Builder
.
-
setBackgroundOrigin
public BackgroundImage.Builder setBackgroundOrigin(BackgroundBox origin)
Sets background-origin.- Parameters:
origin
-BackgroundBox
to be set.- Returns:
- this
BackgroundImage.Builder
.
-
build
public BackgroundImage build()
Builds newBackgroundImage
using set fields.- Returns:
- new
BackgroundImage
.
-
-