org.ujac.print.tag
Class BackgroundImageTag

java.lang.Object
  extended by org.ujac.print.BaseDocumentTag
      extended by org.ujac.print.tag.BaseElementTag
          extended by org.ujac.print.tag.BaseImageTag
              extended by org.ujac.print.tag.BackgroundImageTag
Direct Known Subclasses:
WatermarkTag

public class BackgroundImageTag
extends BaseImageTag

Name: BackgroundImageTag
Description: A class handling <background-image> items.

Author:
lauerc

Field Summary
protected  boolean antialiasing
          The antialiasing flag.
static String TAG_NAME
          The item's name.
 
Fields inherited from class org.ujac.print.tag.BaseImageTag
height, IMAGE_BUILDERS, imageData, pageAttr, sourceAttr, 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
BackgroundImageTag()
          Constructs a BackgroundImageTag instance with no specific attributes.
BackgroundImageTag(String name)
          Constructs a BackgroundImageTag instance with 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.
 String getDescription()
          Gets a brief description for the item.
 float getHeight()
          Gets the image height.
 PagePosition getPosition()
          Gets the image's page position.
 float getWidth()
          Gets the image width.
 void initialize()
          Initializes the item.
protected  void insertImage(com.lowagie.text.pdf.PdfWriter writer, com.lowagie.text.Document document, com.lowagie.text.Image image)
          Inserts the given image into the document.
 void openItem()
          Opens the item.
 
Methods inherited from class org.ujac.print.tag.BaseImageTag
getImage
 
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, buildSupportedChilds, 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, isStyleable, 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
 

Field Detail

TAG_NAME

public static final String TAG_NAME
The item's name.

See Also:
Constant Field Values

antialiasing

protected boolean antialiasing
The antialiasing flag.

Constructor Detail

BackgroundImageTag

public BackgroundImageTag()
Constructs a BackgroundImageTag instance with no specific attributes.


BackgroundImageTag

public BackgroundImageTag(String name)
Constructs a BackgroundImageTag instance with specific attributes.

Parameters:
name - The tag name.
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()
Gets the list of supported attributes.

Overrides:
buildSupportedAttributes in class BaseElementTag
Returns:
The attribute definitions.

buildSupportedStyleAttributes

protected AttributeDefinitionMap buildSupportedStyleAttributes()
Gets the list of supported style attributes.

Overrides:
buildSupportedStyleAttributes in class BaseDocumentTag
Returns:
The attribute definitions.

getPosition

public PagePosition getPosition()
Gets the image's page position.

Returns:
The image's page position.

getWidth

public float getWidth()
Gets the image width.

Returns:
The image width.

getHeight

public float getHeight()
Gets the image height.

Returns:
The image height.

initialize

public void initialize()
                throws DocumentHandlerException
Initializes the item.

Overrides:
initialize in class BaseElementTag
Throws:
DocumentHandlerException - If something went badly wrong.

openItem

public void openItem()
              throws DocumentHandlerException
Opens the item.

Overrides:
openItem in class BaseElementTag
Throws:
DocumentHandlerException - Thrown in case something went wrong while opening the image item.

closeItem

public void closeItem()
               throws DocumentHandlerException
Processes the item.

Overrides:
closeItem in class BaseDocumentTag
Throws:
DocumentHandlerException - Thrown in case something went wrong while processing the document item.

insertImage

protected void insertImage(com.lowagie.text.pdf.PdfWriter writer,
                           com.lowagie.text.Document document,
                           com.lowagie.text.Image image)
Inserts the given image into the document.

Parameters:
writer - The pdf writer.
document - The document to add the image to.
image - The image to insert.


Copyright © 2003-2004 UJAC.org. All Rights Reserved.