DocWriter (iText API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.lowagie.text
Class DocWriter

java.lang.Object
  com.lowagie.text.DocWriter

All Implemented Interfaces:: DocListener, ElementListener, java.util.EventListener

Direct Known Subclasses:: HtmlWriter, PdfWriter, RtfWriter2

public abstract class DocWriter
extends java.lang.Object
implements DocListener
extends java.lang.Object
implements DocListener

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.

See Also:: Document, DocListener

Field Summary
`protected boolean`	`closeStream` Closes the stream on document close
`protected Document`	`document` This is the document that has to be written.
`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.
`protected boolean`	`open` Is the writer open for writing?
`protected OutputStreamCounter`	`os` The outputstream of this writer.
`protected Rectangle`	`pageSize` The pageSize.
`protected boolean`	`pause` Do we have to pause all writing actions?
`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.

Constructor Summary
`protected`	`DocWriter()`
`protected`	`DocWriter(Document document, java.io.OutputStream os)` Constructs a `DocWriter`.

Method Summary
`boolean`	`add(Element element)` Signals that an `Element` was added to the `Document`.
`protected void`	`addTabs(int indent)` Writes a number of tabs.
`void`	`close()` Signals that the `Document` was closed and that no other `Elements` will be added.
`void`	`flush()` Flushes the `BufferedOutputStream`.
`static byte[]`	`getISOBytes(java.lang.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 left/right margin mirroring (odd/even pages)
`boolean`	`setMarginMirroringTopBottom(boolean MarginMirroring)` Parameter that allows you to do top/bottom 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.
`protected void`	`write(java.lang.String string)` Writes a `String` to the `OutputStream`.
`protected void`	`write(java.lang.String key, java.lang.String value)` Writes a key-value pair to the outputstream.
`protected void`	`writeEnd()` Writes an endtag to the outputstream.
`protected void`	`writeEnd(java.lang.String tag)` Writes an endtag to the outputstream.
`protected boolean`	`writeMarkupAttributes(java.util.Properties markup)` Writes the markup attributes of the specified `MarkupAttributes` object to the `OutputStream`.
`protected void`	`writeStart(java.lang.String tag)` Writes a starttag to the outputstream.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail