Package com.itextpdf.layout.properties
Enum BackgroundRepeat.BackgroundRepeatValue
- java.lang.Object
-
- java.lang.Enum<BackgroundRepeat.BackgroundRepeatValue>
-
- com.itextpdf.layout.properties.BackgroundRepeat.BackgroundRepeatValue
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<BackgroundRepeat.BackgroundRepeatValue>
- Enclosing class:
- BackgroundRepeat
public static enum BackgroundRepeat.BackgroundRepeatValue extends java.lang.Enum<BackgroundRepeat.BackgroundRepeatValue>
Defines all possible background repeat values for one axis.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description NO_REPEAT
The no repeat value which mean that the background will not be repeated, but displayed once with its original size.REPEAT
The repeat value which means that the background with its original size will be repeated over the entire available space.ROUND
The round value which mean that the background will stretch or compress.SPACE
The space value which means that the background will be repeated as much as possible with its original size and without cropping.
-
Constructor Summary
Constructors Modifier Constructor Description private
BackgroundRepeatValue()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static BackgroundRepeat.BackgroundRepeatValue
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static BackgroundRepeat.BackgroundRepeatValue[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NO_REPEAT
public static final BackgroundRepeat.BackgroundRepeatValue NO_REPEAT
The no repeat value which mean that the background will not be repeated, but displayed once with its original size.
-
REPEAT
public static final BackgroundRepeat.BackgroundRepeatValue REPEAT
The repeat value which means that the background with its original size will be repeated over the entire available space.
-
ROUND
public static final BackgroundRepeat.BackgroundRepeatValue ROUND
The round value which mean that the background will stretch or compress. Initially, the available space is divided by module by the size of the background, if the result is less than half the size of the background, then the background is stretched in such a way that when it is repeated it will take up all the space, otherwise the background is compressed to fit one more background in the available space.
-
SPACE
public static final BackgroundRepeat.BackgroundRepeatValue SPACE
The space value which means that the background will be repeated as much as possible with its original size and without cropping. the first and last backgrounds are attached to opposite edges of the available space, and the whitespaces are evenly distributed between the backgrounds.
-
-
Method Detail
-
values
public static BackgroundRepeat.BackgroundRepeatValue[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (BackgroundRepeat.BackgroundRepeatValue c : BackgroundRepeat.BackgroundRepeatValue.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static BackgroundRepeat.BackgroundRepeatValue valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-