Package com.lowagie.text.xml
Class SAXiTextHandler<T extends XmlPeer>
java.lang.Object
org.xml.sax.helpers.DefaultHandler
com.lowagie.text.xml.SAXiTextHandler<T>
- All Implemented Interfaces:
ContentHandler
,DTDHandler
,EntityResolver
,ErrorHandler
- Direct Known Subclasses:
SAXmyHandler
,SAXmyHtmlHandler
This class is a Handler that controls the iText XML to PDF conversion. Subclass it, if you want to change the way
iText translates XML to PDF.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate BaseFont
private float
current margin of a page.protected int
Counts the number of chapters in this document.private boolean
This is a flag that can be set, if you want to open and close the Document-object yourself.protected Chunk
This is the current chunk to which characters can be added.protected DocListener
This is the resulting document.protected boolean
This is the current chunk to which characters can be added.private float
current margin of a page.This hashmap contains all the custom keys and peers.private float
current margin of a page.This is aStack
of objects, waiting to be added to the document.private float
current margin of a page. -
Constructor Summary
ConstructorsConstructorDescriptionSAXiTextHandler
(DocListener document) SAXiTextHandler
(DocListener document, Map<String, T> myTags) SAXiTextHandler
(DocListener document, Map<String, T> myTags, BaseFont bf) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
void
characters
(char[] ch, int start, int length) This method gets called when characters are encountered.void
endElement
(String uri, String lname, String name) This method gets called when an end tag is encountered.void
handleEndingTags
(String name) This method deals with the starting tags.void
handleStartingTags
(String name, Properties attributes) This method deals with the starting tags.void
ignorableWhitespace
(char[] ch, int start, int length) This method gets called when ignorable white space encountered.protected boolean
isDocumentRoot
(String tag) Checks if a certain tag corresponds with the roottag.private boolean
Checks if a certain tag corresponds with the newpage-tag.private boolean
Checks if a certain tag corresponds with the newpage-tag.private boolean
isNotBlank
(String text) void
setBaseFont
(BaseFont bf) Sets the font that has to be used.void
setControlOpenClose
(boolean controlOpenClose) Sets the parameter that allows you to enable/disable the control over the Document.open() and Document.close() method.void
startElement
(String uri, String localName, String name, Attributes attributes) This method gets called when a start tag is encountered.Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, error, fatalError, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.xml.sax.ContentHandler
declaration
-
Field Details
-
document
This is the resulting document. -
stack
This is aStack
of objects, waiting to be added to the document. -
chapters
protected int chaptersCounts the number of chapters in this document. -
currentChunk
This is the current chunk to which characters can be added. -
ignore
protected boolean ignoreThis is the current chunk to which characters can be added. -
myTags
This hashmap contains all the custom keys and peers. -
controlOpenClose
private boolean controlOpenCloseThis is a flag that can be set, if you want to open and close the Document-object yourself. -
topMargin
private float topMargincurrent margin of a page. -
rightMargin
private float rightMargincurrent margin of a page. -
leftMargin
private float leftMargincurrent margin of a page. -
bottomMargin
private float bottomMargincurrent margin of a page. -
bf
-
-
Constructor Details
-
SAXiTextHandler
- Parameters:
document
- the DocListener
-
SAXiTextHandler
- Parameters:
document
- the DocListenermyTags
- a Map of the tagsbf
- the base class for the supported fonts
-
SAXiTextHandler
- Parameters:
document
- the DocListenermyTags
- a Map of the tags
-
-
Method Details
-
setControlOpenClose
public void setControlOpenClose(boolean controlOpenClose) Sets the parameter that allows you to enable/disable the control over the Document.open() and Document.close() method.If you set this parameter to true (= default), the parser will open the Document object when the start-root-tag is encountered and close it when the end-root-tag is met. If you set it to false, you have to open and close the Document object yourself.
- Parameters:
controlOpenClose
- set this to false if you plan to open/close the Document yourself
-
startElement
This method gets called when a start tag is encountered.- Specified by:
startElement
in interfaceContentHandler
- Overrides:
startElement
in classDefaultHandler
- Parameters:
uri
- the Uniform Resource IdentifierlocalName
- the local name (without prefix), or the empty string if Namespace processing is not being performed.name
- the name of the tag that is encounteredattributes
- the list of attributes
-
handleStartingTags
This method deals with the starting tags.- Parameters:
name
- the name of the tagattributes
- the list of attributes
-
ignorableWhitespace
public void ignorableWhitespace(char[] ch, int start, int length) This method gets called when ignorable white space encountered.- Specified by:
ignorableWhitespace
in interfaceContentHandler
- Overrides:
ignorableWhitespace
in classDefaultHandler
- Parameters:
ch
- an array of charactersstart
- the start position in the arraylength
- the number of characters to read from the array
-
characters
public void characters(char[] ch, int start, int length) This method gets called when characters are encountered.- Specified by:
characters
in interfaceContentHandler
- Overrides:
characters
in classDefaultHandler
- Parameters:
ch
- an array of charactersstart
- the start position in the arraylength
- the number of characters to read from the array
-
setBaseFont
Sets the font that has to be used.- Parameters:
bf
- the base class for the supported fonts
-
endElement
This method gets called when an end tag is encountered.- Specified by:
endElement
in interfaceContentHandler
- Overrides:
endElement
in classDefaultHandler
- Parameters:
uri
- the Uniform Resource Identifierlname
- the local name (without prefix), or the empty string if Namespace processing is not being performed.name
- the name of the tag that ends
-
handleEndingTags
This method deals with the starting tags.- Parameters:
name
- the name of the tag
-
isNotBlank
-
addImage
- Throws:
EmptyStackException
-
isNewpage
Checks if a certain tag corresponds with the newpage-tag.- Parameters:
tag
- a presumed tagname- Returns:
true
orfalse
-
isNewline
Checks if a certain tag corresponds with the newpage-tag.- Parameters:
tag
- a presumed tagname- Returns:
true
orfalse
-
isDocumentRoot
Checks if a certain tag corresponds with the roottag.- Parameters:
tag
- a presumed tagname- Returns:
true
if tag equalsitext
,false
otherwise.
-