Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]
public class

# PatternColor

extends Object

java.lang.Object
↳ | com.pdftron.pdf.PatternColor

## Class Overview

Patterns are quite general, and have many uses; for example, they can be used to create various graphical textures, such as weaves, brick walls, sunbursts, and similar geometrical and chromatic effects. Patterns are specified in a special family of color spaces named Pattern, whose 'color values' are PatternColor objects instead of the numeric component values used with other spaces. Therefore PatternColor is to pattern color space what is ColorPt to all other color spaces. A tiling pattern consists of a small graphical figure called a pattern cell. Painting with the pattern replicates the cell at fixed horizontal and vertical intervals to fill an area. The effect is as if the figure were painted on the surface of a clear glass tile, identical copies of which were then laid down in an array covering the area and trimmed to its boundaries. This is called tiling the 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 order in which individual tiles (instances of the cell) are painted is unspecified and unpredictable; it is inadvisable for the figures on adjacent tiles to overlap.

## Summary

Constants
int | e_colored_tiling_pattern | The Constant e_colored_tiling_pattern.
int | e_constant_spacing | The Constant e_constant_spacing.
int | e_constant_spacing_fast_fill | The Constant e_constant_spacing_fast_fill.
int | e_no_distortion | The Constant e_no_distortion.
int | e_null | The Constant e_null.
int | e_shading | The Constant e_shading.
int | e_uncolored_tiling_pattern | The Constant e_uncolored_tiling_pattern.

Public Constructors
| PatternColor(Obj pattern) Create a PatternColor from the given SDF/Cos object listed under Pattern entry in page Resource dictionary.

Public Methods
Rect | getBBox() Get the bounding box.
Matrix2D | getMatrix() Get the matrix.
Obj | getSDFObj() Get the SDFObj.
Shading | getShading() Get the shading pattern's gradient fill.
int | getTilingType() Get the PatternColor tiling type.
int | getType() Get the PatternColor type.
static int | getType(Obj pattern) Get the type from given PatternColor
double | getXStep() Get the horizontal spacing between pattern cells Note: that XStep and YStep may differ from the dimensions of the pattern cell implied by the BBox entry.
double | getYStep() Get the vertical spacing between pattern cells Note: for patterns other than Tiling this method throws an exception.

[Expand] Inherited Methods
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Constants

#### public static final int e_colored_tiling_pattern

The Constant e_colored_tiling_pattern.

Constant Value: 1 (0x00000001)

#### public static final int e_constant_spacing

The Constant e_constant_spacing.

Constant Value: 0 (0x00000000)

#### public static final int e_constant_spacing_fast_fill

The Constant e_constant_spacing_fast_fill.

Constant Value: 2 (0x00000002)

#### public static final int e_no_distortion

The Constant e_no_distortion.

Constant Value: 1 (0x00000001)

#### public static final int e_null

The Constant e_null.

Constant Value: 3 (0x00000003)

#### public static final int e_shading

The Constant e_shading.

Constant Value: 2 (0x00000002)

#### public static final int e_uncolored_tiling_pattern

The Constant e_uncolored_tiling_pattern.

Constant Value: 0 (0x00000000)

## Public Constructors

#### public PatternColor (Obj pattern)

Create a PatternColor from the given SDF/Cos object listed under Pattern entry in page Resource dictionary.

##### Parameters

pattern | the pattern

## Public Methods

#### public Rect getBBox ()

Get the bounding box.

Note: for patterns other than Tiling this method throws an exception.

##### Returns

- A rectangle in the pattern coordinate system giving the coordinates of the left, bottom, right, and top edges, respectively, of the pattern cell's bounding box. These boundaries are used to clip the pattern cell.

##### Throws

PDFNetException |

#### public Matrix2D getMatrix ()

Get the matrix.

##### Returns

- pattern matrix, a transformation matrix that maps the pattern's internal coordinate system to the default coordinate system of the pattern's parent content stream (the content stream in which the pattern is defined as a resource). The concatenation of the pattern matrix with that of the parent content stream establishes the pattern coordinate space, within which all graphics objects in the pattern are interpreted.

##### Throws

PDFNetException |

#### public Obj getSDFObj ()

Get the SDFObj.

##### Returns

- the underlying SDF/Cos object

##### Throws

PDFNetException |

#### public Shading getShading ()

Get the shading pattern's gradient fill.

Note: for patterns other than Shading this method throws an exception.

##### Returns

- The shading object defining the shading pattern's gradient fill.

##### Throws

PDFNetException |

#### public int getTilingType ()

Get the PatternColor tiling type.

Note: for patterns other than Tiling this method throws an exception.

##### Returns

- the tiling type identifier that controls adjustments to the spacing of tiles relative to the device pixel grid:

##### Throws

PDFNetException |

#### public int getType ()

Get the PatternColor type.

##### Returns

- the PatternColor type

##### Throws

PDFNetException |

#### public static int getType (Obj pattern)

Get the type from given PatternColor

##### Parameters

pattern | the given PatternColor

##### Returns

- The Type of a given SDF/Cos color space, or e_null for if SDF object is not a valid pattern object

##### Throws

PDFNetException |

#### public double getXStep ()

Get the horizontal spacing between pattern cells

Note: that XStep and YStep may differ from the dimensions of the pattern cell implied by the BBox entry. This allows tiling with irregularly shaped figures. XStep and YStep may be either positive or negative, but not zero.

Note: for patterns other than Tiling this method throws an exception.

##### Returns

- the desired horizontal spacing between pattern cells, measured in the pattern coordinate system.

##### Throws

PDFNetException |

#### public double getYStep ()

Get the vertical spacing between pattern cells

Note: for patterns other than Tiling this method throws an exception.

##### Returns

- the desired vertical spacing between pattern cells, measured in the pattern coordinate system.

##### Throws

PDFNetException |