com.lowagie.text

Interface DocListener

All Superinterfaces:

ElementListener, java.util.EventListener

All Known Implementing Classes:

Document, DocWriter, FdfWriter.Wrt, HTMLWorker, HtmlWriter, PdfCopy, PdfCopyFieldsImp, PdfDocument, PdfStamperImp, PdfWriter, RtfWriter, RtfWriter2, XmlWriter

public interface DocListener
extends ElementListener

A class that implements DocListener will perform some actions when some actions are performed on a Document.

See Also:

ElementListener, Document, DocWriter

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Watermark watermark) Signals that a Watermark was added to the Document.
void	clearTextWrap() Clears text wrapping around images (if applicable).
void	close() Signals that the Document was closed and that no other Elements will be added.
boolean	newPage() Signals that an new page has to be started.
void	open() Signals that the Document has been opened and that Elements can be added.
void	removeWatermark() Signals that a Watermark was removed from the Document.
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	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 interface com.lowagie.text.ElementListener

add

Method Detail

open

void open()

Signals that the Document has been opened and that Elements can be added.

setPageSize

boolean setPageSize(Rectangle pageSize)

Sets the pagesize.

Parameters:

pageSize - the new pagesize

Returns:

a boolean

add

boolean add(Watermark watermark)

Signals that a Watermark was added to the Document.

Parameters:

watermark - the Watermark object

Returns:

true if the element was added, false if not.

removeWatermark

void removeWatermark()

Signals that a Watermark was removed from the Document.

setMargins

boolean setMargins(float marginLeft,
                 float marginRight,
                 float marginTop,
                 float marginBottom)

Sets the margins.

Parameters:

marginLeft - the margin on the left

marginRight - the margin on the right

marginTop - the margin on the top

marginBottom - the margin on the bottom

Returns:

a boolean

setMarginMirroring

boolean setMarginMirroring(boolean marginMirroring)

Parameter that allows you to do margin mirroring (odd/even pages)

Parameters:

marginMirroring -

Returns:

true if succesfull

newPage

boolean newPage()
                throws DocumentException

Signals that an new page has to be started.

Returns:

true if the page was added, false if not.

Throws:

DocumentException - when a document isn't open yet, or has been closed

setHeader

void setHeader(HeaderFooter header)

Changes the header of this document.

Parameters:

header - the new header

resetHeader

void resetHeader()

Resets the header of this document.

setFooter

void setFooter(HeaderFooter footer)

Changes the footer of this document.

Parameters:

footer - the new footer

resetFooter

void resetFooter()

Resets the footer of this document.

resetPageCount

void resetPageCount()

Sets the page number to 0.

setPageCount

void setPageCount(int pageN)

Sets the page number.

Parameters:

pageN - the new page number

clearTextWrap

void clearTextWrap()
                   throws DocumentException

Clears text wrapping around images (if applicable). Method suggested by Pelikan Stephan

Throws:

DocumentException

close

void close()

Signals that the Document was closed and that no other Elements will be added.

The outputstream of every writer implementing DocListener will be closed.