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

All Implemented Interfaces:
    RtfBasicElement, Element

The RtfHeaderFooterGroup holds 0 - 3 RtfHeaderFooters that create a group of headers or footers.
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 RtfHeaderFooterGroup() 
 public RtfHeaderFooterGroup(RtfDocument doc,
    int type) 
    Constructs a certain type of RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER and RtfHeaderFooter.TYPE_FOOTER are valid values for type.
    Parameters:
    doc - The RtfDocument this RtfHeaderFooter belongs to
    type - The type of RtfHeaderFooterGroup to create
 public RtfHeaderFooterGroup(RtfDocument doc,
    RtfHeaderFooterGroup headerFooter,
    int type) 
    Constructs a RtfHeaderFooterGroup by copying the content of the original RtfHeaderFooterGroup
    Parameters:
    doc - The RtfDocument this RtfHeaderFooter belongs to
    headerFooter - The RtfHeaderFooterGroup to copy
    type - The type of RtfHeaderFooterGroup to create
 public RtfHeaderFooterGroup(RtfDocument doc,
    RtfHeaderFooter headerFooter,
    int type) 
    Constructs a RtfHeaderFooterGroup for a certain RtfHeaderFooter.
    Parameters:
    doc - The RtfDocument this RtfHeaderFooter belongs to
    headerFooter - The RtfHeaderFooter to display
    type - The type of RtfHeaderFooterGroup to create
 public RtfHeaderFooterGroup(RtfDocument doc,
    HeaderFooter headerFooter,
    int type) 
    Constructs a RtfHeaderGroup for a certain HeaderFooter
    Parameters:
    doc - The RtfDocument this RtfHeaderFooter belongs to
    headerFooter - The HeaderFooter to display
    type - The type of RtfHeaderFooterGroup to create
Method from com.lowagie.text.rtf.headerfooter.RtfHeaderFooterGroup Summary:
getHeaderAll,   getHeaderFirst,   getHeaderLeft,   getHeaderRight,   getMode,   hasFacingPages,   hasTitlePage,   setHasFacingPages,   setHasTitlePage,   setHeaderFooter,   setHeaderFooter,   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.RtfHeaderFooterGroup Detail:
 protected RtfHeaderFooter getHeaderAll() 
    Gets the RtfHeaderFooter for all pages
 protected RtfHeaderFooter getHeaderFirst() 
    Gets the RtfHeaderFooter for the title page
 protected RtfHeaderFooter getHeaderLeft() 
    Gets the RtfHeaderFooter for all left hand pages
 protected RtfHeaderFooter getHeaderRight() 
    Gets the RtfHeaderFooter for all right hand pages
 protected int getMode() 
    Gets the mode of this RtfHeaderFooterGroup
 public boolean hasFacingPages() 
    Get whether this RtfHeaderFooterGroup has facing pages
 public boolean hasTitlePage() 
    Get whether this RtfHeaderFooterGroup has a titlepage
 public  void setHasFacingPages() 
    Set that this RtfHeaderFooterGroup should have facing pages. If only a header / footer for all pages exists, then it will be copied to the left and right pages as well.
 public  void setHasTitlePage() 
    Set that this RtfHeaderFooterGroup should have a title page. If only a header / footer for all pages exists, then it will be copied to the first page as well.
 public  void setHeaderFooter(RtfHeaderFooter headerFooter,
    int displayAt) 
    Set a RtfHeaderFooter to be displayed at a certain position
 public  void setHeaderFooter(HeaderFooter headerFooter,
    int displayAt) 
    Set a HeaderFooter to be displayed at a certain position
 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) 
    Set the type of this RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER or RtfHeaderFooter.TYPE_FOOTER. Also sets the type for all RtfHeaderFooters of this RtfHeaderFooterGroup.
 public  void writeContent(OutputStream result) throws IOException 
    Write the content of this RtfHeaderFooterGroup.