public class PdfPipelineOutput extends FileSinkPipelineOutput
internalId, internalName, log, TIMESTAMP_FORMAT
SERIALIZED_CLASS_NAME, TYPE
XML_SERIALIZED_CLASS_NAME
Constructor and Description |
---|
PdfPipelineOutput() |
Modifier and Type | Method and Description |
---|---|
DataWriter |
createDataWriter() |
PdfPipelineOutput |
fromRecord(Record source)
Loads this instance's state from a record and returns
this (for fluid API call chaining). |
XmlSerializable |
fromXmlElement(Element pipelineOutputElement) |
void |
generateJavaCode(JavaCodeBuilder code) |
String |
getCustomStyle()
Returns the custom CSS style applied to the PDF document (default
null ). |
FileSink |
getFileSink() |
String |
getName() |
PdfWriter.PageOrientation |
getPageOrientation()
Returns the page orientation for the PDF document (default
PdfWriter.PageOrientation#PORTRAIT ). |
PdfWriter.IPageSize |
getPageSize()
Returns the page size for the PDF document (default
PdfWriter.PageSize#LETTER ). |
PdfPipelineOutput |
setCustomStyle(String customStyle)
Specifies a custom CSS style to be applied to the PDF document (default
null ). |
PdfPipelineOutput |
setFileSink(FileSink fileSink) |
PdfPipelineOutput |
setPageOrientation(PdfWriter.PageOrientation pageOrientation)
Specifies the page orientation for the PDF document (default
PdfWriter.PageOrientation#PORTRAIT ). |
PdfPipelineOutput |
setPageSize(PdfWriter.IPageSize pageSize)
Specifies the page size for the PDF document.
|
PdfPipelineOutput |
setPageSize(String pageSize)
Specifies the page size for the PDF document using a CSS
page/size string value. |
Record |
toRecord() |
Element |
toXmlElement(Document document) |
generateSaveCode
getNestedPipelineOutput, getRootPipelineOutput
addExceptionProperties, assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalId
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord
newInstanceFromJson
forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml
addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties
public String getName()
getName
in class FileSinkPipelineOutput
public FileSink getFileSink()
getFileSink
in class FileSinkPipelineOutput
public PdfPipelineOutput setFileSink(FileSink fileSink)
setFileSink
in class FileSinkPipelineOutput
public DataWriter createDataWriter()
public PdfWriter.IPageSize getPageSize()
PdfWriter.PageSize#LETTER
).public PdfPipelineOutput setPageSize(PdfWriter.IPageSize pageSize)
PdfWriter.PageSize
enum (e.g., PdfWriter.PageSize#A4
, PdfWriter.PageSize#LETTER
),
or you can create a custom PdfWriter.IPageSize
implementation for any valid
CSS page/size
value, such as "10in 15in"
.
The default page size is PdfWriter.PageSize#LETTER
.public PdfPipelineOutput setPageSize(String pageSize)
page/size
string value.
This method allows you to define a custom page size using any valid CSS page/size
string, such as 10in 15in
.
The default page size is letter
.
public PdfWriter.PageOrientation getPageOrientation()
PdfWriter.PageOrientation#PORTRAIT
).public PdfPipelineOutput setPageOrientation(PdfWriter.PageOrientation pageOrientation)
PdfWriter.PageOrientation#PORTRAIT
).public String getCustomStyle()
null
).public PdfPipelineOutput setCustomStyle(String customStyle)
null
).
This style will be included in the generated PDF and can be used to customize the appearance
of the content, such as table styles, fonts, colors, etc.
You can provide a styling for the following HTML table structure:
<!DOCTYPE html>
<html lang='en-US' dir='ltr'>
<head>
</head>
<body>
<table>
<thead>
<tr>
<th class='col-0'>Field1</th>
<th class='col-1'>Field2</th>
</tr>
</thead>
<tbody>
<tr>
<td class='col-0'>Value1</td>
<td class='col-1'>Value2</td>
</tr>
</tbody>
</table>
</body>
</html>
public void generateJavaCode(JavaCodeBuilder code)
public PdfPipelineOutput fromRecord(Record source)
RecordSerializable
this
(for fluid API call chaining).
For fluid API call chaining, the overridden method should change the declared return type to its class.fromRecord
in interface RecordSerializable
fromRecord
in class PipelineOutput
public Record toRecord()
toRecord
in interface RecordSerializable
toRecord
in class Bean
public Element toXmlElement(Document document)
toXmlElement
in interface XmlSerializable
toXmlElement
in class PipelineOutput
public XmlSerializable fromXmlElement(Element pipelineOutputElement)
Copyright (c) 2006-2025 North Concepts Inc. All Rights Reserved.