# org.pdfclown.documents.contents.colorSpaces.ShadingPattern Class Reference

Pattern providing a smooth transition between colors across an area to be painted [PDF:1.6:4.6.3]. More...

Inheritance diagram for org.pdfclown.documents.contents.colorSpaces.ShadingPattern:

List of all members.

## Public Member Functions
virtual object | Clone (Document context)
| Gets a clone of the object, registered inside the given document context.
override object | Clone (Document context)
virtual bool | Delete ()
| Removes the object from its document context.
override bool | Equals (object obj)
override int | GetHashCode ()
## Static Public Member Functions
static PdfDirectObject | GetBaseObject (PdfObjectWrapper wrapper)
| Gets the PDF object backing the specified wrapper.
static Pattern | Wrap (PdfDirectObject baseObject)
| Wraps the specified base object into a pattern object.
## Static Public Attributes
static readonly Pattern | Default = new TilingPattern(null)
## Protected Member Functions
void | CheckCompatibility (object feature)
| Checks whether the specified feature is compatible with the document's conformance version.
virtual PdfString | RetrieveName ()
| Retrieves the name possibly associated to this object, walking through the document's name dictionary.
PdfDirectObject | RetrieveNamedBaseObject ()
| Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
## Static Protected Member Functions
static double | NormalizeComponent (double value)
| Gets the normalized value of a color component [PDF:1.6:4.5.1].
## Properties
virtual PdfDirectObject | BaseObject`[get, set]`
ColorSpace | ColorSpace`[get]`
override IList< PdfDirectObject > | Components`[get]`
| Gets the components defining this color value.
PdfIndirectObject | Container`[get]`
| Gets the indirect object containing the base object.
PdfIndirectObject | DataContainer`[get]`
| Gets the indirect object containing the base data object.
PdfDictionary | Dictionary`[get]`
| Gets this pattern's dictionary.
Document | Document`[get]`
| Gets the document context.
ExtGState | ExtGState`[get]`
| Gets the graphics state parameters to be put into effect temporarily while the shading pattern is painted.
File | File`[get]`
| Gets the file context.
double[] | Matrix`[get]`
| Gets the 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).
Shading | Shading`[get]`
| Gets a shading object defining the shading pattern's gradient fill.

##

Pattern providing a smooth transition between colors across an area to be painted [PDF:1.6:4.6.3].

The transition is continuous and independent of the resolution of any particular output device.

## Member Function Documentation

void org.pdfclown.objects.PdfObjectWrapper.CheckCompatibility | ( | object | feature | ) | `[protected, inherited]`

Checks whether the specified feature is compatible with the document's conformance version.

Parameters:

  | feature | Entity whose compatibility has to be checked. Supported types: VersionEnum Property name resolvable to an annotated getter method MemberInfo

virtual object org.pdfclown.objects.PdfObjectWrapper.Clone | ( | Document | context | ) | `[virtual, inherited]`

Gets a clone of the object, registered inside the given document context.

Parameters:

  | context | Which document the clone has to be registered in.

override object org.pdfclown.documents.contents.colorSpaces.Pattern.Clone | ( | Document | context | ) | `[inherited]`

virtual bool org.pdfclown.objects.PdfObjectWrapper.Delete | ( |  | ) | `[virtual, inherited]`

Removes the object from its document context.

The object is no more usable after this method returns.

Returns:
  Whether the object was actually decontextualized (only indirect objects can be decontextualize).

override bool org.pdfclown.objects.PdfObjectWrapper.Equals | ( | object | obj | ) | `[inherited]`

Reimplemented in org.pdfclown.documents.contents.colorSpaces.LeveledColor.

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject | ( | PdfObjectWrapper< PdfDataObject > | wrapper | ) | `[static, inherited]`

Gets the PDF object backing the specified wrapper.

Parameters:

  | wrapper | Object to extract the base from.

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode | ( |  | ) | `[inherited]`

Reimplemented in org.pdfclown.documents.contents.colorSpaces.LeveledColor.

static double org.pdfclown.documents.contents.colorSpaces.Color.NormalizeComponent | ( | double | value | ) | `[static, protected, inherited]`

Gets the normalized value of a color component [PDF:1.6:4.5.1].

Parameters:

  | value | Color component value to normalize.

Returns:
  Normalized color component value.

virtual PdfString org.pdfclown.objects.PdfObjectWrapper.RetrieveName | ( |  | ) | `[protected, virtual, inherited]`

Retrieves the name possibly associated to this object, walking through the document's name dictionary.

PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject | ( |  | ) | `[protected, inherited]`

Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.

static Pattern org.pdfclown.documents.contents.colorSpaces.Pattern.Wrap | ( | PdfDirectObject | baseObject | ) | `[static, inherited]`

Wraps the specified base object into a pattern object.

Parameters:

  | baseObject | Base object of a pattern object.

Returns:
  Pattern object corresponding to the base object.

References org.pdfclown.objects.PdfObject.Resolve().

## Member Data Documentation

readonly Pattern org.pdfclown.documents.contents.colorSpaces.Pattern.Default = new TilingPattern(null)`[static, inherited]`

## Property Documentation

virtual PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.BaseObject`[get, set, inherited]`

Gets the underlying reference object, if available; otherwise, gets the underlying data object.

ColorSpace org.pdfclown.documents.contents.colorSpaces.Color.ColorSpace`[get, inherited]`

override IList<PdfDirectObject> org.pdfclown.documents.contents.colorSpaces.Pattern.Components`[get, inherited]`

Gets the components defining this color value.

Reimplemented from org.pdfclown.documents.contents.colorSpaces.Color.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container`[get, inherited]`

Gets the indirect object containing the base object.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer`[get, inherited]`

Gets the indirect object containing the base data object.

PdfDictionary org.pdfclown.documents.contents.colorSpaces.Pattern.Dictionary`[get, protected, inherited]`

Gets this pattern's dictionary.

Document org.pdfclown.objects.PdfObjectWrapper.Document`[get, inherited]`

Gets the document context.

ExtGState org.pdfclown.documents.contents.colorSpaces.ShadingPattern.ExtGState`[get]`

Gets the graphics state parameters to be put into effect temporarily while the shading pattern is painted.

Any parameters that are not so specified are inherited from the graphics state that was in effect at the beginning of the content stream in which the pattern is defined as a resource.

File org.pdfclown.objects.PdfObjectWrapper.File`[get, inherited]`

Gets the file context.

double [] org.pdfclown.documents.contents.colorSpaces.Pattern.Matrix`[get, inherited]`

Gets the 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.

Shading org.pdfclown.documents.contents.colorSpaces.ShadingPattern.Shading`[get]`

Gets a shading object defining the shading pattern's gradient fill.

Copyright 2006-2013 Stefano Chizzolini. For more information, please visit PDF Clown home page.