|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.lowagie.text.DocWriter
An abstract Writer class for documents.
DocWriter is the abstract class of several writers such
as PdfWriter and HtmlWriter.
A DocWriter can be added as a DocListener
to a certain Document by getting an instance (see method
getInstance() in the specific writer-classes).
Every Element added to the original Document
will be written to the OutputStream of the listening
DocWriter.
Document,
DocListener| Field Summary | |
static byte |
EQUALS
This is some byte that is often used. |
static byte |
FORWARD
This is some byte that is often used. |
static byte |
GT
This is some byte that is often used. |
static byte |
LT
This is some byte that is often used. |
static byte |
NEWLINE
This is some byte that is often used. |
static byte |
QUOTE
This is some byte that is often used. |
static byte |
SPACE
This is some byte that is often used. |
static byte |
TAB
This is some byte that is often used. |
| Method Summary | |
boolean |
add(Element element)
Signals that an Element was added to the Document.
|
void |
close()
Signals that the Document was closed and that no other
Elements will be added. |
void |
flush()
Flushes the BufferedOutputStream. |
static byte[] |
getISOBytes(String text)
Converts a String into a Byte array
according to the ISO-8859-1 codepage. |
boolean |
isCloseStream()
Checks if the stream is to be closed on document close |
boolean |
isPaused()
Checks if writing is paused. |
boolean |
newPage()
Signals that an new page has to be started. |
void |
open()
Signals that the Document was opened. |
void |
pause()
Let the writer know that all writing has to be paused. |
void |
resetFooter()
Resets the footer of this document. |
void |
resetHeader()
Resets the header of this document. |
void |
resetPageCount()
Sets the page number to 0. |
void |
resume()
Let the writer know that writing may be resumed. |
void |
setCloseStream(boolean closeStream)
Sets the close state of the stream after document close |
void |
setFooter(HeaderFooter footer)
Changes the footer of this document. |
void |
setHeader(HeaderFooter header)
Changes the header of this document. |
boolean |
setMarginMirroring(boolean MarginMirroring)
Parameter that allows you to do margin mirroring (odd/even pages) |
boolean |
setMargins(float marginLeft,
float marginRight,
float marginTop,
float marginBottom)
Sets the margins. |
void |
setPageCount(int pageN)
Sets the page number. |
boolean |
setPageSize(Rectangle pageSize)
Sets the pagesize. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final byte NEWLINE
public static final byte TAB
public static final byte LT
public static final byte SPACE
public static final byte EQUALS
public static final byte QUOTE
public static final byte GT
public static final byte FORWARD
| Method Detail |
public boolean add(Element element)
throws DocumentException
Element was added to the Document.
This method should be overridden in the specific
DocWriter classes
derived from this abstract class.
add in interface ElementListener
element - A high level object to add
false
DocumentException - when a document isn't open yet, or has been closed
public void open()
Document was opened.
open in interface DocListenerpublic boolean setPageSize(Rectangle pageSize)
setPageSize in interface DocListenerpageSize - the new pagesize
boolean
public boolean setMargins(float marginLeft,
float marginRight,
float marginTop,
float marginBottom)
This does nothing. Has to be overridden if needed.
setMargins in interface DocListenermarginLeft - the margin on the leftmarginRight - the margin on the rightmarginTop - the margin on the topmarginBottom - the margin on the bottom
falsepublic boolean newPage()
This does nothing. Has to be overridden if needed.
newPage in interface DocListenertrue if the page was added, false if not.public void setHeader(HeaderFooter header)
This method should be overridden in the specific
DocWriter classes
derived from this abstract class if they actually support the use of
headers.
setHeader in interface DocListener
header - the new header
public void resetHeader()
This method should be overridden in the specific
DocWriter classes
derived from this abstract class if they actually support the use of
headers.
resetHeader in interface DocListener
public void setFooter(HeaderFooter footer)
This method should be overridden in the specific
DocWriter classes
derived from this abstract class if they actually support the use of
footers.
setFooter in interface DocListener
footer - the new footer
public void resetFooter()
This method should be overridden in the specific
DocWriter classes
derived from this abstract class if they actually support the use of
footers.
resetFooter in interface DocListener
public void resetPageCount()
This method should be overridden in the specific
DocWriter classes
derived from this abstract class if they actually support the use of
pagenumbers.
resetPageCount in interface DocListener
public void setPageCount(int pageN)
This method should be overridden in the specific
DocWriter classes
derived from this abstract class if they actually support the use of
pagenumbers.
setPageCount in interface DocListener
pageN - the new page number
public void close()
Document was closed and that no other
Elements will be added.
close in interface DocListenerpublic static final byte[] getISOBytes(String text)
String into a Byte array
according to the ISO-8859-1 codepage.
text - the text to be converted
public void pause()
public boolean isPaused()
true if writing temporarily has to be paused, false otherwise.public void resume()
public void flush()
BufferedOutputStream.
public boolean isCloseStream()
public void setCloseStream(boolean closeStream)
closeStream - true if the stream is closed on document closepublic boolean setMarginMirroring(boolean MarginMirroring)
DocListener
setMarginMirroring in interface DocListenerMarginMirroring -
DocListener.setMarginMirroring(boolean)
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||