Package com.lowagie.text
Interface DocListener
- All Superinterfaces:
AutoCloseable
,ElementListener
,EventListener
- All Known Implementing Classes:
Document
,DocWriter
,FdfWriter.Wrt
,HTMLWorker
,HtmlWriter
,PdfCopy
,PdfCopyFieldsImp
,PdfCopyFormsImp
,PdfDocument
,PdfSmartCopy
,PdfStamperImp
,PdfWriter
,UnembedFontPdfSmartCopy
A class that implements
DocListener
will perform some actions when some actions are performed on a
Document
.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Signals that theDocument
was closed and that no otherElements
will be added.boolean
newPage()
Signals that an new page has to be started.void
open()
Signals that theDocument
has been opened and thatElements
can be added.void
Resets the footer of this document.void
Resets the header of this document.void
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) Allows you to do left/right margin mirroring (odd/even pages)boolean
setMarginMirroringTopBottom
(boolean marginMirroringTopBottom) 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.Methods inherited from interface com.lowagie.text.ElementListener
add
-
Method Details
-
open
void open()Signals that theDocument
has been opened and thatElements
can be added. -
close
void close()Signals that theDocument
was closed and that no otherElements
will be added.The outputstream of every writer implementing
DocListener
will be closed.- Specified by:
close
in interfaceAutoCloseable
-
newPage
boolean newPage()Signals that an new page has to be started.- Returns:
true
if the page was added,false
if not.
-
setPageSize
Sets the pagesize.- Parameters:
pageSize
- the new pagesize- Returns:
- a
boolean
-
setMargins
boolean setMargins(float marginLeft, float marginRight, float marginTop, float marginBottom) Sets the margins.- Parameters:
marginLeft
- the margin on the leftmarginRight
- the margin on the rightmarginTop
- the margin on the topmarginBottom
- the margin on the bottom- Returns:
- a
boolean
-
setMarginMirroring
boolean setMarginMirroring(boolean marginMirroring) Allows you to do left/right margin mirroring (odd/even pages)- Parameters:
marginMirroring
- left/right margin mirroring (odd/even pages)- Returns:
- true if successful
-
setMarginMirroringTopBottom
boolean setMarginMirroringTopBottom(boolean marginMirroringTopBottom) Parameter that allows you to do top/bottom margin mirroring (odd/even pages)- Parameters:
marginMirroringTopBottom
- top/bottom margin mirroring (odd/even pages)- Returns:
- true if successful
- Since:
- 2.1.6
-
setPageCount
void setPageCount(int pageN) Sets the page number.- Parameters:
pageN
- the new page number
-
resetPageCount
void resetPageCount()Sets the page number to 0. -
resetHeader
void resetHeader()Resets the header of this document.
-