com.cete.dynamicpdf.pageelements
Class TransparencyGroup

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.Group
          com.cete.dynamicpdf.pageelements.TransparencyGroup

All Implemented Interfaces:

IPageElementContainer

public class TransparencyGroup
extends Group

This class can be used to add transparency to page elements. Any page element that is placed in this group will be displayed with the transparency values and attributes of this group.

Licensing:
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

View Example

Nested Class Summary

static class

TransparencyGroup.Transparency

Constructor Summary

TransparencyGroup(float alpha)
Initializes a new instance of the TransparencyGroup class.

TransparencyGroup(float alpha, BlendMode blendMode)
Initializes a new instance of the TransparencyGroup.

Method Summary

void	draw(PageWriter writer) Draws the transparency group to the given PageWriter object.
BlendMode	getBlendMode() Gets the blend mode value.
float	getFillAlpha() Gets the fill alpha value.
float	getStrokeAlpha() Gets the stroke alpha value.
void	setBlendMode(BlendMode value) Sets the blend mode value.
void	setFillAlpha(float value) Sets the Fill alpha value.
void	setStrokeAlpha(float value) Sets the stroke value.

Methods inherited from class com.cete.dynamicpdf.pageelements.Group

add, getEnumerator, getPageElement, getPageElement, getPageElementByID, hasElements, hasPageElements, insert, size

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransparencyGroup

public TransparencyGroup(float alpha)

Initializes a new instance of the TransparencyGroup class. An alpha value of 0 represents full transparency meaning the page elements will not be visible. An alpha value of 1 means the page elements will have no transparency.

Parameters:

alpha - amount of transparency the group will have.

TransparencyGroup

public TransparencyGroup(float alpha,
                         BlendMode blendMode)

Initializes a new instance of the TransparencyGroup. An alpha value of 0 represents full transparency meaning the page elements will not be visible. An alpha value of 1 means the page elements will have no transparency.

Parameters:

alpha - amount of transparency the group will have.

blendMode - BlendMode to use for the transparency group.

Method Detail

draw

public void draw(PageWriter writer)

Draws the transparency group to the given PageWriter object.

Overrides:

draw in class Group

Parameters:

writer - PageWriter object to receive the transparency group's output.

See Also:

PageWriter

getStrokeAlpha

public float getStrokeAlpha()

Gets the stroke alpha value.

Returns:

the stroke alpha value.

setStrokeAlpha

public void setStrokeAlpha(float value)

Sets the stroke value.

Parameters:

value - the stroke value.

getFillAlpha

public float getFillAlpha()

Gets the fill alpha value.

Returns:

the Fill alpha value.

setFillAlpha

public void setFillAlpha(float value)

Sets the Fill alpha value.

Parameters:

value - the Fill alpha value.

getBlendMode

public BlendMode getBlendMode()

Gets the blend mode value.

Returns:

the blend mode value.

See Also:

BlendMode

setBlendMode

public void setBlendMode(BlendMode value)

Sets the blend mode value.

Parameters:

value - the blend mode value.

See Also:

BlendMode