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:

Serializable, Comparable<BackgroundRepeat.BackgroundRepeatValue>, java.lang.constant.Constable

Enclosing class:

BackgroundRepeat

       public static enum BackgroundRepeat.BackgroundRepeatValue extends Enum<BackgroundRepeat.BackgroundRepeatValue>
      

Defines all possible background repeat values for one axis.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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.

Method Summary

Modifier and Type	Method	Description
static BackgroundRepeat.BackgroundRepeatValue	valueOf(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.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

             public static BackgroundRepeat.BackgroundRepeatValue[] values()
            

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

             public static BackgroundRepeat.BackgroundRepeatValue valueOf
             (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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null