com.lowagie.text.rtf
Class RtfPageNumber

java.lang.Object
  extended by com.lowagie.text.Chunk
      extended by com.lowagie.text.rtf.GenericRtfField
          extended by com.lowagie.text.rtf.RtfPageNumber
All Implemented Interfaces:
Element, MarkupAttributes, RtfField

Deprecated. Please move to the RtfWriter2 and associated classes. com.lowagie.text.rtf.field.RtfPageNumber replaces the functionality of this class.

public class RtfPageNumber
extends GenericRtfField
implements RtfField

A rtf page number field. ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2. This class is based on the RtfWriter-package from Mark Hall.

Version:
$Revision: 1.26 $Date: 2006/02/09 17:25:25 $
Author:
Steffen.Stundzig@smb-tec.com, mhall@myrealbox.com

Field Summary
 
Fields inherited from class com.lowagie.text.rtf.GenericRtfField
fieldInst, fieldResult
 
Fields inherited from class com.lowagie.text.Chunk
ACTION, attributes, BACKGROUND, COLOR, ENCODING, font, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, markupAttributes, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TEXTRENDERMODE, UNDERLINE
 
Constructor Summary
RtfPageNumber(String content, Font contentFont)
          Deprecated. construct a RtfPageNumber.
 
Method Summary
 String content()
          Deprecated. empty implementation for Chunk.
 boolean isAlt()
          Deprecated. Determines whether this RtfField shall refer to an end note.
 boolean isDirty()
          Deprecated. Determines whether the field was changed since the field was last updated
 boolean isLocked()
          Deprecated. Determines whtether the field is locked, i.e. it cannot be updated.
 boolean isPrivate()
          Deprecated. Determines whether the field is in suitable form for display.
 void setAlt(boolean rtfFieldIsAlt)
          Deprecated. Determines whether this RtfField shall refer to an end note.
 void setDirty(boolean rtfFieldIsDirty)
          Deprecated. Set whether a formatting change has been made since the field was last updated
 void setEdited(boolean rtfFieldWasEdited)
          Deprecated. Set whether text has been added, removed from thre field result since the field was last updated.
 void setLocked(boolean rtfFieldIsLocked)
          Deprecated. Set whether the field can be updated.
 void setPrivate(boolean rtfFieldIsPrivate)
          Deprecated. Set whether the field is in suitable form for display.
 String toString()
          Deprecated. Returns the content of this Chunk.
 boolean wasEdited()
          Deprecated. Determines whether text has been added, removed from the field result since the field was last updated.
 void write(RtfWriter writer, OutputStream out)
          Deprecated. write this RtfField into a stream using the writer given as first argument.
protected  void writeRtfFieldBegin(OutputStream out)
          Deprecated. Write the beginning of an RtfField to the OutputStream.
protected  void writeRtfFieldEnd(OutputStream out)
          Deprecated. Close the RtfField.
protected  void writeRtfFieldInstBegin(OutputStream out)
          Deprecated. Write RtfField Initialization Stuff to OutputStream.
protected  void writeRtfFieldInstEnd(OutputStream out)
          Deprecated. Write end of RtfField Initialization Stuff to OutputStream.
protected  void writeRtfFieldModifiers(OutputStream out)
          Deprecated. Write the modifiers defined for a RtfField to the OutputStream.
protected  void writeRtfFieldResultBegin(OutputStream out)
          Deprecated. Write beginning of RtfField Result to OutputStream.
protected  void writeRtfFieldResultEnd(OutputStream out)
          Deprecated. Write end of RtfField Result to OutputStream.
 
Methods inherited from class com.lowagie.text.rtf.GenericRtfField
writeRtfFieldInitializationStuff, writeRtfFieldResultStuff
 
Methods inherited from class com.lowagie.text.Chunk
addToArray, append, font, getAttributes, getChunks, getHorizontalScaling, getImage, getKeySet, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getTextRise, getWidthPoint, hasAttributes, isEmpty, isTag, process, setAction, setAnchor, setAnchor, setAnnotation, setBackground, setBackground, setFont, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, setMarkupAttribute, setMarkupAttributes, setNewPage, setRemoteGoto, setRemoteGoto, setSkew, setSplitCharacter, setTextRenderMode, setTextRise, setUnderline, setUnderline, type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RtfPageNumber

public RtfPageNumber(String content,
                     Font contentFont)
Deprecated. 
construct a RtfPageNumber. The parameter content will be displayed in front of the page number using the font given as second argument.

Parameters:
content - the String that will be displayed in front of the page number
contentFont - the font to use to display this page number
Method Detail

write

public void write(RtfWriter writer,
                  OutputStream out)
           throws IOException
Deprecated. 
write this RtfField into a stream using the writer given as first argument.

Specified by:
write in interface RtfField
Parameters:
writer - the RtfWriter to use to write this RtfField
out - the Stream to write this RtfField into.
Throws:
IOException

toString

public String toString()
Deprecated. 
Description copied from class: Chunk
Returns the content of this Chunk.

Specified by:
toString in interface Element
Overrides:
toString in class Chunk
Returns:
a String
See Also:
Element.toString()

isLocked

public final boolean isLocked()
Deprecated. 
Determines whtether the field is locked, i.e. it cannot be updated.

Returns:
true iff the field cannot be updated, false otherwise.

setLocked

public final void setLocked(boolean rtfFieldIsLocked)
Deprecated. 
Set whether the field can be updated.

Parameters:
rtfFieldIsLocked - true if the field cannot be updated, false otherwise.

setDirty

public final void setDirty(boolean rtfFieldIsDirty)
Deprecated. 
Set whether a formatting change has been made since the field was last updated

Parameters:
rtfFieldIsDirty - true if the field was changed since the field was last updated, false otherwise.

isDirty

public final boolean isDirty()
Deprecated. 
Determines whether the field was changed since the field was last updated

Returns:
true if the field was changed since the field was last updated, false otherwise.

setEdited

public final void setEdited(boolean rtfFieldWasEdited)
Deprecated. 
Set whether text has been added, removed from thre field result since the field was last updated.

Parameters:
rtfFieldWasEdited - Determines whether text has been added, removed from the field result since the field was last updated (true, false otherwise..

wasEdited

public final boolean wasEdited()
Deprecated. 
Determines whether text has been added, removed from the field result since the field was last updated.

Returns:
rtfFieldWasEdited true if text has been added, removed from the field result since the field was last updated, false otherwise.

setPrivate

public final void setPrivate(boolean rtfFieldIsPrivate)
Deprecated. 
Set whether the field is in suitable form for display. I.e. it's not a field with a picture as field result

Parameters:
rtfFieldIsPrivate - Determines whether the field is in suitable form for display: true it can be displayed, false it cannot be displayed.

isPrivate

public final boolean isPrivate()
Deprecated. 
Determines whether the field is in suitable form for display.

Returns:
whether the field is in suitable form for display: true yes, false no it cannot be displayed.

setAlt

public final void setAlt(boolean rtfFieldIsAlt)
Deprecated. 
Determines whether this RtfField shall refer to an end note.

Parameters:
rtfFieldIsAlt - true if this RtfField shall refer to an end note, false otherwise

isAlt

public final boolean isAlt()
Deprecated. 
Determines whether this RtfField shall refer to an end note.

Returns:
true if this RtfField shall refer to an end note, false otherwise.

content

public final String content()
Deprecated. 
empty implementation for Chunk.

Overrides:
content in class Chunk
Returns:
an empty string

writeRtfFieldBegin

protected final void writeRtfFieldBegin(OutputStream out)
                                 throws IOException
Deprecated. 
Write the beginning of an RtfField to the OutputStream.

Parameters:
out -
Throws:
IOException

writeRtfFieldModifiers

protected final void writeRtfFieldModifiers(OutputStream out)
                                     throws IOException
Deprecated. 
Write the modifiers defined for a RtfField to the OutputStream.

Parameters:
out -
Throws:
IOException

writeRtfFieldInstBegin

protected final void writeRtfFieldInstBegin(OutputStream out)
                                     throws IOException
Deprecated. 
Write RtfField Initialization Stuff to OutputStream.

Parameters:
out -
Throws:
IOException

writeRtfFieldInstEnd

protected final void writeRtfFieldInstEnd(OutputStream out)
                                   throws IOException
Deprecated. 
Write end of RtfField Initialization Stuff to OutputStream.

Parameters:
out -
Throws:
IOException

writeRtfFieldResultBegin

protected final void writeRtfFieldResultBegin(OutputStream out)
                                       throws IOException
Deprecated. 
Write beginning of RtfField Result to OutputStream.

Parameters:
out -
Throws:
IOException

writeRtfFieldResultEnd

protected final void writeRtfFieldResultEnd(OutputStream out)
                                     throws IOException
Deprecated. 
Write end of RtfField Result to OutputStream.

Parameters:
out -
Throws:
IOException

writeRtfFieldEnd

protected final void writeRtfFieldEnd(OutputStream out)
                               throws IOException
Deprecated. 
Close the RtfField.

Parameters:
out -
Throws:
IOException


Copyright © 2006-2007 EGIZ - E-Government Innovationszentrum. All Rights Reserved.