com.cete.dynamicpdf
Class PageElement

java.lang.Object
  com.cete.dynamicpdf.PageElement

Direct Known Subclasses:

Bookmark, Group, ImportedPageArea, ImportedPageData, LayoutGrid, TaggablePageElement

public abstract class PageElement
extends java.lang.Object

Base class from which all page elements are derived.

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

Constructor Summary

protected

PageElement() Initializes a new instance of the PageElement class.

Method Summary

abstract void	draw(PageWriter writer) Draws the page element to the given PageWriter class.
boolean	getIgnoreMargins() Gets ignore margin property.
RelativeTo	getRelativeTo() Gets placement of the page element on the page.
java.lang.String	getStrID() Gets the ID of the page element.
void	setIgnoreMargins(boolean value) Sets ignore margin property.
void	setRelativeTo(RelativeTo value) Sets placement of the page element on the page.
protected void	setRequiredLicenseLevel(int level) Sets the required license level.
void	setStrID(java.lang.String strID) Sets the ID of the page element.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageElement

protected PageElement()

Initializes a new instance of the PageElement class.

Method Detail

setStrID

public void setStrID(java.lang.String strID)

Sets the ID of the page element.

Parameters:

strID - the String value indicating the ID of the page element.

getStrID

public java.lang.String getStrID()

Gets the ID of the page element.

Returns:

the String value which indicates the ID of the page element.

getRelativeTo

public RelativeTo getRelativeTo()

Gets placement of the page element on the page.

Returns:

placement of the page element on the page.

setRelativeTo

public void setRelativeTo(RelativeTo value)

Sets placement of the page element on the page.

Parameters:

value - placement of the page element on the page.

getIgnoreMargins

public boolean getIgnoreMargins()

Gets ignore margin property. Setting false will consider the margin while placing the page element based on the RelativeTo property.

Returns:

ignore margin property.

setIgnoreMargins

public void setIgnoreMargins(boolean value)

Sets ignore margin property. Setting false will consider the margin while placing the page element based on the RelativeTo property.

Parameters:

value - ignore margin property.

draw

public abstract void draw(PageWriter writer)

Draws the page element to the given PageWriter class.

Parameters:

writer - the PageWriter class to receive the page elements output.

See Also:

PageWriter

setRequiredLicenseLevel

protected void setRequiredLicenseLevel(int level)

Sets the required license level.

Parameters:

level - the int value indicating the license level.