public abstract class DocWriter extends Object implements DocListener
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
Modifier and Type | Field and Description |
---|---|
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.
|
Modifier | Constructor and Description |
---|---|
protected |
DocWriter() |
protected |
DocWriter(Document document, OutputStream os)
Constructs a DocWriter .
|
Modifier and Type | Method and Description |
---|---|
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(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 |
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
|
boolean |
setMarginMirroring(boolean MarginMirroring)
This implementation only returns false and doesn't do anything.
|
boolean |
setMarginMirroringTopBottom(boolean MarginMirroring)
This implementation only returns false and doesn't do anything.
|
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(String string)
Writes a String to the OutputStream .
|
protected void |
write(String key, String value)
Writes a key-value pair to the outputstream.
|
protected void |
writeEnd()
Writes an endtag to the outputstream.
|
protected void |
writeEnd(String tag)
Writes an endtag to the outputstream.
|
protected boolean |
writeMarkupAttributes(Properties markup)
Writes the markup attributes of the specified MarkupAttributes object to the OutputStream .
|
protected void |
writeStart(String tag)
Writes a starttag to the outputstream.
|
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
protected Rectangle pageSize
protected Document document
protected OutputStreamCounter os
protected boolean open
protected boolean pause
protected boolean closeStream
protected DocWriter()
protected DocWriter(Document document, OutputStream os)
DocWriter
.
document
- The Document
that has to be written
os
- The OutputStream
the writer has to write to.
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.
- Specified by:
-
add
in interface ElementListener
- Parameters:
-
element
- A high level object to add
- Returns:
-
false
- Throws:
-
DocumentException
- when a document isn't open yet, or has been closed
-
open
public void open()
Signals that the Document
was opened.
- Specified by:
-
open
in interface DocListener
-
setPageSize
public boolean setPageSize(Rectangle pageSize)
Sets the pagesize.
- Specified by:
-
setPageSize
in interface DocListener
- Parameters:
-
pageSize
- the new pagesize
- Returns:
-
a
boolean
-
setMargins
public boolean setMargins(float marginLeft,
float marginRight,
float marginTop,
float marginBottom)
Sets the margins.
This does nothing. Has to be overridden if needed.
- Specified by:
-
setMargins
in interface DocListener
- 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:
-
false
-
newPage
public boolean newPage()
Signals that an new page has to be started.
This does nothing. Has to be overridden if needed.
- Specified by:
-
newPage
in interface DocListener
- Returns:
-
true
if the page was added, false
if not.
-
resetPageCount
public void resetPageCount()
Sets the page number to 0.
This method should be overridden in the specific DocWriter classes derived from this abstract class if they actually support the use of pagenumbers.
- Specified by:
-
resetPageCount
in interface DocListener
-
setPageCount
public void setPageCount(int pageN)
Sets the page number.
This method should be overridden in the specific DocWriter classes derived from this abstract class if they actually support the use of pagenumbers.
- Specified by:
-
setPageCount
in interface DocListener
- Parameters:
-
pageN
- the new page number
-
close
public void close()
Signals that the Document
was closed and that no other Elements
will be added.
- Specified by:
-
close
in interface DocListener
-
getISOBytes
public static final byte[] getISOBytes(String text)
Converts a String
into a Byte
array according to the ISO-8859-1 codepage.
- Parameters:
-
text
- the text to be converted
- Returns:
-
the conversion result
-
pause
public void pause()
Let the writer know that all writing has to be paused.
-
isPaused
public boolean isPaused()
Checks if writing is paused.
- Returns:
-
true
if writing temporarily has to be paused, false
otherwise.
-
resume
public void resume()
Let the writer know that writing may be resumed.
-
flush
public void flush()
Flushes the BufferedOutputStream
.
-
write
protected void write(String string)
throws IOException
Writes a String
to the OutputStream
.
- Parameters:
-
string
- the String
to write
- Throws:
-
IOException
-
addTabs
protected void addTabs(int indent)
throws IOException
Writes a number of tabs.
- Parameters:
-
indent
- the number of tabs to add
- Throws:
-
IOException
-
write
protected void write(String key,
String value)
throws IOException
Writes a key-value pair to the outputstream.
- Parameters:
-
key
- the name of an attribute
-
value
- the value of an attribute
- Throws:
-
IOException
-
writeStart
protected void writeStart(String tag)
throws IOException
Writes a starttag to the outputstream.
- Parameters:
-
tag
- the name of the tag
- Throws:
-
IOException
-
writeEnd
protected void writeEnd(String tag)
throws IOException
Writes an endtag to the outputstream.
- Parameters:
-
tag
- the name of the tag
- Throws:
-
IOException
-
writeEnd
protected void writeEnd()
throws IOException
Writes an endtag to the outputstream.
- Throws:
-
IOException
-
writeMarkupAttributes
protected boolean writeMarkupAttributes(Properties markup)
throws IOException
Writes the markup attributes of the specified MarkupAttributes
object to the OutputStream
.
- Parameters:
-
markup
- a Properties
collection to write.
- Returns:
-
true, if writing the markup attributes succeeded
- Throws:
-
IOException
-
isCloseStream
public boolean isCloseStream()
Checks if the stream is to be closed on document close
- Returns:
-
true if the stream is closed on document close
-
setCloseStream
public void setCloseStream(boolean closeStream)
Sets the close state of the stream after document close
- Parameters:
-
closeStream
- true if the stream is closed on document close
-
setMarginMirroring
public boolean setMarginMirroring(boolean MarginMirroring)
This implementation only returns false and doesn't do anything. Perhaps you were looking for the similarly named method of the Document class.
- Specified by:
-
setMarginMirroring
in interface DocListener
- Returns:
-
true if successful
- See Also:
-
DocListener.setMarginMirroring(boolean)
-
setMarginMirroringTopBottom
public boolean setMarginMirroringTopBottom(boolean MarginMirroring)
This implementation only returns false and doesn't do anything. Perhaps you were looking for the similarly named method of the Document class.
- Specified by:
-
setMarginMirroringTopBottom
in interface DocListener
- Returns:
-
true if successful
- Since:
-
2.1.6
- See Also:
-
DocListener.setMarginMirroring(boolean)
Copyright © 2016. All rights reserved.