Package com.lowagie.text.rtf.document
Class RtfPageSetting
- java.lang.Object
-
- com.lowagie.text.rtf.RtfElement
-
- com.lowagie.text.rtf.document.RtfPageSetting
-
- All Implemented Interfaces:
RtfBasicElement,RtfExtendedElement,com.lowagie.text.RtfElementInterface
public class RtfPageSetting extends RtfElement implements RtfExtendedElement
The RtfPageSetting stores the page size / page margins for a RtfDocument. INTERNAL CLASS - NOT TO BE USED DIRECTLY- Version:
- $Id:RtfPageSetting.java 3126 2008-02-07 20:30:46Z hallm $
- Author:
- Mark Hall (Mark.Hall@mail.room3b.eu), Thomas Bickel (tmb99@inode.at)
-
-
Field Summary
-
Fields inherited from class com.lowagie.text.rtf.RtfElement
document, inHeader, inTable
-
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
-
-
Constructor Summary
Constructors Constructor Description RtfPageSetting(RtfDocument doc)Constructs a new RtfPageSetting object belonging to a RtfDocument.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetMarginBottom()Gets the bottom marginintgetMarginLeft()Gets the left marginintgetMarginRight()Gets the right marginintgetMarginTop()Gets the top marginintgetPageHeight()Gets the page heightintgetPageWidth()Gets the page widthvoidsetMarginBottom(int marginBottom)Sets the bottom marginvoidsetMarginLeft(int marginLeft)Sets the left margin to usevoidsetMarginRight(int marginRight)Sets the right margin to usevoidsetMarginTop(int marginTop)Sets the top margin to usevoidsetPageHeight(int pageHeight)Sets the page height to usevoidsetPageSize(com.lowagie.text.Rectangle pageSize)Set the page size to use.voidsetPageWidth(int pageWidth)Sets the page width to usevoidwriteContent(java.io.OutputStream out)unusedvoidwriteDefinition(java.io.OutputStream result)Writes the page size / page margin definitionvoidwriteSectionDefinition(java.io.OutputStream result)Writes the definition part for a new section-
Methods inherited from class com.lowagie.text.rtf.RtfElement
intToByteArray, isInTable, setInHeader, setInTable, setRtfDocument
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.lowagie.text.rtf.RtfBasicElement
setInHeader, setInTable, setRtfDocument
-
-
-
-
Constructor Detail
-
RtfPageSetting
public RtfPageSetting(RtfDocument doc)
Constructs a new RtfPageSetting object belonging to a RtfDocument.- Parameters:
doc- The RtfDocument this RtfPageSetting belongs to
-
-
Method Detail
-
writeContent
public void writeContent(java.io.OutputStream out) throws java.io.IOExceptionunused- Specified by:
writeContentin interfaceRtfBasicElement- Specified by:
writeContentin classRtfElement- Parameters:
out- TheOutputStreamto write the content to- Throws:
java.io.IOException
-
writeDefinition
public void writeDefinition(java.io.OutputStream result) throws java.io.IOExceptionWrites the page size / page margin definition- Specified by:
writeDefinitionin interfaceRtfExtendedElement- Parameters:
result- TheOutputStreamto write the element definition to- Throws:
java.io.IOException
-
writeSectionDefinition
public void writeSectionDefinition(java.io.OutputStream result) throws java.io.IOExceptionWrites the definition part for a new section- Throws:
java.io.IOException
-
getMarginBottom
public int getMarginBottom()
Gets the bottom margin- Returns:
- Returns the bottom margin
-
setMarginBottom
public void setMarginBottom(int marginBottom)
Sets the bottom margin- Parameters:
marginBottom- The bottom margin to use
-
getMarginLeft
public int getMarginLeft()
Gets the left margin- Returns:
- Returns the left margin
-
setMarginLeft
public void setMarginLeft(int marginLeft)
Sets the left margin to use- Parameters:
marginLeft- The left margin to use
-
getMarginRight
public int getMarginRight()
Gets the right margin- Returns:
- Returns the right margin
-
setMarginRight
public void setMarginRight(int marginRight)
Sets the right margin to use- Parameters:
marginRight- The right margin to use
-
getMarginTop
public int getMarginTop()
Gets the top margin- Returns:
- Returns the top margin
-
setMarginTop
public void setMarginTop(int marginTop)
Sets the top margin to use- Parameters:
marginTop- The top margin to use
-
getPageHeight
public int getPageHeight()
Gets the page height- Returns:
- Returns the page height
-
setPageHeight
public void setPageHeight(int pageHeight)
Sets the page height to use- Parameters:
pageHeight- The page height to use
-
getPageWidth
public int getPageWidth()
Gets the page width- Returns:
- Returns the page width
-
setPageWidth
public void setPageWidth(int pageWidth)
Sets the page width to use- Parameters:
pageWidth- The page width to use
-
setPageSize
public void setPageSize(com.lowagie.text.Rectangle pageSize)
Set the page size to use. This method will use guessFormat to try to guess the correct page format. If no format could be guessed, the sizes from the pageSize are used and the landscape setting is determined by comparing width and height;- Parameters:
pageSize- The pageSize to use
-
-