org.ujac.print.tag
Class SectionTag

java.lang.Object
  org.ujac.print.BaseDocumentTag
      org.ujac.print.tag.BaseElementTag
          org.ujac.print.tag.SectionTag

All Implemented Interfaces:

CommonAttributesHolder, ElementContainer, NewPageHandler, StyleHolder

Direct Known Subclasses:

ChapterTag

public class SectionTag
extends BaseElementTag
implements ElementContainer, StyleHolder, NewPageHandler

Name: SectionTag
Description: Handler class for the ;lt;section> tag.

Author:

lauerc

Field Summary

protected com.lowagie.text.Section	section The iText section element.
static String	TAG_NAME The item's name.
protected String	tocRelevance The toc relevance.

Fields inherited from class org.ujac.print.BaseDocumentTag

actualContent, attributes, condition, content, customAttributes, DEFAULT_FONT, DEFAULT_FONT_COLOR, DEFAULT_FONT_ENCODING, DEFAULT_FONT_FAMILY, DEFAULT_FONT_SIZE, DEFAULT_FONT_STYLE, DEFAULT_LEADING, DEFAULT_LINE_SPACING, depth, documentHandler, IMAGE_CHUNK_ATTR, log, NUMBER_OF_PAGES_TEMPLATES, parentItem, previousItem, styleParent, supportedAttributeMap, supportedChildMap, supportedStyleAttributeMap, tagFactory

Constructor Summary

SectionTag()
Constructs a SectionTag instance with no specific attributes.

SectionTag(String name)
Constructs a SectionTag instance with specific attributes.

Method Summary

void	addElement(BaseDocumentTag item, com.lowagie.text.Element element) Adds a element to the container.
protected AttributeDefinitionMap	buildSupportedAttributes() Gets the list of supported attributes.
ChildDefinitionMap	buildSupportedChilds() Gets the list of supported childs.
protected AttributeDefinitionMap	buildSupportedStyleAttributes() Gets the list of supported style attributes.
void	closeItem() Closes the item.
protected void	createSection() Creates the iText section element.
String	getDescription() Gets a brief description for the item.
float	getLeading() Gets the fixed vertical leading distance.
float	getLineSpacing() Gets the line spacing.
com.lowagie.text.Section	getSection() Gets the section.
float	getSpacingAfter() Getter method for the the property spacingAfter.
float	getSpacingBefore() Getter method for the the property spacingBefore.
DocumentFont	getTitleFont() Getter method for the the property titleFont.
com.lowagie.text.Document	handleNewPage(com.lowagie.text.Rectangle size, com.lowagie.text.Rectangle margins) Handles a new page request.
void	initialize() Initializes the item.
boolean	isStyleable() Tells whether or not this tag does respect style attributes or not.
boolean	isTopLevel() Tells whether the element container is a top level container or not.
void	openItem() Opens the item.

Methods inherited from class org.ujac.print.tag.BaseElementTag

getElementContainer

Methods inherited from class org.ujac.print.BaseDocumentTag

addAttributeDefinition, addChunk, addChunk, addChunk, addContent, addContent, addStyleAttributeDefinition, addToLatestCellContainer, addToLatestElementContainer, addToLatestPdfCellContainer, checkAttributes, colorFromString, createChunk, createFont, ensureNumberOfPagesTemplate, evalAttribute, evalAttribute, extendLeading, extendLeading, extendLeading, extendLeading, filterContents, flushContent, getActualContent, getAttribute, getAttribute, getAttributeDefinition, getAttributeHandler, getAttributes, getBackgroundColor, getBooleanAttribute, getBooleanAttribute, getBorderAttribute, getBorderAttribute, getColorAttribute, getColorAttribute, getCommonAttributesHolder, getContent, getCustomAttributes, getDepth, getDimensionAttribute, getDimensionAttribute, getDimensionAttribute, getDocumentHandler, getExamples, getFloatAttribute, getFloatAttribute, getFont, getHorizontalAlignmentAttribute, getHorizontalAlignmentAttribute, getIntegerAttribute, getIntegerAttribute, getLocalAttribute, getLocalFont, getLocalStyleAttribute, getName, getParentItem, getPhraseContent, getPhraseHeight, getPhraseWidth, getPreviousItem, getRawAttribute, getSortedAttributeDefinitions, getSortedStyleAttributeDefinitions, getStringAttribute, getStringAttribute, getStringAttribute, getStyle, getStyleAttribute, getStyleAttribute, getStyleAttributeDefinition, getStyleAttributes, getStyleClass, getSupportedAttributes, getSupportedChilds, getSupportedChildTags, getSupportedStyleAttributes, getTagFactory, getTextAttribute, getTextAttribute, getTrimmedContent, getVerticalAlignmentAttribute, getVerticalAlignmentAttribute, handleContent, handleFontAttributes, hasContent, int2FontStyle, isAttributeDefined, isAttributeDefined, isAttributeDefined, isAttributeDefined, isAttributeSupported, isAttributeSupported, isAttributeSupported, isAttributeSupported, isDocumentRoot, isEmptyContent, isEmptyString, isIgnoreFlush, isItemClosed, isItemOpened, isPhraseEmpty, isRendered, isStructureChecksDisabled, isStyleAttributeDefined, isTextBodyAllowed, isTrimBody, isTrimNextHead, isValid, isVirtualContainer, locator, preInitialize, printPhrase, processContents, processContents, resetContent, rotatePhrase, setAttributes, setBackgroundColor, setCustomAttributes, setDepth, setDocumentHandler, setItemClosed, setItemOpened, setLocalFont, setLocalFont, setName, setParentItem, setPreviousItem, setTagFactory, setTrimBody, setTrimNextHead, trimContentHead, trimContentTail, typeCastValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ujac.print.StyleHolder

getStyleAttribute

Field Detail

TAG_NAME

public static final String TAG_NAME

The item's name.

See Also:

Constant Field Values

section

protected com.lowagie.text.Section section

The iText section element.

tocRelevance

protected String tocRelevance

The toc relevance.

Constructor Detail

SectionTag

public SectionTag()

Constructs a SectionTag instance with no specific attributes.

SectionTag

public SectionTag(String name)

Constructs a SectionTag instance with specific attributes.

Parameters:

name - The tag name.

Method Detail

getDescription

public String getDescription()

Gets a brief description for the item.

Specified by:

getDescription in class BaseDocumentTag

Returns:

The item's description.

buildSupportedAttributes

protected AttributeDefinitionMap buildSupportedAttributes()

Gets the list of supported attributes.

Overrides:

buildSupportedAttributes in class BaseElementTag

Returns:

The attribute definitions.

buildSupportedStyleAttributes

protected AttributeDefinitionMap buildSupportedStyleAttributes()

Gets the list of supported style attributes.

Overrides:

buildSupportedStyleAttributes in class BaseDocumentTag

Returns:

The attribute definitions.

buildSupportedChilds

public ChildDefinitionMap buildSupportedChilds()

Gets the list of supported childs.

Overrides:

buildSupportedChilds in class BaseDocumentTag

Returns:

The child definitions.

isStyleable

public boolean isStyleable()

Tells whether or not this tag does respect style attributes or not.

Overrides:

isStyleable in class BaseDocumentTag

Returns:

always true.

initialize

public void initialize()
                throws DocumentHandlerException

Initializes the item.

Overrides:

initialize in class BaseElementTag

Throws:

DocumentHandlerException - If something went badly wrong.

openItem

public void openItem()
              throws DocumentHandlerException

Opens the item.

Overrides:

openItem in class BaseElementTag

Throws:

DocumentHandlerException - Thrown in case something went wrong while opening the document item.

closeItem

public void closeItem()
               throws DocumentHandlerException

Closes the item.

Overrides:

closeItem in class BaseDocumentTag

Throws:

DocumentHandlerException - Thrown in case something went wrong while processing the document item.

createSection

protected void createSection()
                      throws DocumentHandlerException

Creates the iText section element.

Throws:

DocumentHandlerException - In case the creation of the section failed.

getSection

public com.lowagie.text.Section getSection()

Gets the section.

Returns:

The section item.

addElement

public void addElement(BaseDocumentTag item,
                       com.lowagie.text.Element element)
                throws DocumentHandlerException

Description copied from interface: ElementContainer

Adds a element to the container.

Specified by:

addElement in interface ElementContainer

Parameters:

item - The document item.

element - The element to be added.

Throws:

DocumentHandlerException - If something went wrong when adding the element.

See Also:

ElementContainer.addElement(org.ujac.print.BaseDocumentTag, com.lowagie.text.Element)

isTopLevel

public boolean isTopLevel()

Tells whether the element container is a top level container or not.

Specified by:

isTopLevel in interface ElementContainer

Returns:

true if the element container is a top level container, else false.

getLeading

public float getLeading()

Gets the fixed vertical leading distance.

Specified by:

getLeading in interface CommonAttributesHolder

Returns:

The current fixed vertical leading distance.

getLineSpacing

public float getLineSpacing()

Gets the line spacing.

Specified by:

getLineSpacing in interface CommonAttributesHolder

Returns:

The current line spacing.

getSpacingBefore

public float getSpacingBefore()

Getter method for the the property spacingBefore.

Returns:

The current value of property spacingBefore.

getSpacingAfter

public float getSpacingAfter()

Getter method for the the property spacingAfter.

Returns:

The current value of property spacingAfter.

getTitleFont

public DocumentFont getTitleFont()

Getter method for the the property titleFont.

Returns:

The current value of property titleFont.

handleNewPage

public com.lowagie.text.Document handleNewPage(com.lowagie.text.Rectangle size,
                                               com.lowagie.text.Rectangle margins)
                                        throws DocumentHandlerException

Handles a new page request.

Specified by:

handleNewPage in interface NewPageHandler

Parameters:

size - The new document size, null if the size should remain the same.

margins - The new document margins, null if the margins should remain the same.

Returns:

A reference to the document.

Throws:

DocumentHandlerException - In case something went wrong.