Save This Page
Home » iText-src-2.1.3 » com.lowagie » text » rtf » headerfooter » [javadoc | source]
com.lowagie.text.rtf.headerfooter
public class: RtfHeaderFooter [javadoc | source]
java.lang.Object
   com.lowagie.text.Rectangle
      com.lowagie.text.HeaderFooter
         com.lowagie.text.rtf.headerfooter.RtfHeaderFooter

All Implemented Interfaces:
    RtfBasicElement, Element

The RtfHeaderFooter represents one header or footer. This class can be used directly.
Field Summary
public static final  int TYPE_HEADER    Constant for the header type 
public static final  int TYPE_FOOTER    Constant for the footer type 
public static final  int DISPLAY_FIRST_PAGE    Constant for displaying the header/footer on the first page 
public static final  int DISPLAY_ALL_PAGES    Constant for displaying the header/footer on all pages 
public static final  int DISPLAY_LEFT_PAGES    Constant for displaying the header/footer on all left hand pages 
public static final  int DISPLAY_RIGHT_PAGES    Constant for displaying the header/footer on all right hand pages 
Fields inherited from com.lowagie.text.Rectangle:
UNDEFINED,  TOP,  BOTTOM,  LEFT,  RIGHT,  NO_BORDER,  BOX,  llx,  lly,  urx,  ury,  rotation,  border,  borderWidth,  borderColor,  backgroundColor,  useVariableBorders,  borderWidthLeft,  borderWidthRight,  borderWidthTop,  borderWidthBottom,  borderColorLeft,  borderColorRight,  borderColorTop,  borderColorBottom
Constructor:
 public RtfHeaderFooter(Element element) 
    Constructs a RtfHeaderFooter for any Element.
    Parameters:
    element - The Element to display as content of this RtfHeaderFooter
 public RtfHeaderFooter(Element[] elements) 
    Constructs a RtfHeaderFooter for an array of Elements.
    Parameters:
    elements - The Elements to display as the content of this RtfHeaderFooter.
 protected RtfHeaderFooter(RtfDocument doc,
    HeaderFooter headerFooter) 
    Constructs a RtfHeaderFooter for a HeaderFooter.
    Parameters:
    doc - The RtfDocument this RtfHeaderFooter belongs to
    headerFooter - The HeaderFooter to base this RtfHeaderFooter on
 protected RtfHeaderFooter(RtfDocument doc,
    RtfHeaderFooter headerFooter,
    int displayAt) 
    Constructs a RtfHeaderFooter as a copy of an existing RtfHeaderFooter. For internal use only.
    Parameters:
    doc - The RtfDocument this RtfHeaderFooter belongs to
    headerFooter - The RtfHeaderFooter to copy
    displayAt - The display location of this RtfHeaderFooter
 protected RtfHeaderFooter(RtfDocument doc,
    HeaderFooter headerFooter,
    int type,
    int displayAt) 
    Constructs a RtfHeaderFooter based on a HeaderFooter with a certain type and displayAt location. For internal use only.
    Parameters:
    doc - The RtfDocument this RtfHeaderFooter belongs to
    headerFooter - The HeaderFooter to base this RtfHeaderFooter on
    type - The type of RtfHeaderFooter
    displayAt - The display location of this RtfHeaderFooter
Method from com.lowagie.text.rtf.headerfooter.RtfHeaderFooter Summary:
setAlignment,   setDisplayAt,   setInHeader,   setInTable,   setRtfDocument,   setType,   writeContent
Methods from com.lowagie.text.HeaderFooter:
alignment,   getAfter,   getBefore,   isNumbered,   paragraph,   setAlignment,   setPageNumber
Methods from com.lowagie.text.Rectangle:
cloneNonPositionParameters,   disableBorderSide,   enableBorderSide,   getBackgroundColor,   getBorder,   getBorderColor,   getBorderColorBottom,   getBorderColorLeft,   getBorderColorRight,   getBorderColorTop,   getBorderWidth,   getBorderWidthBottom,   getBorderWidthLeft,   getBorderWidthRight,   getBorderWidthTop,   getBottom,   getBottom,   getChunks,   getGrayFill,   getHeight,   getLeft,   getLeft,   getRight,   getRight,   getRotation,   getTop,   getTop,   getWidth,   hasBorder,   hasBorders,   isContent,   isNestable,   isUseVariableBorders,   normalize,   process,   rectangle,   rotate,   setBackgroundColor,   setBorder,   setBorderColor,   setBorderColorBottom,   setBorderColorLeft,   setBorderColorRight,   setBorderColorTop,   setBorderWidth,   setBorderWidthBottom,   setBorderWidthLeft,   setBorderWidthRight,   setBorderWidthTop,   setBottom,   setGrayFill,   setLeft,   setRight,   setTop,   setUseVariableBorders,   softCloneNonPositionParameters,   toString,   type
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.lowagie.text.rtf.headerfooter.RtfHeaderFooter Detail:
 public  void setAlignment(int alignment) 
    Set the alignment of this RtfHeaderFooter. Passes the setting on to the contained element.
 public  void setDisplayAt(int displayAt) 
    Sets the display location of this RtfHeaderFooter
 public  void setInHeader(boolean inHeader) 
    Unused
 public  void setInTable(boolean inTable) 
    Unused
 public  void setRtfDocument(RtfDocument doc) 
    Sets the RtfDocument this RtfElement belongs to
 public  void setType(int type) 
    Sets the type of this RtfHeaderFooter
 public  void writeContent(OutputStream result) throws IOException 
    Writes the content of this RtfHeaderFooter