Package com.itextpdf.kernel.colors.gradients

Enum GradientColorStop.OffsetType

java.lang.Object

java.lang.Enum<GradientColorStop.OffsetType>

com.itextpdf.kernel.colors.gradients.GradientColorStop.OffsetType

All Implemented Interfaces:

Serializable, Comparable<GradientColorStop.OffsetType>, java.lang.constant.Constable

Enclosing class:

GradientColorStop

       public static enum GradientColorStop.OffsetType extends Enum<GradientColorStop.OffsetType>
      

Represents the possible offset type

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
ABSOLUTE	The absolute offset value from the target coordinates vector's start
AUTO	The automatic offset evaluation.
RELATIVE	The relative offset value to the target coordinates vector.

Method Summary

Modifier and Type	Method	Description
static GradientColorStop.OffsetType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GradientColorStop.OffsetType[]	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

ABSOLUTE

             public static final GradientColorStop.OffsetType ABSOLUTE
            

The absolute offset value from the target coordinates vector's start

AUTO

             public static final GradientColorStop.OffsetType AUTO
            

The automatic offset evaluation. The offset value should be evaluated automatically based on the whole stop colors list specified for the gradient. The general auto offset logic should be the next: - find the previous and the next specified offset or hint offset values - the sublist of sequent auto offsets should spread evenly between the found values

RELATIVE

             public static final GradientColorStop.OffsetType RELATIVE
            

The relative offset value to the target coordinates vector. The 0 value means the target vector start, the 1 value means the target vector end.

Method Details

values

             public static GradientColorStop.OffsetType[] 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 GradientColorStop.OffsetType 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