com.cete.dynamicpdf
Class Artifact

java.lang.Object
  com.cete.dynamicpdf.Resource
      com.cete.dynamicpdf.Tag
          com.cete.dynamicpdf.Artifact

public class Artifact
extends Tag

Represents an artifact.

Licensing:
This class is a DynamicPDF Generator Enterprise 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

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

Artifact(ArtifactType type, Attached attached)
Initializes a new instance of the Artifact class.

Artifact(ArtifactType type, Attached attached, SubType subType)
Initializes a new instance of the Artifact class.

Artifact(ArtifactType type, BoundingBox bBox, Attached attached, SubType subType)
Initializes a new instance of the Artifact class.

Artifact(ArtifactType type, SubType subType)
Initializes a new instance of the Artifact class.

Artifact(BoundingBox bBox)
Initializes a new instance of the Artifact class.

Method Summary

void	draw(DocumentWriter writer) Draws the artifact to the given DocumentWriter object.
TagType	getTagType() Gets a TagType value indicating artifact tag.
void	setAttached(Attached attached) Sets a Attached to the Artifact.
void	setBoundingBox() Sets a BoundingBox Attribute to the Artifact with default value.
void	setBoundingBox(BoundingBox boundingBox) Sets a BoundingBox to the Artifact.
void	setSubType(SubType subType) Sets a SubType to the Artifact.
void	setType(ArtifactType type) Sets a ArtifactType to the Artifact.

Methods inherited from class com.cete.dynamicpdf.Tag

getAnnotation, getArticle, getArtifact, getBibliographyEntry, getBlockQuotation, getCaption, getCode, getDivision, getDocument, getFigure, getForm, getFormula, getHeading, getHeadingLevel1, getHeadingLevel2, getHeadingLevel3, getHeadingLevel4, getHeadingLevel5, getHeadingLevel6, getIndex, getLabel, getLink, getList, getListBody, getListItem, getNonStructuralElement, getNote, getParagraph, getPart, getPrivate, getQuotation, getReference, getRuby, getSection, getSpan, getTable, getTableBodyRowGroup, getTableDataCell, getTableFooterRowGroup, getTableHeader, getTableHeaderRowGroup, getTableOfContent, getTableOfContentItem, getTableRow, getWarichu

Methods inherited from class com.cete.dynamicpdf.Resource

getRequiredPdfObjects, getResourceType, getUid, newUid

Methods inherited from class java.lang.Object

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

Constructor Detail

Artifact

public Artifact()

Initializes a new instance of the Artifact class.

Artifact

public Artifact(BoundingBox bBox)

Initializes a new instance of the Artifact class.

Parameters:

bBox - Bounding box of the artifact.

Artifact

public Artifact(ArtifactType type,
                Attached attached)

Initializes a new instance of the Artifact class.

Parameters:

type - Type of artifact.

attached - A value indicating to which the artifact is logically attached.

Artifact

public Artifact(ArtifactType type,
                SubType subType)

Initializes a new instance of the Artifact class.

Parameters:

type - Type of artifact.

subType - Sub type of the artifact.

Artifact

public Artifact(ArtifactType type,
                Attached attached,
                SubType subType)

Initializes a new instance of the Artifact class.

Parameters:

type - Type of artifact.

attached - A value indicating to which the artifact is logically attached.

subType - Sub type of the artifact.

Artifact

public Artifact(ArtifactType type,
                BoundingBox bBox,
                Attached attached,
                SubType subType)

Initializes a new instance of the Artifact class.

Parameters:

type - Type of artifact.

bBox - Bounding box of the artifact.

attached - A value indicating to which the artifact is logically attached.

subType - Sub type of the artifact.

Method Detail

setType

public void setType(ArtifactType type)

Sets a ArtifactType to the Artifact.

Parameters:

type - Value of Type.

setBoundingBox

public void setBoundingBox(BoundingBox boundingBox)

Sets a BoundingBox to the Artifact.

Parameters:

boundingBox - Value of BoundingBox.

setBoundingBox

public void setBoundingBox()

Sets a BoundingBox Attribute to the Artifact with default value.

setAttached

public void setAttached(Attached attached)

Sets a Attached to the Artifact.

Parameters:

attached - Value of Attached.

setSubType

public void setSubType(SubType subType)

Sets a SubType to the Artifact.

Parameters:

subType - Value of SubType.

getTagType

public TagType getTagType()

Gets a TagType value indicating artifact tag.

Specified by:

getTagType in class Tag

Returns:

a artifact tagtype.

draw

public void draw(DocumentWriter writer)

Draws the artifact to the given DocumentWriter object.

Specified by:

draw in class Resource

Parameters:

writer - DocumentWriter object to receive the artifact's output.

See Also:

DocumentWriter