com.cete.dynamicpdf.pageelements
Class AreaGroup

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

All Implemented Interfaces:

IArea, ICoordinate, IPageElementContainer

public class AreaGroup
extends Group
implements IArea, ICoordinate

This class can be used to collect many page elements together and add them to the page all at once. Every page element that you add to the group will be added to the page when the group is added to the page.

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

Constructor Summary

AreaGroup(float width, float height)
Initializes a new instance of the AreaGroup class.

Method Summary

float	getHeight() Gets the height of the area group.
float	getWidth() Gets the width of the area group.
float	getX() Gets the X coordinate of the area group.
float	getY() Gets the Y coordinate of the area group.
void	setHeight(float height) Sets the height of the area group.
void	setWidth(float width) Sets the width of the area group.
void	setX(float x) Sets the X coordinate of the area group.
void	setY(float y) Sets the Y coordinate of the area group.

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

add, draw, 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

AreaGroup

public AreaGroup(float width,
                 float height)

Initializes a new instance of the AreaGroup class.

Parameters:

width - Width of the area group.

height - Height of the area group.

Method Detail

getX

public float getX()

Gets the X coordinate of the area group.

Specified by:

getX in interface ICoordinate

Returns:

float X coordinate of the area group.

setX

public void setX(float x)

Sets the X coordinate of the area group.

Specified by:

setX in interface ICoordinate

Throws:

GeneratorException - If X be set to an Area Group.

Parameters:

x - float X coordinate of the area group.

getY

public float getY()

Gets the Y coordinate of the area group.

Specified by:

getY in interface ICoordinate

Returns:

float Y coordinate of the area group.

setY

public void setY(float y)

Sets the Y coordinate of the area group.

Specified by:

setY in interface ICoordinate

Throws:

GeneratorException - If Y be set to an Area Group.

Parameters:

y - float Y coordinate of the area group.

getWidth

public float getWidth()

Gets the width of the area group.

Specified by:

getWidth in interface IArea

Returns:

float width of the area group.

setWidth

public void setWidth(float width)

Sets the width of the area group.

Specified by:

setWidth in interface IArea

Parameters:

width - float width of the area group.

getHeight

public float getHeight()

Gets the height of the area group.

Specified by:

getHeight in interface IArea

Returns:

float height of the area group.

setHeight

public void setHeight(float height)

Sets the height of the area group.

Specified by:

setHeight in interface IArea

Parameters:

height - float height of the area group.