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

Quick Search    Search Deep

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

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

public class PhraseTag
extends BaseElementTag
implements org.ujac.print.ElementContainer, org.ujac.print.PhraseHolder

Name: PhraseTag
Description: A class handling phrases.

Log: $Log: PhraseTag.java,v $
Log: Revision 1.8 2003/11/27 01:31:42 lauerc
Log: Added missing supported childs list.
Log:
Log: Revision 1.7 2003/11/24 08:07:19 lauerc
Log: Cleaned up imports.
Log:
Log: Revision 1.6 2003/11/24 07:47:54 lauerc
Log: Moved phrase rotation to BaseDocumentTag.
Log:
Log: Revision 1.5 2003/11/24 00:32:56 lauerc
Log: Added initial support for rotate attribute.
Log:
Log: Revision 1.4 2003/11/23 03:19:33 lauerc
Log: Fixed javadoc comments.
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.19 2003/07/23 23:00:42 lauerc
Log: Added attribute documentation.
Log:
Log: Revision 1.18 2003/07/22 06:14:52 lauerc
Log: Removed method formatPhrase in advance of method addChunk.
Log: The content processing is now centralized at this method.
Log:
Log: Revision 1.17 2003/07/21 05:35:53 lauerc
Log: Centralized chunk handling.
Log:
Log: Revision 1.16 2003/07/18 06:26:01 lauerc
Log: Content handling re-designed.
Log:
Log: Revision 1.15 2003/07/09 22:03:09 lauerc
Log: Implemented the getDescription method.
Log:
Log: Revision 1.14 2003/07/07 06:58:21 lauerc
Log: Changed visibility of method initialize to public.
Log:
Log: Revision 1.13 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.12 2003/05/08 06:33:29 lauerc
Log: Avoided the adding of empty content.
Log:
Log: Revision 1.11 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.10 2003/04/29 19:41:33 lauerc
Log: Checking for valid condition to avoid output when surronding condition evaluates to false.
Log:
Log: Revision 1.9 2003/04/26 00:15:35 lauerc
Log: Implemented the openItem method.
Log:
Log: Revision 1.8 2003/04/24 18:26:32 lauerc
Log: Removed console output.
Log:
Log: Revision 1.7 2003/04/24 18:23:52 lauerc
Log: Added support for formatting items even in dynamic content.
Log:
Log: Revision 1.6 2003/04/08 23:50:46 lauerc
Log: Enhanced font support.
Log:
Log: Revision 1.5 2003/04/05 09:31:24 lauerc
Log: Fixed imports.
Log:
Log: Revision 1.4 2003/04/01 22:57:22 lauerc
Log: Improved exception handling, fixed attribute declarations.
Log:
Log: Revision 1.3 2003/03/31 22:29:05 lauerc
Log: Implemented meta information serving methods (getSupportedAttributes, getSupportedChilds).
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.8 $

Field Summary
private  float leading
          The leading attribute.
static java.lang.String NAME
          The item's name.
private  com.lowagie.text.Phrase phrase
          The phrase.
private  float rotate
          The rotation angle.
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.tag.BaseElementTag
elementContainer
 
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
PhraseTag()
           
 
Method Summary
 void addChunk(org.ujac.print.BaseDocumentTag item, com.lowagie.text.Chunk chunk)
          Adds the given chunk to the root phrase.
 void addChunk(org.ujac.print.BaseDocumentTag item, java.lang.String chunk, com.lowagie.text.Font font)
          Adds the given chunk to the root phrase.
 void addElement(org.ujac.print.BaseDocumentTag item, com.lowagie.text.Element element)
          Adds a element to the container.
 void closeItem()
          Processes the item.
private  void createPhrase()
          Creates a new phrase.
 void flushContent()
          Flushes the content buffer.
 java.lang.String getDescription()
          Gets a brief description for the item.
 java.lang.String getName()
          Gets the item's name.
 com.lowagie.text.Phrase getRootPhrase()
          Gets the root phrase.
 org.ujac.print.AttributeDefinition[] getSupportedAttributes()
          Gets the list of supported attributes.
 org.ujac.print.ChildDefinition[] getSupportedChilds()
          Gets the list of supported childs.
 void initialize()
          Initializes the item.
 void openItem()
          Opens the item.
 
Methods inherited from class org.ujac.print.BaseDocumentTag
addChunk, addChunk, addChunk, addContent, addContent, addToLatestCellContainer, addToLatestElementContainer, addToLatestPdfCellContainer, colorFromString, createFont, 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, 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.


leading

private float leading
The leading attribute.


rotate

private float rotate
The rotation angle.


phrase

private com.lowagie.text.Phrase phrase
The phrase.

Constructor Detail

PhraseTag

public PhraseTag()
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.


initialize

public void initialize()
                throws org.ujac.print.DocumentHandlerException
Initializes the item.

Overrides:
initialize in class BaseElementTag

openItem

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


flushContent

public void flushContent()
                  throws org.ujac.print.DocumentHandlerException
Flushes the content buffer.


closeItem

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


getRootPhrase

public com.lowagie.text.Phrase getRootPhrase()
Description copied from interface: org.ujac.print.PhraseHolder
Gets the root phrase.

Specified by:
getRootPhrase in interface org.ujac.print.PhraseHolder

addChunk

public void addChunk(org.ujac.print.BaseDocumentTag item,
                     java.lang.String chunk,
                     com.lowagie.text.Font font)
              throws org.ujac.print.DocumentHandlerException
Adds the given chunk to the root phrase.

Specified by:
addChunk in interface org.ujac.print.PhraseHolder

addChunk

public void addChunk(org.ujac.print.BaseDocumentTag item,
                     com.lowagie.text.Chunk chunk)
Adds the given chunk to the root phrase.

Specified by:
addChunk in interface org.ujac.print.PhraseHolder

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

createPhrase

private void createPhrase()
Creates a new phrase.