Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.ujac.print.tag
Class DocumentTag  view DocumentTag download DocumentTag.java

java.lang.Object
  extended byorg.ujac.print.BaseDocumentTag
      extended byorg.ujac.print.tag.DocumentTag
All Implemented Interfaces:
org.ujac.print.ElementContainer, TagAttributes

public class DocumentTag
extends org.ujac.print.BaseDocumentTag
implements org.ujac.print.ElementContainer

Name: DocumentTag
Description: A class handling 'document' items.

Log: $Log: DocumentTag.java,v $
Log: Revision 1.5 2003/11/27 01:24:37 lauerc
Log: Added missing items to supported childs list.
Log:
Log: Revision 1.4 2003/11/21 01:16:41 lauerc
Log: Added support for tag 'resource-bundle'.
Log:
Log: Revision 1.3 2003/11/21 00:57:42 lauerc
Log: Made almost all attribute values behave dynamic using the Expression interpreter.
Log:
Log: Revision 1.2 2003/11/01 12:05:19 lauerc
Log: Added copyright notice.
Log:
Log: Revision 1.1 2003/09/29 21:15:03 lauerc
Log: Renamed classes from XyzItem to XyzTag.
Log:
Log: Revision 1.15 2003/09/02 20:06:02 lauerc
Log: Added support for set-format item.
Log:
Log: Revision 1.14 2003/07/22 06:11:14 lauerc
Log: Added attribute documentation.
Log:
Log: Revision 1.13 2003/07/18 06:26:02 lauerc
Log: Content handling re-designed.
Log:
Log: Revision 1.12 2003/07/09 22:00:05 lauerc
Log: Implemented the getDescription method.
Log:
Log: Revision 1.11 2003/05/26 06:53:07 lauerc
Log: Added initial support for charts (package org.ujac.chart).
Log:
Log: Revision 1.10 2003/05/20 21:23:33 lauerc
Log: Enhanced child declaration: Just added the base type of a group of items (e.g. BaseFontTag).
Log: This provides automatic support of new classes which extend specific supported items.
Log:
Log: Revision 1.9 2003/05/18 11:31:26 lauerc
Log: Checking if an attribute is required or not is based on attribute definitions now (see getSupportedAttributes).
Log:
Log: Revision 1.8 2003/04/29 20:33:02 lauerc
Log: Added item to the argument list of the addElement method of ElementContainer interface.
Log: Added item to the argument list of the addChunk method of PhraseHolder interface.
Log:
Log: Revision 1.7 2003/04/06 20:05:59 lauerc
Log: Ensured that the document is open before adding elements to it at method addElement.
Log:
Log: Revision 1.6 2003/04/05 15:46:01 lauerc
Log: Added support for header and footer item.
Log:
Log: Revision 1.5 2003/04/01 22:57:22 lauerc
Log: Improved exception handling, fixed attribute declarations.
Log:
Log: Revision 1.4 2003/03/31 22:29:05 lauerc
Log: Implemented meta information serving methods (getSupportedAttributes, getSupportedChilds).
Log:
Log: Revision 1.3 2003/03/30 13:29:48 lauerc
Log: Externalized attribute names to interface TagAttributes.
Log:
Log: Revision 1.2 2003/03/27 01:53:25 lauerc
Log: Further progress in printing stuff.
Log:
Log: Revision 1.1 2003/03/26 07:41:40 lauerc
Log: Initial revision.
Log:

Version:
$Revision: 1.5 $

Field Summary
private  com.lowagie.text.Document document
          The iText document.
static java.lang.String NAME
          The item's name.
private static org.ujac.print.AttributeDefinition[] supportedAttributes
          The item's supported attributes.
private static org.ujac.print.ChildDefinition[] supportedChilds
          The item's supported childs.
 
Fields inherited from class org.ujac.print.BaseDocumentTag
attributes, condition, content, DEFAULT_FONT, DEFAULT_FONT_COLOR, DEFAULT_FONT_FAMILY, DEFAULT_FONT_SIZE, DEFAULT_FONT_STYLE, depth, documentHandler, parentItem, previousItem, supportedAttributeMap, tagFactory
 
Fields inherited from interface org.ujac.print.tag.TagAttributes
ATTR_AUTHOR, ATTR_BACKGROUND_COLOR, ATTR_BAR_COLOR, ATTR_BAR_HEIGHT, ATTR_BAR_WIDTH, ATTR_BASELINE, ATTR_BORDER_COLOR, ATTR_BORDER_STYLE, ATTR_BORDER_WIDTH, ATTR_COLOR, ATTR_COLSPAN, ATTR_COLUMNS, ATTR_CONDITION, ATTR_COUNT, ATTR_CREATION_DATE, ATTR_CREATOR, ATTR_DEFAULT_VALUE, ATTR_DESCRIPTION_FONT, ATTR_DESCRIPTION_PATTERN, ATTR_DESCRIPTIONS, ATTR_DRAW_FOREGROUND, ATTR_FAMILY, ATTR_FONT_DEF, ATTR_FORMAT, ATTR_GENERATE_CHECKSUM, ATTR_GROUP_NAME, ATTR_HEIGHT, ATTR_HORIZONTAL_ALIGNMENT, ATTR_KEEP_HEADER, ATTR_KEYWORDS, ATTR_LEADING, ATTR_LETTERED, ATTR_LIST, ATTR_LOOP_VARIABLE, ATTR_MARGIN_BOTTOM, ATTR_MARGIN_LEFT, ATTR_MARGIN_RIGHT, ATTR_MARGIN_TOP, ATTR_NAME, ATTR_NEW_PAGE, ATTR_NO_WRAP, ATTR_NUMBER, ATTR_NUMBERED, ATTR_OPTIONAL, ATTR_PADDING, ATTR_PADDING_BOTTOM, ATTR_PADDING_LEFT, ATTR_PADDING_RIGHT, ATTR_PADDING_TOP, ATTR_PERCENT_FORMAT, ATTR_PRINT_HEADER, ATTR_REFERENCE, ATTR_ROTATE, ATTR_SEQUENCE, ATTR_SIZE, ATTR_SOURCE, ATTR_START_STOP_TEXT, ATTR_STYLE, ATTR_SUBJECT, ATTR_SYMBOL_INDENT, ATTR_TEXT_COLOR, ATTR_TEXTWRAP, ATTR_TITLE, ATTR_TITLE_FONT, ATTR_TYPE, ATTR_UNDERLYING, ATTR_VALUE, ATTR_VALUE_FORMAT, ATTR_VALUES, ATTR_VERTICAL_ALIGNMENT, ATTR_WIDTH, ATTR_WIDTHS, ATTR_X, ATTR_Y
 
Constructor Summary
DocumentTag()
           
 
Method Summary
 void addElement(org.ujac.print.BaseDocumentTag item, com.lowagie.text.Element element)
          Adds a element to the container.
 void closeItem()
          Closes the item.
 java.lang.String getDescription()
          Gets a brief description for the item.
 com.lowagie.text.Document getDocument()
          Gets the iText document.
 com.lowagie.text.Document getDocument(boolean openDocumentRequired)
          Gets the iText document.
 java.lang.String getName()
          Gets the item's name.
 org.ujac.print.AttributeDefinition[] getSupportedAttributes()
          Gets the list of supported attributes.
 org.ujac.print.ChildDefinition[] getSupportedChilds()
          Gets the list of supported childs.
 void openItem()
          Opens the item.
 
Methods inherited from class org.ujac.print.BaseDocumentTag
addChunk, addChunk, addChunk, addContent, addContent, addToLatestCellContainer, addToLatestElementContainer, addToLatestPdfCellContainer, colorFromString, createFont, flushContent, getAttribute, getAttribute, getAttributeDefinition, getAttributes, getBooleanAttribute, getBooleanAttribute, getBorderAttribute, getBorderAttribute, getColorAttribute, getColorAttribute, getContent, getDepth, getDocumentHandler, getExamples, getFloatAttribute, getFloatAttribute, getFont, getHorizontalAlignmentAttribute, getHorizontalAlignmentAttribute, getIntegerAttribute, getIntegerAttribute, getParentItem, getPhraseHeight, getPhraseWidth, getPreviousItem, getSupportedChildTags, getTagFactory, getTrimmedContent, getVerticalAlignmentAttribute, getVerticalAlignmentAttribute, hasContent, initialize, isAttributeDefined, isAttributeSupported, isEmptyContent, isIgnoreFlush, isItemClosed, isItemOpened, isValid, isVirtualContainer, locator, resetContent, rotatePhrase, setAttributes, setDepth, setDocumentHandler, setItemClosed, setItemOpened, setParentItem, setPreviousItem, setTagFactory, trimContentTail
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final java.lang.String NAME
The item's name.

See Also:
Constant Field Values

supportedAttributes

private static final org.ujac.print.AttributeDefinition[] supportedAttributes
The item's supported attributes.


supportedChilds

private static final org.ujac.print.ChildDefinition[] supportedChilds
The item's supported childs.


document

private com.lowagie.text.Document document
The iText document.

Constructor Detail

DocumentTag

public DocumentTag()
Method Detail

getName

public java.lang.String getName()
Gets the item's name.


getDescription

public java.lang.String getDescription()
Gets a brief description for the item.


getSupportedAttributes

public org.ujac.print.AttributeDefinition[] getSupportedAttributes()
Gets the list of supported attributes.


getSupportedChilds

public org.ujac.print.ChildDefinition[] getSupportedChilds()
Gets the list of supported childs.


openItem

public void openItem()
              throws org.ujac.print.DocumentHandlerException
Opens the item.


closeItem

public void closeItem()
               throws org.ujac.print.DocumentHandlerException
Closes the item.


addElement

public void addElement(org.ujac.print.BaseDocumentTag item,
                       com.lowagie.text.Element element)
                throws org.ujac.print.DocumentHandlerException
Adds a element to the container.

Specified by:
addElement in interface org.ujac.print.ElementContainer

getDocument

public com.lowagie.text.Document getDocument()
Gets the iText document.


getDocument

public com.lowagie.text.Document getDocument(boolean openDocumentRequired)
Gets the iText document.