|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.itextpdf.tool.xml.pipeline.AbstractPipeline<MapContext>
com.itextpdf.tool.xml.pipeline.end.PdfWriterPipeline
public class PdfWriterPipeline
This pipeline writes to a Document.
| Field Summary | |
|---|---|
static String |
CONTINUOUS
The key for the a boolean in the MapContext used as CustomContext. |
static String |
DOCUMENT
The key for the Document in the MapContext used as CustomContext. |
static String |
WRITER
The key for the PdfWriter in the MapContext used as CustomContext. |
| Constructor Summary | |
|---|---|
PdfWriterPipeline()
|
|
PdfWriterPipeline(Document doc,
PdfWriter writer)
|
|
PdfWriterPipeline(Pipeline<?> next)
|
|
| Method Summary | |
|---|---|
Pipeline<?> |
close(WorkerContext context,
Tag t,
ProcessObject po)
Just calls getNext. Override this to get notified on encountered closing tags. |
Pipeline<?> |
content(WorkerContext context,
Tag currentTag,
String text,
ProcessObject po)
Just calls getNext. Override this to get notified on encountered content. |
Pipeline<?> |
init(WorkerContext context)
The init method allows implementation to initialize the pipeline. |
Pipeline<?> |
open(WorkerContext context,
Tag t,
ProcessObject po)
Just calls getNext. Override this to get notified on encountered opening tags. |
void |
setDocument(Document document)
The document to write to. |
void |
setWriter(PdfWriter writer)
The writer used to write to the document. |
| Methods inherited from class com.itextpdf.tool.xml.pipeline.AbstractPipeline |
|---|
getContextKey, getLocalContext, getNext, setNext |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String DOCUMENT
Document in the MapContext used as CustomContext.
public static final String WRITER
PdfWriter in the MapContext used as CustomContext.
public static final String CONTINUOUS
MapContext used as CustomContext. Setting to true enables swallowing of DocumentExceptions
| Constructor Detail |
|---|
public PdfWriterPipeline()
public PdfWriterPipeline(Pipeline<?> next)
next - the next pipeline if any.
public PdfWriterPipeline(Document doc,
PdfWriter writer)
doc - the documentwriter - the writer| Method Detail |
|---|
public Pipeline<?> init(WorkerContext context)
throws PipelineException
PipelineWorkerContext.put(String, CustomContext).
init in interface Pipeline<MapContext>init in class AbstractPipeline<MapContext>context - the WorkerContext
PipelineException - can be thrown to indicate that something went wrong.
public Pipeline<?> open(WorkerContext context,
Tag t,
ProcessObject po)
throws PipelineException
AbstractPipeline
open in interface Pipeline<MapContext>open in class AbstractPipeline<MapContext>context - the WorkerContextt - the Tagpo - a processObject to put Writables in
PipelineException - can be thrown to indicate that something went wrong.
public Pipeline<?> content(WorkerContext context,
Tag currentTag,
String text,
ProcessObject po)
throws PipelineException
AbstractPipeline
content in interface Pipeline<MapContext>content in class AbstractPipeline<MapContext>context - the WorkerContextcurrentTag - the Tagtext - the contentpo - a processObject to put Writables in
PipelineException - can be thrown to indicate that something went wrong.
public Pipeline<?> close(WorkerContext context,
Tag t,
ProcessObject po)
throws PipelineException
AbstractPipeline
close in interface Pipeline<MapContext>close in class AbstractPipeline<MapContext>context - the WorkerContextt - the Tagpo - a processObject to put Writables in
PipelineException - can be thrown to indicate that something went wrong.public void setDocument(Document document)
document - the Documentpublic void setWriter(PdfWriter writer)
writer - the writer.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||