Wrapper that represents tiling pattern of color space. More...

Inheritance diagram for iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling:

Classes
class	PaintType
	A code that determines how the colour of the pattern cell shall be specified More...

class	TilingType
	A code that controls adjustments to the spacing of tiles relative to the device pixel grid More...

Public Member Functions
	Tiling (PdfStream pdfObject)
	Creates new instance from the iText.Kernel.Pdf.PdfStream object. More...

	Tiling (float width, float height)
	Creates a new Tiling Pattern instance. More...

	Tiling (float width, float height, bool colored)
	Creates a new Tiling Pattern instance. More...

	Tiling (Rectangle bbox)
	Creates a new Tiling instance. More...

	Tiling (Rectangle bbox, bool colored)
	Creates a new Tiling instance. More...

	Tiling (float width, float height, float xStep, float yStep)
	Creates a new Tiling Pattern instance. More...

	Tiling (float width, float height, float xStep, float yStep, bool colored)
	Creates a new Tiling Pattern instance. More...

	Tiling (Rectangle bbox, float xStep, float yStep)
	Creates a new Tiling instance. More...

	Tiling (Rectangle bbox, float xStep, float yStep, bool colored)
	Creates a new Tiling instance. More...

virtual bool	IsColored ()
	Checks if this pattern have colored paint type. More...

virtual void	SetColored (bool colored)
	Sets the paint type. More...

virtual int	GetTilingType ()
	Gets the tiling type. More...

virtual void	SetTilingType (int tilingType)
	Sets the tiling type. More...

virtual Rectangle	GetBBox ()
	Gets the pattern cell's bounding box. More...

virtual void	SetBBox (Rectangle bbox)
	Sets the pattern cell's bounding box. More...

virtual float	GetXStep ()
	Gets the desired horizontal space between pattern cells. More...

virtual void	SetXStep (float xStep)
	Sets the desired horizontal space between pattern cells. More...

virtual float	GetYStep ()
	Gets the desired vertical space between pattern cells. More...

virtual void	SetYStep (float yStep)
	Sets the desired vertical space between pattern cells. More...

virtual PdfResources	GetResources ()
	Gets the Tiling Pattern's resources. More...

override void	Flush ()
	To manually flush a `PdfObject` behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. More...

Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfPattern
virtual PdfArray	GetMatrix ()
	Gets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream. More...

virtual void	SetMatrix (PdfArray matrix)
	Sets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual bool	IsFlushed ()

Additional Inherited Members
Static Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfPattern
static iText.Kernel.Pdf.Colorspace.PdfPattern	GetPatternInstance (PdfDictionary pdfObject)
	Creates the instance wrapper of correct type from the iText.Kernel.Pdf.PdfDictionary More...

Detailed Description

Wrapper that represents tiling pattern of color space.

Wrapper that represents tiling pattern of color space. This pattern consists of a small graphical figure (cells). Painting with the pattern replicates the cell at fixed horizontal and vertical intervals to fill an area. The pattern cell can include graphical elements such as filled areas, text, and sampled images. Its shape need not be rectangular, and the spacing of tiles can differ from the dimensions of the cell itself. The appearance of the pattern cell shall be defined by a content stream containing the painting operators needed to paint one instance of the cell

Constructor & Destructor Documentation

◆ Tiling() [1/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling ( PdfStream pdfObject )

inline

Creates new instance from the iText.Kernel.Pdf.PdfStream object.

Creates new instance from the iText.Kernel.Pdf.PdfStream object. This stream should have PatternType equals to 1.

Parameters

pdfObject the iText.Kernel.Pdf.PdfStream that represents Tiling Pattern.

◆ Tiling() [2/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling	(	float	width,
		float	height
	)

inline

Creates a new Tiling Pattern instance.

By default the pattern will be colored.

Parameters

width	the width of the pattern cell's bounding box
height	the height of the pattern cell's bounding box

◆ Tiling() [3/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling	(	float	width,
		float	height,
		bool	colored
	)

inline

Creates a new Tiling Pattern instance.

Parameters

width	the width of the pattern cell's bounding box
height	the height of the pattern cell's bounding box
colored	defines whether the Tiling Pattern will be colored or not

◆ Tiling() [4/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling ( Rectangle bbox )

inline

Creates a new Tiling instance.

By default the pattern will be colored.

Parameters

bbox	the pattern cell's bounding box

◆ Tiling() [5/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling	(	Rectangle	bbox,
		bool	colored
	)

inline

Creates a new Tiling instance.

Parameters

bbox	the pattern cell's bounding box
colored	defines whether the Tiling Pattern will be colored or not

◆ Tiling() [6/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling	(	float	width,
		float	height,
		float	xStep,
		float	yStep
	)

inline

Creates a new Tiling Pattern instance.

By default the pattern will be colored.

Parameters

width	the width of the pattern cell's bounding box
height	the height of the pattern cell's bounding box
xStep	the desired horizontal space between pattern cells
yStep	the desired vertical space between pattern cells

◆ Tiling() [7/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling	(	float	width,
		float	height,
		float	xStep,
		float	yStep,
		bool	colored
	)

inline

Creates a new Tiling Pattern instance.

Parameters

width	the width of the pattern cell's bounding box
height	the height of the pattern cell's bounding box
xStep	the desired horizontal space between pattern cells
yStep	the desired vertical space between pattern cells
colored	defines whether the Tiling Pattern will be colored or not

◆ Tiling() [8/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling	(	Rectangle	bbox,
		float	xStep,
		float	yStep
	)

inline

Creates a new Tiling instance.

By default the pattern will be colored.

Parameters

bbox	the pattern cell's bounding box
xStep	the desired horizontal space between pattern cells
yStep	the desired vertical space between pattern cells

◆ Tiling() [9/9]

iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Tiling	(	Rectangle	bbox,
		float	xStep,
		float	yStep,
		bool	colored
	)

inline

Creates a new Tiling instance.

Parameters

bbox	the pattern cell's bounding box
xStep	the desired horizontal space between pattern cells
yStep	the desired vertical space between pattern cells
colored	defines whether the Tiling Pattern will be colored or not

Member Function Documentation

◆ Flush()

override void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Flush ( )

inlinevirtual

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference.

Reimplemented from iText.Kernel.Pdf.Colorspace.PdfPattern.

◆ GetBBox()

virtual Rectangle iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.GetBBox ( )

inlinevirtual

Gets the pattern cell's bounding box.

Gets the pattern cell's bounding box. These boundaries shall be used to clip the pattern cell.

Returns: pattern cell's bounding box.

◆ GetResources()

virtual PdfResources iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.GetResources ( )

inlinevirtual

Gets the Tiling Pattern's resources.

Returns: the Tiling Pattern's resources

◆ GetTilingType()

virtual int iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.GetTilingType ( )

inlinevirtual

Gets the tiling type.

Returns: int value of TilingType

◆ GetXStep()

virtual float iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.GetXStep ( )

inlinevirtual

Gets the desired horizontal space between pattern cells.

Returns: the desired horizontal space between pattern cells

◆ GetYStep()

virtual float iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.GetYStep ( )

inlinevirtual

Gets the desired vertical space between pattern cells.

Returns: the desired vertical space between pattern cells

◆ IsColored()

virtual bool iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.IsColored ( )

inlinevirtual

Checks if this pattern have colored paint type.

Returns

true if this pattern's paint type is PaintType.COLORED and false otherwise.

◆ SetBBox()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.SetBBox ( Rectangle bbox )

inlinevirtual

Sets the pattern cell's bounding box.

Sets the pattern cell's bounding box. These boundaries shall be used to clip the pattern cell.

Parameters

bbox	pattern cell's bounding box to set.

◆ SetColored()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.SetColored ( bool colored )

inlinevirtual

Sets the paint type.

Parameters

colored if true then the paint type will be set as PaintType.COLORED , and PaintType.UNCOLORED otherwise.

◆ SetTilingType()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.SetTilingType ( int tilingType )

inlinevirtual

Sets the tiling type.

Parameters

tilingType int value of TilingType to set.

◆ SetXStep()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.SetXStep ( float xStep )

inlinevirtual

Sets the desired horizontal space between pattern cells.

Parameters

xStep the desired horizontal space between pattern cells

◆ SetYStep()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.SetYStep ( float yStep )

inlinevirtual

Sets the desired vertical space between pattern cells.

Parameters

yStep the desired vertical space between pattern cells

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Tiling() [1/9]

◆ Tiling() [2/9]

◆ Tiling() [3/9]

◆ Tiling() [4/9]

◆ Tiling() [5/9]

◆ Tiling() [6/9]

◆ Tiling() [7/9]

◆ Tiling() [8/9]

◆ Tiling() [9/9]

Member Function Documentation

◆ Flush()

◆ GetBBox()

◆ GetResources()

◆ GetTilingType()

◆ GetXStep()

◆ GetYStep()

◆ IsColored()

◆ SetBBox()

◆ SetColored()

◆ SetTilingType()

◆ SetXStep()

◆ SetYStep()