com.itextpdf.layout.property

Class BackgroundRepeat

java.lang.Object

com.itextpdf.layout.property.BackgroundRepeat

public class BackgroundRepeat
extends Object

Class to hold background-repeat property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackgroundRepeat.BackgroundRepeatValue Defines all possible background repeat values for one axis.

Constructor Summary

Constructors

Constructor and Description
BackgroundRepeat() Creates a new BackgroundRepeat instance.
BackgroundRepeat(BackgroundRepeat.BackgroundRepeatValue repeat) Creates a new BackgroundRepeat instance based on one BackgroundRepeat instance.
BackgroundRepeat(BackgroundRepeat.BackgroundRepeatValue xAxisRepeat, BackgroundRepeat.BackgroundRepeatValue yAxisRepeat) Creates a new BackgroundRepeat instance based on two BackgroundRepeat instance.

Method Summary

Modifier and Type	Method and Description
BackgroundRepeat.BackgroundRepeatValue	getXAxisRepeat() Gets the BackgroundRepeat.BackgroundRepeatValue value for X axis.
BackgroundRepeat.BackgroundRepeatValue	getYAxisRepeat() Gets the BackgroundRepeat.BackgroundRepeatValue value for Y axis.
boolean	isNoRepeatOnXAxis() Checks whether the BackgroundRepeat.BackgroundRepeatValue.NO_REPEAT value is set on X axis or not.
boolean	isNoRepeatOnYAxis() Checks whether the BackgroundRepeat.BackgroundRepeatValue.NO_REPEAT value is set on Y axis or not.
Point	prepareRectangleToDrawingAndGetWhitespace(Rectangle imageRectangle, Rectangle backgroundArea, BackgroundSize backgroundSize) Prepares the image rectangle for drawing.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundRepeat

public BackgroundRepeat()

Creates a new BackgroundRepeat instance. The axis will have the value BackgroundRepeat.BackgroundRepeatValue.REPEAT.

BackgroundRepeat

public BackgroundRepeat(BackgroundRepeat.BackgroundRepeatValue repeat)

Creates a new BackgroundRepeat instance based on one BackgroundRepeat instance.

Parameters:

repeat - the repeat value that will be set for for both axes

BackgroundRepeat

public BackgroundRepeat(BackgroundRepeat.BackgroundRepeatValue xAxisRepeat,
                        BackgroundRepeat.BackgroundRepeatValue yAxisRepeat)

Creates a new BackgroundRepeat instance based on two BackgroundRepeat instance.

Parameters:

xAxisRepeat - the repeat value that will be set for for X axis

yAxisRepeat - the repeat value that will be set for for Y axis

Method Detail

getXAxisRepeat

public BackgroundRepeat.BackgroundRepeatValue getXAxisRepeat()

Gets the BackgroundRepeat.BackgroundRepeatValue value for X axis.

Returns:

the repeat value for X axis.

getYAxisRepeat

public BackgroundRepeat.BackgroundRepeatValue getYAxisRepeat()

Gets the BackgroundRepeat.BackgroundRepeatValue value for Y axis.

Returns:

the repeat value for Y axis.

isNoRepeatOnXAxis

public boolean isNoRepeatOnXAxis()

Checks whether the BackgroundRepeat.BackgroundRepeatValue.NO_REPEAT value is set on X axis or not.

Returns:

is the X axis have BackgroundRepeat.BackgroundRepeatValue.NO_REPEAT value

isNoRepeatOnYAxis

public boolean isNoRepeatOnYAxis()

Checks whether the BackgroundRepeat.BackgroundRepeatValue.NO_REPEAT value is set on Y axis or not.

Returns:

is the Y axis have BackgroundRepeat.BackgroundRepeatValue.NO_REPEAT value

prepareRectangleToDrawingAndGetWhitespace

public Point prepareRectangleToDrawingAndGetWhitespace(Rectangle imageRectangle,
                                                       Rectangle backgroundArea,
                                                       BackgroundSize backgroundSize)

Prepares the image rectangle for drawing. This means that the size and position of the image rectangle will be changed to match the BackgroundRepeat.BackgroundRepeatValue values for the axes.

Parameters:

imageRectangle - the image rectangle which will be changed

backgroundArea - the background available area

backgroundSize - the image background size property

Returns:

the necessary whitespace between backgrounds