org.ujac.print.tag
Class HeaderTag

java.lang.Object
  org.ujac.print.BaseDocumentTag
      org.ujac.print.tag.BaseElementTag
          org.ujac.print.tag.HeaderFooterTag
              org.ujac.print.tag.HeaderTag

All Implemented Interfaces:

FontHolder, StyleHolder

public class HeaderTag
extends HeaderFooterTag

Name: HeaderTag
Description: A class handling header tags.

Author:

lauerc

Field Summary

static String

TAG_NAME The item's name.

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

DEFAULT_RULE_PADDING, headerFooterParts, newPageTag, RULE_COLOR, RULE_WIDTH

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

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

Method Summary

protected AttributeDefinitionMap	buildSupportedAttributes() Builds the map of supported attributes.
ChildDefinitionMap	buildSupportedChilds() Gets the list of supported childs.
protected AttributeDefinitionMap	buildSupportedStyleAttributes() Builds the map of supported style attributes.
protected void	drawRule(com.lowagie.text.pdf.PdfWriter writer, com.lowagie.text.Document document) Draws the horizontal rule line.
String	getDescription() Gets a brief description for the item.
float	getPaddingBottom() Getter method for the the property paddingBottom.
void	openItem() Opens the item.

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

addPart, getFont, getLineSpacing, getRuleColor, getRuleWidth, initialize, isInNewPageTag, isStyleable

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

Constructor Detail

HeaderTag

public HeaderTag()

Constructs a HeaderTag instance with no specific attributes.

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()

Description copied from class: BaseElementTag

Builds the map of supported attributes.

Overrides:

buildSupportedAttributes in class BaseElementTag

Returns:

The attribute definitions.

See Also:

BaseDocumentTag.buildSupportedAttributes()

buildSupportedStyleAttributes

protected AttributeDefinitionMap buildSupportedStyleAttributes()

Description copied from class: BaseDocumentTag

Builds the map of supported style attributes.

Overrides:

buildSupportedStyleAttributes in class BaseDocumentTag

Returns:

The attribute definitions.

See Also:

BaseDocumentTag.buildSupportedStyleAttributes()

buildSupportedChilds

public ChildDefinitionMap buildSupportedChilds()

Gets the list of supported childs.

Overrides:

buildSupportedChilds in class BaseDocumentTag

Returns:

The child definitions.

openItem

public void openItem()
              throws DocumentHandlerException

Opens the item.

Overrides:

openItem in class HeaderFooterTag

Throws:

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

drawRule

protected void drawRule(com.lowagie.text.pdf.PdfWriter writer,
                        com.lowagie.text.Document document)

Draws the horizontal rule line.

Specified by:

drawRule in class HeaderFooterTag

Parameters:

writer - The PDF writer.

document - The document.

getPaddingBottom

public float getPaddingBottom()

Getter method for the the property paddingBottom.

Returns:

The current value of property paddingBottom.