com.lowagie.text.rtf.field
Class RtfAnchor

java.lang.Object
  extended by com.lowagie.text.Chunk
      extended by com.lowagie.text.rtf.field.RtfField
          extended by com.lowagie.text.rtf.field.RtfAnchor
All Implemented Interfaces:
Element, RtfBasicElement

public class RtfAnchor
extends RtfField

The RtfAnchor is the RTF representation of an Anchor object.

Version:
$Id: RtfAnchor.java 2784 2007-05-24 15:43:40Z hallm $
Author:
Mark Hall (mhall@edu.uni-klu.ac.at), Werner Daehn (Werner.Daehn@BusinessObjects.com), Thomas Bickel (tmb99@inode.at)

Field Summary
private  RtfPhrase content
          The RtfPhrase to display for the url
private static byte[] HYPERLINK
          Constant for a hyperlink
private  java.lang.String url
          The url of this RtfAnchor
 
Fields inherited from class com.lowagie.text.rtf.field.RtfField
document
 
Fields inherited from class com.lowagie.text.Chunk
ACTION, attributes, BACKGROUND, COLOR, ENCODING, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TEXTRENDERMODE, UNDERLINE
 
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
 
Fields inherited from interface com.lowagie.text.Element
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, HEADER, IMGRAW, IMGTEMPLATE, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE
 
Constructor Summary
RtfAnchor(RtfDocument doc, Anchor anchor)
          Constructs a RtfAnchor based on a RtfField
 
Method Summary
protected  byte[] writeFieldInstContent()
          Deprecated. replaced by writeFieldInstContent(OutputStream)
protected  void writeFieldInstContent(java.io.OutputStream result)
          Writes the content of the field instruction area.
protected  byte[] writeFieldResultContent()
          Deprecated. replaced by writeFieldResultContent(OutputStream)
protected  void writeFieldResultContent(java.io.OutputStream out)
          Write the field result for this RtfAnchor.
 
Methods inherited from class com.lowagie.text.rtf.field.RtfField
isEmpty, isFieldAlt, isFieldDirty, isFieldEdit, isFieldLocked, isFieldPrivate, setFieldAlt, setFieldDirty, setFieldEdit, setFieldLocked, setFieldPrivate, setFont, setInHeader, setInTable, setRtfDocument, write, writeContent
 
Methods inherited from class com.lowagie.text.Chunk
addToArray, append, content, font, getAttributes, getChunks, getContent, getFont, getHorizontalScaling, getImage, getKeySet, getTextRise, getWidthPoint, hasAttributes, process, setAction, setAnchor, setAnchor, setAnnotation, setAttributes, setBackground, setBackground, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, setNewPage, setRemoteGoto, setRemoteGoto, setSkew, setSplitCharacter, setTextRenderMode, setTextRise, setUnderline, setUnderline, toString, type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

HYPERLINK

private static final byte[] HYPERLINK
Constant for a hyperlink


url

private java.lang.String url
The url of this RtfAnchor


content

private RtfPhrase content
The RtfPhrase to display for the url

Constructor Detail

RtfAnchor

public RtfAnchor(RtfDocument doc,
                 Anchor anchor)
Constructs a RtfAnchor based on a RtfField

Parameters:
doc - The RtfDocument this RtfAnchor belongs to
anchor - The Anchor this RtfAnchor is based on
Method Detail

writeFieldInstContent

protected byte[] writeFieldInstContent()
                                throws java.io.IOException
Deprecated. replaced by writeFieldInstContent(OutputStream)

Write the field instructions for this RtfAnchor. Sets the field type to HYPERLINK and then writes the url.

Specified by:
writeFieldInstContent in class RtfField
Returns:
The field instructions for this RtfAnchor
Throws:
java.io.IOException

writeFieldInstContent

protected void writeFieldInstContent(java.io.OutputStream result)
                              throws java.io.IOException
Description copied from class: RtfField
Writes the content of the field instruction area. Override this method in your subclasses.

Overrides:
writeFieldInstContent in class RtfField
Throws:
java.io.IOException

writeFieldResultContent

protected byte[] writeFieldResultContent()
                                  throws java.io.IOException
Deprecated. replaced by writeFieldResultContent(OutputStream)

Write the field result for this RtfAnchor. Writes the content of the RtfPhrase.

Specified by:
writeFieldResultContent in class RtfField
Returns:
The field result for this RtfAnchor
Throws:
java.io.IOException

writeFieldResultContent

protected void writeFieldResultContent(java.io.OutputStream out)
                                throws java.io.IOException
Write the field result for this RtfAnchor. Writes the content of the RtfPhrase.

Overrides:
writeFieldResultContent in class RtfField
Throws:
java.io.IOException