org.ujac.print.tag
Class ChapterTag

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

All Implemented Interfaces:

CommonAttributesHolder, ElementContainer, NewPageHandler, StyleHolder

public class ChapterTag
extends SectionTag

Name: ChapterTag
Description: Handler class for the chapter tag.

Author:

lauerc

Field Summary

static String	PROP_CAPTER_ID Constant for the property name for the chapter ID.
static String	TAG_NAME The item's name.

Fields inherited from class org.ujac.print.tag.SectionTag

section, tocRelevance

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

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

Method Summary

protected AttributeDefinitionMap	buildSupportedAttributes() Gets the list of supported attributes.
protected AttributeDefinitionMap	buildSupportedStyleAttributes() Gets the list of supported style attributes.
void	closeItem() Processes the item.
protected void	createSection() Creates the iText section element.
String	getDescription() Gets a brief description for the item.
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.
void	openItem() Opens the item.

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

addElement, buildSupportedChilds, getLeading, getLineSpacing, getSection, getSpacingAfter, getSpacingBefore, getTitleFont, isStyleable, isTopLevel

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

PROP_CAPTER_ID

public static final String PROP_CAPTER_ID

Constant for the property name for the chapter ID.

See Also:

Constant Field Values

TAG_NAME

public static final String TAG_NAME

The item's name.

See Also:

Constant Field Values

Constructor Detail

ChapterTag

public ChapterTag()

Constructs a ChapterTag instance with no specific attributes.

Method Detail

getDescription

public String getDescription()

Gets a brief description for the item.

Overrides:

getDescription in class SectionTag

Returns:

The item's description.

buildSupportedAttributes

protected AttributeDefinitionMap buildSupportedAttributes()

Gets the list of supported attributes.

Overrides:

buildSupportedAttributes in class SectionTag

Returns:

The attribute definitions.

buildSupportedStyleAttributes

protected AttributeDefinitionMap buildSupportedStyleAttributes()

Gets the list of supported style attributes.

Overrides:

buildSupportedStyleAttributes in class SectionTag

Returns:

The attribute definitions.

initialize

public void initialize()
                throws DocumentHandlerException

Initializes the item.

Overrides:

initialize in class SectionTag

Throws:

DocumentHandlerException - If something went badly wrong.

openItem

public void openItem()
              throws DocumentHandlerException

Opens the item.

Overrides:

openItem in class SectionTag

Throws:

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

createSection

protected void createSection()
                      throws DocumentHandlerException

Creates the iText section element.

Overrides:

createSection in class SectionTag

Throws:

DocumentHandlerException - In case the creation of the section failed.

closeItem

public void closeItem()
               throws DocumentHandlerException

Processes the item.

Overrides:

closeItem in class SectionTag

Throws:

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

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

Overrides:

handleNewPage in class SectionTag

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.