iText 8.0.5 API
iText.Layout.Properties.BackgroundImage.Builder Class Reference

BackgroundImage builder class. More...

Public Member Functions

  Builder ()
  Creates a new Builder instance. More...
 
virtual BackgroundImage.Builder  SetImage (PdfXObject image)
  Sets image. More...
 
virtual BackgroundImage.Builder  SetLinearGradientBuilder (AbstractLinearGradientBuilder linearGradientBuilder)
  Sets linearGradientBuilder. More...
 
virtual BackgroundImage.Builder  SetBackgroundRepeat (BackgroundRepeat repeat)
  Sets background-repeat. More...
 
virtual BackgroundImage.Builder  SetBackgroundPosition (BackgroundPosition position)
  Sets background-position. More...
 
virtual BackgroundImage.Builder  SetBackgroundBlendMode (BlendMode blendMode)
  Set the image's blend mode. More...
 
virtual BackgroundImage.Builder  SetBackgroundSize (BackgroundSize backgroundSize)
  Set the image's backgroundSize. More...
 
virtual BackgroundImage.Builder  SetBackgroundClip (BackgroundBox clip)
  Sets background-clip. More...
 
virtual BackgroundImage.Builder  SetBackgroundOrigin (BackgroundBox origin)
  Sets background-origin. More...
 
virtual BackgroundImage  Build ()
  Builds new BackgroundImage using set fields. More...
 

Detailed Description

BackgroundImage builder class.

Constructor & Destructor Documentation

◆ Builder()

iText.Layout.Properties.BackgroundImage.Builder.Builder ( )
inline

Creates a new Builder instance.

Member Function Documentation

◆ Build()

virtual BackgroundImage iText.Layout.Properties.BackgroundImage.Builder.Build ( )
inlinevirtual

Builds new BackgroundImage using set fields.

Returns
new BackgroundImage.

◆ SetBackgroundBlendMode()

virtual BackgroundImage.Builder iText.Layout.Properties.BackgroundImage.Builder.SetBackgroundBlendMode ( BlendMode  blendMode )
inlinevirtual

Set the image's blend mode.

Parameters
blendMode

BlendMode to be set.

Returns
this Builder.

◆ SetBackgroundClip()

virtual BackgroundImage.Builder iText.Layout.Properties.BackgroundImage.Builder.SetBackgroundClip ( BackgroundBox  clip )
inlinevirtual

Sets background-clip.

Parameters
clip

BackgroundBox to be set.

Returns
this Builder.

◆ SetBackgroundOrigin()

virtual BackgroundImage.Builder iText.Layout.Properties.BackgroundImage.Builder.SetBackgroundOrigin ( BackgroundBox  origin )
inlinevirtual

Sets background-origin.

Parameters
origin

BackgroundBox to be set.

Returns
this Builder.

◆ SetBackgroundPosition()

virtual BackgroundImage.Builder iText.Layout.Properties.BackgroundImage.Builder.SetBackgroundPosition ( BackgroundPosition  position )
inlinevirtual

Sets background-position.

Parameters
position

BackgroundPosition to be set.

Returns
this Builder.

◆ SetBackgroundRepeat()

virtual BackgroundImage.Builder iText.Layout.Properties.BackgroundImage.Builder.SetBackgroundRepeat ( BackgroundRepeat  repeat )
inlinevirtual

Sets background-repeat.

Parameters
repeat

BackgroundRepeat to be set.

Returns
this Builder.

◆ SetBackgroundSize()

virtual BackgroundImage.Builder iText.Layout.Properties.BackgroundImage.Builder.SetBackgroundSize ( BackgroundSize  backgroundSize )
inlinevirtual

Set the image's backgroundSize.

Parameters
backgroundSize

BackgroundSize to be set.

Returns
this Builder.

◆ SetImage()

virtual BackgroundImage.Builder iText.Layout.Properties.BackgroundImage.Builder.SetImage ( PdfXObject  image )
inlinevirtual

Sets image.

Sets image.

Makes linearGradientBuilder null as far as we can't have them both.

Parameters
image

iText.Kernel.Pdf.Xobject.PdfXObject to be set.

Returns
this Builder.

◆ SetLinearGradientBuilder()

virtual BackgroundImage.Builder iText.Layout.Properties.BackgroundImage.Builder.SetLinearGradientBuilder ( AbstractLinearGradientBuilder  linearGradientBuilder )
inlinevirtual

Sets linearGradientBuilder.

Sets linearGradientBuilder.

Makes image null as far as we can't have them both. It also makes background-repeat: no-repeat.

Parameters
linearGradientBuilder

iText.Kernel.Colors.Gradients.AbstractLinearGradientBuilder to be set.

Returns
this Builder.