com.lowagie.text.rtf: public class: RtfPageNumber

com.lowagie.text.rtf
public class: RtfPageNumber [javadoc | source]

java.lang.Object
   com.lowagie.text.Chunk
      com.lowagie.text.rtf.AbstractRtfField
         com.lowagie.text.rtf.GenericRtfField
            com.lowagie.text.rtf.RtfPageNumber

All Implemented Interfaces:
RtfField, Element

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.

author: < - a href="mailto:Steffen.Stundzig@smb-tec.com">Steffen.Stundzig@smb-tec.com

author: < - a href="mailto:mhall@myrealbox.com">mhall@myrealbox.com

version: $ - Revision: 1.25 $Date: 2004/12/14 15:14:44 $

Fields inherited from com.lowagie.text.rtf.GenericRtfField:
fieldInst, fieldResult

Fields inherited from com.lowagie.text.Chunk:
OBJECT_REPLACEMENT_CHARACTER, NEWLINE, NEXTPAGE, content, font, attributes, SEPARATOR, TAB, HSCALE, UNDERLINE, SUBSUPSCRIPT, SKEW, BACKGROUND, TEXTRENDERMODE, SPLITCHARACTER, HYPHENATION, REMOTEGOTO, LOCALGOTO, LOCALDESTINATION, GENERICTAG, IMAGE, ACTION, NEWPAGE, PDFANNOTATION, COLOR, ENCODING

Constructor:

Constructor:
public RtfPageNumber(String content, Font contentFont) { super("PAGE", "", contentFont); this.content = content; } 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

 public RtfPageNumber(String content,
    Font contentFont) {
        super("PAGE", "", contentFont);
        this.content = content;
}

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 from com.lowagie.text.rtf.RtfPageNumber Summary:
toString, write

Methods from com.lowagie.text.rtf.GenericRtfField:
writeRtfFieldInitializationStuff, writeRtfFieldResultStuff

Methods from com.lowagie.text.rtf.AbstractRtfField:
content, isAlt, isDirty, isLocked, isPrivate, setAlt, setDirty, setEdited, setLocked, setPrivate, wasEdited, write, writeRtfFieldBegin, writeRtfFieldEnd, writeRtfFieldInitializationStuff, writeRtfFieldInstBegin, writeRtfFieldInstEnd, writeRtfFieldModifiers, writeRtfFieldResultBegin, writeRtfFieldResultEnd, writeRtfFieldResultStuff

Methods from com.lowagie.text.Chunk:
append, getAttributes, getChunks, getContent, getFont, getHorizontalScaling, getHyphenation, getImage, getTextRise, getWidthPoint, hasAttributes, isContent, isEmpty, isNestable, process, setAction, setAnchor, setAnchor, setAnnotation, setAttributes, setBackground, setBackground, setFont, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, setNewPage, setRemoteGoto, setRemoteGoto, setSkew, setSplitCharacter, setTextRenderMode, setTextRise, setUnderline, setUnderline, toString, type

Methods from com.lowagie.text.Chunk:

append, getAttributes, getChunks, getContent, getFont, getHorizontalScaling, getHyphenation, getImage, getTextRise, getWidthPoint, hasAttributes, isContent, isEmpty, isNestable, process, setAction, setAnchor, setAnchor, setAnnotation, setAttributes, setBackground, setBackground, setFont, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, setNewPage, setRemoteGoto, setRemoteGoto, setSkew, setSplitCharacter, setTextRenderMode, setTextRise, setUnderline, setUnderline, toString, type

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.lowagie.text.rtf.RtfPageNumber Detail:
public String toString() { return content; }
public void write(RtfWriter writer, OutputStream out) throws IOException { writer.writeInitialFontSignature( out, this ); out.write(content.getBytes()); writer.writeFinishingFontSignature( out, this ); super.write(writer, out); } write this RtfField into a stream using the writer given as first argument.

Method from com.lowagie.text.rtf.RtfPageNumber Detail:

 public String toString() {
        return content;
}

 public  void write(RtfWriter writer,
    OutputStream out) throws IOException {
        writer.writeInitialFontSignature( out, this );
        out.write(content.getBytes());
        writer.writeFinishingFontSignature( out, this );
        super.write(writer, out);
}

write this RtfField into a stream using the writer given as first argument.