Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.graphics.form

public final Class PDTransparencyGroupAttributes

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
java.io.IOException, org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.PDResources, org.apache.pdfbox.pdmodel.common.COSObjectable, org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace

Transparency group attributes.
Author
Kühn & Weyh Software GmbH

Field Summary

Modifier and TypeField and Description
private PDColorSpace
private final COSDictionary

Constructor Summary

AccessConstructor and Description
public
PDTransparencyGroupAttributes()

Creates a group object with /Transparency subtype entry.

public
PDTransparencyGroupAttributes(COSDictionary dic)

Creates a group object from a given dictionary

Method Summary

Modifier and TypeMethod and Description
public PDColorSpace

Returns:

the group color space.
getColorSpace
()

Returns the group color space or null if it isn't defined.

public PDColorSpace

Returns:

the group color space.
getColorSpace
(PDResources
useful for its cache. Can be null.
resources
)

Returns the group color space or null if it isn't defined.

public COSDictionary
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public boolean

Returns:

true if this group is isolated
isIsolated
()

Returns true if this group is isolated.

public boolean

Returns:

true if this group is a knockout
isKnockout
()

Returns true if this group is a knockout.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

colorSpaceback to summary
private PDColorSpace colorSpace
dictionaryback to summary
private final COSDictionary dictionary

Constructor Detail

PDTransparencyGroupAttributesback to summary
public PDTransparencyGroupAttributes()

Creates a group object with /Transparency subtype entry.

PDTransparencyGroupAttributesback to summary
public PDTransparencyGroupAttributes(COSDictionary dic)

Creates a group object from a given dictionary

Parameters
dic:COSDictionary

COSDictionary object

Method Detail

getColorSpaceback to summary
public PDColorSpace getColorSpace() throws IOException

Returns the group color space or null if it isn't defined.

Returns:PDColorSpace

the group color space.

Exceptions
IOException:
if the colorspace could not be created
getColorSpaceback to summary
public PDColorSpace getColorSpace(PDResources resources) throws IOException

Returns the group color space or null if it isn't defined.

Parameters
resources:PDResources

useful for its cache. Can be null.

Returns:PDColorSpace

the group color space.

Exceptions
IOException:
if the colorspace could not be created
getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Doc from org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
isIsolatedback to summary
public boolean isIsolated()

Returns true if this group is isolated. Isolated groups begin with the fully transparent image, non-isolated begin with the current backdrop.

Returns:boolean

true if this group is isolated

isKnockoutback to summary
public boolean isKnockout()

Returns true if this group is a knockout. A knockout group blends with original backdrop, a non-knockout group blends with the current backdrop.

Returns:boolean

true if this group is a knockout