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

Quick Search    Search Deep

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

java.lang.Object
  extended byorg.ujac.print.BaseDocumentTag
      extended byorg.ujac.print.tag.MacroDefTag
All Implemented Interfaces:
org.ujac.print.CellContainer, org.ujac.print.Condition, org.ujac.print.DocumentEventRecorder, org.ujac.print.ElementContainer, org.ujac.print.ParameterDefHolder, org.ujac.print.PdfCellContainer, TagAttributes

public class MacroDefTag
extends org.ujac.print.BaseDocumentTag
implements org.ujac.print.ParameterDefHolder, org.ujac.print.DocumentEventRecorder, org.ujac.print.CellContainer, org.ujac.print.PdfCellContainer, org.ujac.print.ElementContainer, org.ujac.print.Condition

Name: MacroDefTag
Description: Description of the class.
Log: $Log: MacroDefTag.java,v $
Log: Revision 1.4 2003/11/23 03:08:34 lauerc
Log: Cleaned up code.
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.8 2003/07/23 22:48:48 lauerc
Log: Added attribute documentation.
Log:
Log: Revision 1.7 2003/07/18 06:26:01 lauerc
Log: Content handling re-designed.
Log:
Log: Revision 1.6 2003/07/10 06:49:00 lauerc
Log: Implemented Condition interface, always returning false at method isTrue to avoid executing of the items, only recording is desired here.
Log:
Log: Revision 1.5 2003/07/09 22:01:43 lauerc
Log: Implemented the getDescription method.
Log:
Log: Revision 1.4 2003/07/08 22:16:07 lauerc
Log: Added method getParameterDefs.
Log: Fixed method recordEvent.
Log:
Log: Revision 1.3 2003/07/07 06:59:15 lauerc
Log: Further progress towards completion.
Log:
Log: Revision 1.2 2003/07/06 22:03:15 lauerc
Log: Implemented interface ParameterDefHolder.
Log:
Log: Revision 1.1 2003/07/03 04:50:35 lauerc
Log: Initial revision.
Log:

Version:
$Revision: 1.4 $

Field Summary
private  java.util.List documentEvents
          The document event list.
private  java.lang.String name
          The name attribute.
static java.lang.String NAME
          The item's name.
private  java.util.Map parameterDefs
          The parameter definition map.
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
MacroDefTag()
           
 
Method Summary
 void addCell(org.ujac.print.BaseDocumentTag item, com.lowagie.text.Cell cell)
          Adds a cell to the container.
 void addCell(org.ujac.print.BaseDocumentTag item, com.lowagie.text.pdf.PdfPCell cell)
          Adds a PDF cell to the container.
 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.
 java.util.List getDocumentEvents()
          Gets the document event list.
 java.lang.String getName()
          Gets the item's name.
 java.util.Map getParameterDefs()
          Gets the parameter definition map.
 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.
 boolean isTrue()
          Checks whether the condition is true or not.
 boolean isVirtualContainer()
          Is the item virtual container, such as if, else or foreach.
 void openItem()
          Opens the item.
 void recordEvent(org.ujac.print.DocumentEvent event)
          Records the given document event.
 void setParameterDef(org.ujac.print.ParameterDefinition parameterDef)
          Sets a parameter definition.
 
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, isAttributeDefined, isAttributeSupported, isEmptyContent, isIgnoreFlush, isItemClosed, isItemOpened, isValid, 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.


name

private java.lang.String name
The name attribute.


parameterDefs

private java.util.Map parameterDefs
The parameter definition map.


documentEvents

private java.util.List documentEvents
The document event list.

Constructor Detail

MacroDefTag

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


isVirtualContainer

public boolean isVirtualContainer()
Is the item virtual container, such as if, else or foreach.


getDocumentEvents

public java.util.List getDocumentEvents()
Gets the document event list.


getParameterDefs

public java.util.Map getParameterDefs()
Gets the parameter definition map.


initialize

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


openItem

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


closeItem

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


setParameterDef

public void setParameterDef(org.ujac.print.ParameterDefinition parameterDef)
Sets a parameter definition.

Specified by:
setParameterDef in interface org.ujac.print.ParameterDefHolder

recordEvent

public void recordEvent(org.ujac.print.DocumentEvent event)
Description copied from interface: org.ujac.print.DocumentEventRecorder
Records the given document event.

Specified by:
recordEvent in interface org.ujac.print.DocumentEventRecorder

addCell

public void addCell(org.ujac.print.BaseDocumentTag item,
                    com.lowagie.text.Cell cell)
             throws org.ujac.print.DocumentHandlerException
Adds a cell to the container.

Specified by:
addCell in interface org.ujac.print.CellContainer

addCell

public void addCell(org.ujac.print.BaseDocumentTag item,
                    com.lowagie.text.pdf.PdfPCell cell)
             throws org.ujac.print.DocumentHandlerException
Adds a PDF cell to the container.

Specified by:
addCell in interface org.ujac.print.PdfCellContainer

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

isTrue

public boolean isTrue()
Description copied from interface: org.ujac.print.Condition
Checks whether the condition is true or not.

Specified by:
isTrue in interface org.ujac.print.Condition