com.cete.dynamicpdf
Class StructureElement

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

public class StructureElement
extends Tag

Represents a structure element.

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

StructureElement(TagType tag)
Initializes a new instance of the StructureElement class.

StructureElement(TagType tag, boolean includeDefaultAttributes)
Initializes a new instance of the StructureElement class.

Method Summary

void	draw(DocumentWriter writer) Draws the structure element to the given DocumentWriter object.
java.lang.String	getAbbreviation() Gets a value indicating expandable form of an abbreviation.
java.lang.String	getActualText() Gets a value indicating the text that is exact replacement for the structure element.
java.lang.String	getAlternateText() Gets a value indicating alternate description of the structure element.
AttributeTypeList	getAttributeLists() Gets an AttributeTypeList to which AttributeObject to be added.
AttributeClassList	getClasses() Gets an AttributeClassList to which AttributeClass to be added.
java.lang.String	getIdentifier() Gets a value indicating identifier for the structure element.
boolean	getIncludeDefaultAttributes() Gets a value indicating default attributes to be include.
java.lang.String	getLanguage() Gets a value indicating natural language for all text in the structure element.
int	getOrder() Gets a value indicating the order in its parent structure element or structure tree root.
StructureElement	getParent() Gets a value indicating parent structure element.
TagType	getTagType() Gets a value indicating standard structure type or named structure type.
java.lang.String	getTitle() Gets a value indicating title of structure element.
void	setAbbreviation(java.lang.String abbreviation) Sets a value indicating expandable form of an abbreviation.
void	setActualText(java.lang.String actualText) Sets a value indicating the text that is exact replacement for the structure element.
void	setAlternateText(java.lang.String alternateText) Sets a value indicating alternate description of the structure element.
void	setIdentifier(java.lang.String identifier) Sets a value indicating identifier for the structure element.
void	setIncludeDefaultAttributes(boolean includeDefaultAttributes) Sets a value indicating default attributes to be include.
void	setLanguage(java.lang.String language) Sets a value indicating natural language for all text in the structure element.
void	setOrder(int order) Sets or sets a value indicating the order in its parent structure element or structure tree root.
void	setParent(StructureElement structureElementParent) Sets a value indicating parent structure element.
void	setTitle(java.lang.String title) Sets a value indicating title of structure element.
java.lang.String	toString() Gets the ID of the structure element.

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, wait, wait, wait

Constructor Detail

StructureElement

public StructureElement(TagType tag)

Initializes a new instance of the StructureElement class.

Parameters:

tag - Tag type of the structure element identifying the nature of the structure element and its role.

StructureElement

public StructureElement(TagType tag,
                        boolean includeDefaultAttributes)

Initializes a new instance of the StructureElement class.

Parameters:

tag - Tag type of the structure element identifying the nature of the structure element and its role.

includeDefaultAttributes - Specifes if default attributes need to be added.

Method Detail

getParent

public StructureElement getParent()

Gets a value indicating parent structure element.

Returns:

The parent StructureElement object.

setParent

public void setParent(StructureElement structureElementParent)

Sets a value indicating parent structure element.

Parameters:

structureElementParent - The parent StructureElement object.

getOrder

public int getOrder()

Gets a value indicating the order in its parent structure element or structure tree root.

Returns:

The order or the position in the structure hierarchy.

setOrder

public void setOrder(int order)

Sets or sets a value indicating the order in its parent structure element or structure tree root.

Parameters:

order - The order or the position in the structure hierarchy.

getTagType

public TagType getTagType()

Gets a value indicating standard structure type or named structure type.

Specified by:

getTagType in class Tag

Returns:

a TagType object for StructureElement representing page element in structure.

getTitle

public java.lang.String getTitle()

Gets a value indicating title of structure element.

Returns:

The String value indicating the StructureElement title which characterize the structure element.

setTitle

public void setTitle(java.lang.String title)

Sets a value indicating title of structure element.

Parameters:

title - The String value indicating the StructureElement title which characterize the structure element.

getIdentifier

public java.lang.String getIdentifier()

Gets a value indicating identifier for the structure element.

Returns:

The identifier designating StructureElement in the structure heirachy which should be unique.

setIdentifier

public void setIdentifier(java.lang.String identifier)

Sets a value indicating identifier for the structure element.

Parameters:

identifier - The identifier designating StructureElement in the structure heirachy which should be unique.

getLanguage

public java.lang.String getLanguage()

Gets a value indicating natural language for all text in the structure element.

Returns:

The language for all text in the StructureElement. Eg: "en-US".

setLanguage

public void setLanguage(java.lang.String language)

Sets a value indicating natural language for all text in the structure element.

Parameters:

language - The language for all text in the StructureElement. Eg: "en-US".

getAlternateText

public java.lang.String getAlternateText()

Gets a value indicating alternate description of the structure element.

Returns:

alternate description of the structure element.

setAlternateText

public void setAlternateText(java.lang.String alternateText)

Sets a value indicating alternate description of the structure element.

Parameters:

alternateText - alternate description of the structure element.

getAbbreviation

public java.lang.String getAbbreviation()

Gets a value indicating expandable form of an abbreviation.

Returns:

A string value represeting the expandable form of an abbreviation.

setAbbreviation

public void setAbbreviation(java.lang.String abbreviation)

Sets a value indicating expandable form of an abbreviation.

Parameters:

abbreviation - A string value represeting the expandable form of an abbreviation.

getActualText

public java.lang.String getActualText()

Gets a value indicating the text that is exact replacement for the structure element.

Returns:

actualText for structure element.

setActualText

public void setActualText(java.lang.String actualText)

Sets a value indicating the text that is exact replacement for the structure element.

Parameters:

actualText - actualText for structure element.

getClasses

public AttributeClassList getClasses()

Gets an AttributeClassList to which AttributeClass to be added.

Returns:

A list to which AttributeClass to be added.

getIncludeDefaultAttributes

public boolean getIncludeDefaultAttributes()

Gets a value indicating default attributes to be include.

Returns:

specifies whether to add default attributes.

setIncludeDefaultAttributes

public void setIncludeDefaultAttributes(boolean includeDefaultAttributes)

Sets a value indicating default attributes to be include.

Parameters:

includeDefaultAttributes - specifies whether to add default attributes.

getAttributeLists

public AttributeTypeList getAttributeLists()

Gets an AttributeTypeList to which AttributeObject to be added.

Returns:

A list to which AttributeObject to be added.

toString

public java.lang.String toString()

Gets the ID of the structure element.

Overrides:

toString in class java.lang.Object

draw

public void draw(DocumentWriter writer)

Draws the structure element to the given DocumentWriter object.

Specified by:

draw in class Resource

Parameters:

writer - DocumentWriter object to receive the structure element output.

See Also:

DocumentWriter