1 BlockProperties
Class Ax.fop.BlockProperties
Constructor Summary
Method | Description |
---|---|
JSFOPBlockProperties() | Creates a new JSFOPBlockProperties instance. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
String | encodeXML(String input) | |
String | encodeXMLAttribute(String input) | In XML attributes you must escape " to |
String | formatStringUS(String format, Object[] args) | Use String. |
String | getIndent(int deep) | |
Map | getProperties() | |
FOPProperty | getProperty(String name) | |
Set | getPropertyNames() | |
Object | getPropertyOrDefault(String name, Object defval) | |
String | getPropertyOrDefault(String name, String defval) | |
double | getPropertyOrDefaultAsCentimeters(String name, double defval) | |
int | getPropertyOrDefaultAsInteger(String name, int defval) | |
boolean | hasProperty(String name) | |
boolean | hasPropertyStarting(String name) | |
T | setProperties(FOPPropertiesContainer source) | |
T | setProperty(String name, Object value) | |
T | setProperty(String name, double value, String units) |
Method Detail
JSFOPBlockProperties
-
JSFOPBlockProperties()
- Info:
-
Creates a new JSFOPBlockProperties instance.
encodeXMLAttribute
formatStringUS
getIndent
-
String getIndent(int deep)
- Parameters:
- deep -
- Returns:
getProperties
-
Map getProperties()
- Returns:
getProperty
-
FOPProperty getProperty(String name)
- Parameters:
- name -
- Returns:
getPropertyNames
-
Set getPropertyNames()
- Returns:
getPropertyOrDefault
getPropertyOrDefault
getPropertyOrDefaultAsCentimeters
-
double getPropertyOrDefaultAsCentimeters(String name, double defval)
- Parameters:
- name -
- defval -
- Returns:
getPropertyOrDefaultAsInteger
-
int getPropertyOrDefaultAsInteger(String name, int defval)
- Parameters:
- name -
- defval -
- Returns:
hasProperty
-
boolean hasProperty(String name)
- Parameters:
- name -
- Returns:
hasPropertyStarting
-
boolean hasPropertyStarting(String name)
- Parameters:
- name -
- Returns:
setProperties
-
T setProperties(FOPPropertiesContainer source)
- Parameters:
- source -
- Returns:
2 DocumentBuilder
Class Ax.fop.DocumentBuilder
Constructor Summary
Method | Description |
---|---|
JSFOPDocumentBuilder() | Creates a new JSFOPDocumentBuilder instance. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
FOPDocumentBuilder | addPageSequence(String name) | |
FOPDocumentBuilder | addSimplePageMaster(String name) | Add a default simple page master A4 with no margins |
FOPDocumentBuilder | addSimplePageMaster(String name, double marginLeft, double marginRight, double marginTop, double marginBottom) | |
FOPDocumentBuilder | addSimplePageMaster(String name, DIN din, double marginLeft, double marginRight, double marginTop, double marginBottom) | |
FOPDocumentBuilder | addSimplePageMaster(String name, PageSize size, double marginLeft, double marginRight, double marginTop, double marginBottom) | |
FOPRoot | build() | |
FOPRoot | createA4Document() | |
FOPRoot | createDocument(String pageSize) | |
FOPRoot | createDocument(DIN din) | |
FOPRoot | createDocument(double width, double height, double left, double right, double top, double bottom) | |
FOPDocumentBuilder | setDebug(String[] tags) | |
FOPDocumentBuilder | setDoubleSided(String name, String evenPageName, String oddPageName) |
Method Detail
JSFOPDocumentBuilder
-
JSFOPDocumentBuilder()
- Info:
-
Creates a new JSFOPDocumentBuilder instance.
addPageSequence
-
FOPDocumentBuilder addPageSequence(String name)
- Parameters:
- name -
- Returns:
addSimplePageMaster
-
FOPDocumentBuilder addSimplePageMaster(String name)
- Info:
-
Add a default simple page master A4 with no margins - Parameters:
- name -
- Returns:
addSimplePageMaster
-
FOPDocumentBuilder addSimplePageMaster(String name, double marginLeft, double marginRight, double marginTop, double marginBottom)
- Parameters:
- name -
- marginLeft -
- marginRight -
- marginTop -
- marginBottom -
- Returns:
addSimplePageMaster
-
FOPDocumentBuilder addSimplePageMaster(String name, DIN din, double marginLeft, double marginRight, double marginTop, double marginBottom)
- Parameters:
- name -
- din -
- marginLeft -
- marginRight -
- marginTop -
- marginBottom -
- Returns:
addSimplePageMaster
-
FOPDocumentBuilder addSimplePageMaster(String name, PageSize size, double marginLeft, double marginRight, double marginTop, double marginBottom)
- Parameters:
- name -
- size -
- marginLeft -
- marginRight -
- marginTop -
- marginBottom -
- Returns:
build
-
FOPRoot build()
- Returns:
createA4Document
-
FOPRoot createA4Document()
- Returns:
- A Root document with a simple page master DIN A4 with 1.0 cm margins
createDocument
createDocument
createDocument
-
FOPRoot createDocument(double width, double height, double left, double right, double top, double bottom)
- Parameters:
- width - of page in cm
- height - of page in cm
- left - size of region start
- right - size of region end
- top - size of region before
- bottom - size of region after
- Returns:
setDebug
-
FOPDocumentBuilder setDebug(String[] tags)
- Parameters:
- tags -
- Returns:
setDoubleSided
-
FOPDocumentBuilder setDoubleSided(String name, String evenPageName, String oddPageName)
- Parameters:
- name -
- evenPageName -
- oddPageName -
- Returns:
3 PageSize
Class Ax.fop.PageSize
Constructor Summary
Method | Description |
---|---|
JSFOPPageSize(String din) | Creates a JSFOPPageSize instance with the specified format. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
double | cm2Points(double cm) | |
double | getHeight() | |
double | getWidth() | |
boolean | isLandscape() | |
boolean | isPortrait() | |
void | lockRotation() | Prevent a future call to rotate. |
double | points2CM(double pt) | |
PageSize | rotate() | |
void | setDin(DIN din) | |
String | toString() |
Method Detail
JSFOPPageSize
-
JSFOPPageSize(String din)
- Info:
-
Creates a JSFOPPageSize instance with the specified format. - Parameters:
- din - standard size format: A3, A4, A5, B5, US_LEGAL, US_LETTER
cm2Points
-
double cm2Points(double cm)
- Parameters:
- cm -
- Returns:
getHeight
-
double getHeight()
- Returns:
getWidth
-
double getWidth()
- Returns:
isLandscape
-
boolean isLandscape()
- Returns:
isPortrait
-
boolean isPortrait()
- Returns:
lockRotation
-
void lockRotation()
- Info:
-
Prevent a future call to rotate.
points2CM
-
double points2CM(double pt)
- Parameters:
- pt -
- Returns:
rotate
-
PageSize rotate()
- Returns:
setDin
-
void setDin(DIN din)
- Parameters:
- din -
toString
-
String toString()
- Returns:
4 Processor
Class Ax.fop.Processor
Constructor Summary
Method | Description |
---|---|
JSFOPProcessor() | Creates a new instance of the FOP microservice. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
List | getFonts() | Returns a list with the available fonts. |
byte[] | getFontsSample() | Returns pdf file with the system fonts. |
byte[] | group() | SEE: function_fop_form_group TODO TODO TODO TODO |
boolean | isReady() | Checks if the FOP microservice is ready. |
boolean | isReady(boolean forceOnlineCheck) | Checks if the FOP microservice is ready. |
boolean | isReady(MicroserviceType arg0) | |
boolean | isReady(MicroserviceType arg0, boolean arg1) | |
byte[] | transform(String xml) | Transforms a string containing an xml to FO format. |
byte[] | transform(JSFile file) | Transforms the xml contents of a file to FO format. |
byte[] | transform(JSBlob blob) | Transforms the contents of a BLOB to FO format. |
Method Detail
JSFOPProcessor
-
JSFOPProcessor()
- Info:
-
Creates a new instance of the FOP microservice.
getFonts
-
List getFonts()
- Info:
-
Returns a list with the available fonts. - Returns:
- a list with the available fonts
getFontsSample
-
byte[] getFontsSample()
- Info:
-
Returns pdf file with the system fonts. - Returns:
- pdf with sysem fonts
group
-
byte[] group()
- Info:
-
SEE: function_fop_form_group TODO TODO TODO TODO - Returns:
- null
isReady
-
boolean isReady()
- Info:
-
Checks if the FOP microservice is ready. - Returns:
- true if FOP microservice is ready, false otherwise
isReady
-
boolean isReady(boolean forceOnlineCheck)
- Info:
-
Checks if the FOP microservice is ready. - Parameters:
- forceOnlineCheck - to disable or force whether the server is reachable
- Returns:
- true if FOP microservice is ready, false otherwise
isReady
-
boolean isReady(MicroserviceType arg0)
- Parameters:
- arg0 -
- Returns:
isReady
-
boolean isReady(MicroserviceType arg0, boolean arg1)
- Parameters:
- arg0 -
- arg1 -
- Returns:
transform
-
byte[] transform(String xml)
- Info:
-
Transforms a string containing an xml to FO format. - Parameters:
- xml - xml to process
- Returns:
- FO as byte array
transform
-
byte[] transform(JSFile file)
- Info:
-
Transforms the xml contents of a file to FO format. - Parameters:
- file - file that contains the xml to process
- Returns:
- FO as byte array
transform
-
byte[] transform(JSBlob blob)
- Info:
-
Transforms the contents of a BLOB to FO format. - Parameters:
- blob - BLOB containing the xml to process in binary
- Returns:
- FO as byte array
5 SinglePageTemplate
Class Ax.fop.SinglePageTemplate
Constructor Summary
Method | Description |
---|---|
JSFOPSinglePageTemplate() | |
JSFOPSinglePageTemplate(String din) | Creates a new JSFOPSinglePageTemplate with the specified format. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
JSFOPSinglePageTemplate | setAfter(Consumer<FOPStaticContent> after) | Configures the single page template after region. |
JSFOPSinglePageTemplate | setBefore(Consumer<FOPStaticContent> before) | Configures the single page template before region. |
JSFOPSinglePageTemplate | setBody(Consumer<FOPFlow> body) | Configures the single page template body. |
JSFOPSinglePageTemplate | setBodyFootNote(Consumer<FOPFootNote> footnote) | Configures the single page template footnote. |
JSFOPSinglePageTemplate | setEnd(Consumer<FOPStaticContent> end) | Configures the single page template end region. |
JSFOPSinglePageTemplate | setRoot(Consumer<FOPRoot> root) | Configures the single page template root. |
JSFOPSinglePageTemplate | setStart(Consumer<FOPStaticContent> start) | Configures the single page template start region. |
String | toFOP() | Converts the single page template to an xml in a string. |
Method Detail
JSFOPSinglePageTemplate
-
JSFOPSinglePageTemplate()
JSFOPSinglePageTemplate
-
JSFOPSinglePageTemplate(String din)
- Info:
-
Creates a new JSFOPSinglePageTemplate with the specified format. - Parameters:
- din - standard size format: A3, A4, A5, B5, US_LEGAL, US_LETTER
setAfter
-
JSFOPSinglePageTemplate setAfter(Consumer<FOPStaticContent> after)
- Info:
-
Configures the single page template after region. - Parameters:
- after - after region configuration function
- Returns:
- same object with after region configuration updated
setBefore
-
JSFOPSinglePageTemplate setBefore(Consumer<FOPStaticContent> before)
- Info:
-
Configures the single page template before region. - Parameters:
- before - before region configuration function
- Returns:
- same object with before region configuration updated
setBody
-
JSFOPSinglePageTemplate setBody(Consumer<FOPFlow> body)
- Info:
-
Configures the single page template body. - Parameters:
- body - body configuration function
- Returns:
- same object with body configuration updated
setBodyFootNote
-
JSFOPSinglePageTemplate setBodyFootNote(Consumer<FOPFootNote> footnote)
- Info:
-
Configures the single page template footnote. - Parameters:
- footnote - footnote configuration function
- Returns:
- same object with footnote configuration updated
setEnd
-
JSFOPSinglePageTemplate setEnd(Consumer<FOPStaticContent> end)
- Info:
-
Configures the single page template end region. - Parameters:
- end - end region configuration function
- Returns:
- same object with end region configuration updated
setRoot
-
JSFOPSinglePageTemplate setRoot(Consumer<FOPRoot> root)
- Info:
-
Configures the single page template root. - Parameters:
- root - root configuration function
- Returns:
- same object with root configuration updated
setStart
-
JSFOPSinglePageTemplate setStart(Consumer<FOPStaticContent> start)
- Info:
-
Configures the single page template start region. - Parameters:
- start - start region configuration function
- Returns:
- same object with start region configuration updated
toFOP
-
String toFOP()
- Info:
-
Converts the single page template to an xml in a string. - Returns:
- FO xml as String
6 Table
Class Ax.fop.Table
Constructor Summary
Method | Description |
---|---|
JSFOPTable(String[] columnNames) | Creates a new JSFOPTable instance with the specified column names. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
FOPTableColumn | addColumn() | |
FOPTableColumn | addColumn(String columnName) | |
FOPTableColumn | addColumn(FOPTableColumn column) | Add a table-column to table |
FOPTable | addColumns(String[] columnNames) | |
FOPTable | addResultSet(ResultSet rs) | |
N | build(Consumer<N> object) | |
FOPBlockProperties | createBlockProperties() | Allow from any object (for example root), create a BlockProperties. |
FOPTable | createColumns(int ncols) | Automatically create N columns to an empty table |
String | encodeXML(String input) | |
String | encodeXMLAttribute(String input) | In XML attributes you must escape " to |
FOPTable | forEach(Consumer<FOPTableColumn> column) | |
String | formatStringUS(String format, Object[] args) | Use String. |
FOPTableBody | getBody() | |
FOPTableColumn | getColumn(int column) | |
int | getColumnCount() | |
List | getColumns() | |
List | getDebug() | |
FOPTableFooter | getFooter() | |
FOPTableHeader | getHeader() | |
double | getHeight() | Try to go back component till we get a height, till SimplePageMaster |
String | getIndent(int deep) | |
P | getParent() | |
Map | getProperties() | |
FOPProperty | getProperty(String name) | |
Set | getPropertyNames() | |
Object | getPropertyOrDefault(String name, Object defval) | |
String | getPropertyOrDefault(String name, String defval) | |
double | getPropertyOrDefaultAsCentimeters(String name, double defval) | |
int | getPropertyOrDefaultAsInteger(String name, int defval) | |
FOPRoot | getRoot() | |
String | getTagName() | |
int | getUID() | |
double | getWidth() | Try to go back component till we get a width, till SimplePageMaster, BlockContainer, InlineContainer |
boolean | hasDebug(String tagName) | |
boolean | hasProperty(String name) | |
boolean | hasPropertyStarting(String name) | |
boolean | isTerminal() | |
void | log(String msg) | |
void | onDebug() | |
void | onDebug() | Subclass may decide how to show component in debug mode |
FOPTable | pack() | Given data in table, compute the width in percents |
FOPBlock | setCaption(String text) | |
N | setDebug(String[] tags) | |
T | setProperties(FOPPropertiesContainer source) | |
T | setProperty(String name, Object value) | |
T | setProperty(String name, double value, String units) | |
void | setTerminal() | |
String | toFOP(int deep) | |
String | toFOP() | |
String | toString() |
Method Detail
JSFOPTable
-
JSFOPTable(String[] columnNames)
- Info:
-
Creates a new JSFOPTable instance with the specified column names. - Parameters:
- columnNames - column names, one parameter per name
addColumn
-
FOPTableColumn addColumn()
- Returns:
addColumn
-
FOPTableColumn addColumn(String columnName)
- Parameters:
- columnName -
- Returns:
addColumn
-
FOPTableColumn addColumn(FOPTableColumn column)
- Info:
-
Add a table-column to table - Parameters:
- column -
- Returns:
addColumns
build
-
N build(Consumer<N> object)
- Parameters:
- object -
- Returns:
createBlockProperties
-
FOPBlockProperties createBlockProperties()
- Info:
-
Allow from any object (for example root), create a BlockProperties. It's very useful on Javascript to avoid the need to expose the class to Ax.fop package declaration. TODO: move to documentbuilder!!! - Returns:
createColumns
-
FOPTable createColumns(int ncols)
- Info:
-
Automatically create N columns to an empty table - Parameters:
- ncols -
- Returns:
encodeXMLAttribute
forEach
-
FOPTable forEach(Consumer<FOPTableColumn> column)
- Parameters:
- column -
- Returns:
formatStringUS
getBody
-
FOPTableBody getBody()
- Returns:
getColumn
-
FOPTableColumn getColumn(int column)
- Parameters:
- column -
- Returns:
getColumnCount
-
int getColumnCount()
- Returns:
getColumns
-
List getColumns()
- Returns:
getDebug
-
List getDebug()
- Returns:
getFooter
-
FOPTableFooter getFooter()
- Returns:
getHeader
-
FOPTableHeader getHeader()
- Returns:
getHeight
-
double getHeight()
- Info:
-
Try to go back component till we get a height, till SimplePageMaster - Returns:
getIndent
-
String getIndent(int deep)
- Parameters:
- deep -
- Returns:
getParent
-
P getParent()
- Returns:
getProperties
-
Map getProperties()
- Returns:
getProperty
-
FOPProperty getProperty(String name)
- Parameters:
- name -
- Returns:
getPropertyNames
-
Set getPropertyNames()
- Returns:
getPropertyOrDefault
getPropertyOrDefault
getPropertyOrDefaultAsCentimeters
-
double getPropertyOrDefaultAsCentimeters(String name, double defval)
- Parameters:
- name -
- defval -
- Returns:
getPropertyOrDefaultAsInteger
-
int getPropertyOrDefaultAsInteger(String name, int defval)
- Parameters:
- name -
- defval -
- Returns:
getRoot
-
FOPRoot getRoot()
- Returns:
getTagName
-
String getTagName()
- Returns:
getUID
-
int getUID()
- Returns:
getWidth
-
double getWidth()
- Info:
-
Try to go back component till we get a width, till SimplePageMaster, BlockContainer, InlineContainer - Returns:
hasDebug
-
boolean hasDebug(String tagName)
- Parameters:
- tagName -
- Returns:
hasProperty
-
boolean hasProperty(String name)
- Parameters:
- name -
- Returns:
hasPropertyStarting
-
boolean hasPropertyStarting(String name)
- Parameters:
- name -
- Returns:
isTerminal
-
boolean isTerminal()
- Returns:
log
-
void log(String msg)
- Parameters:
- msg -
onDebug
-
void onDebug()
onDebug
-
void onDebug()
- Info:
-
Subclass may decide how to show component in debug mode
pack
-
FOPTable pack()
- Info:
-
Given data in table, compute the width in percents - Returns:
setDebug
-
N setDebug(String[] tags)
- Parameters:
- tags -
- Returns:
setProperties
-
T setProperties(FOPPropertiesContainer source)
- Parameters:
- source -
- Returns:
setProperty
setTerminal
-
void setTerminal()
toFOP
-
String toFOP(int deep)
- Parameters:
- deep -
- Returns:
toFOP
-
String toFOP()
- Returns:
toString
-
String toString()
- Returns:
7 Text
Class Ax.fop.Text
Constructor Summary
Method | Description |
---|---|
JSFOPText(String text) | Creates a new JSFOPText instance containing the specified text. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
void | addItem(AFOPObject item) | |
N | build(Consumer<N> object) | |
FOPBlockProperties | createBlockProperties() | Allow from any object (for example root), create a BlockProperties. |
String | encodeXML(String input) | |
String | encodeXMLAttribute(String input) | In XML attributes you must escape " to |
String | formatStringUS(String format, Object[] args) | Use String. |
List | getChildren() | |
List | getDebug() | |
double | getHeight() | Try to go back component till we get a height, till SimplePageMaster |
String | getIndent(int deep) | |
String | getInnerText() | Recursively get inner text to try to compute width |
List | getItems() | |
P | getParent() | |
Map | getProperties() | |
FOPProperty | getProperty(String name) | |
Set | getPropertyNames() | |
Object | getPropertyOrDefault(String name, Object defval) | |
String | getPropertyOrDefault(String name, String defval) | |
double | getPropertyOrDefaultAsCentimeters(String name, double defval) | |
int | getPropertyOrDefaultAsInteger(String name, int defval) | |
FOPRoot | getRoot() | |
String | getTagName() | |
int | getUID() | |
double | getWidth() | |
double | getWidth() | Try to go back component till we get a width, till SimplePageMaster, BlockContainer, InlineContainer |
boolean | hasDebug(String tagName) | |
boolean | hasProperty(String name) | |
boolean | hasPropertyStarting(String name) | |
boolean | isTerminal() | |
void | log(String msg) | |
void | onDebug() | |
void | onDebug() | Subclass may decide how to show component in debug mode |
N | setDebug(String[] tags) | |
T | setProperties(FOPPropertiesContainer source) | |
T | setProperty(String name, Object value) | |
T | setProperty(String name, double value, String units) | |
FOPBlock | setSpan(String span) | |
void | setTerminal() | |
String | toFOP(int deep) | |
String | toFOP() | |
String | toString() |
Method Detail
JSFOPText
-
JSFOPText(String text)
- Info:
-
Creates a new JSFOPText instance containing the specified text. - Parameters:
- text - block text content
addItem
-
void addItem(AFOPObject item)
- Parameters:
- item -
build
-
N build(Consumer<N> object)
- Parameters:
- object -
- Returns:
createBlockProperties
-
FOPBlockProperties createBlockProperties()
- Info:
-
Allow from any object (for example root), create a BlockProperties. It's very useful on Javascript to avoid the need to expose the class to Ax.fop package declaration. TODO: move to documentbuilder!!! - Returns:
encodeXMLAttribute
formatStringUS
getChildren
-
List getChildren()
- Returns:
- Recursively get the list of all children
getDebug
-
List getDebug()
- Returns:
getHeight
-
double getHeight()
- Info:
-
Try to go back component till we get a height, till SimplePageMaster - Returns:
getIndent
-
String getIndent(int deep)
- Parameters:
- deep -
- Returns:
getInnerText
-
String getInnerText()
- Info:
-
Recursively get inner text to try to compute width - Returns:
getItems
-
List getItems()
- Returns:
getParent
-
P getParent()
- Returns:
getProperties
-
Map getProperties()
- Returns:
getProperty
-
FOPProperty getProperty(String name)
- Parameters:
- name -
- Returns:
getPropertyNames
-
Set getPropertyNames()
- Returns:
getPropertyOrDefault
getPropertyOrDefault
getPropertyOrDefaultAsCentimeters
-
double getPropertyOrDefaultAsCentimeters(String name, double defval)
- Parameters:
- name -
- defval -
- Returns:
getPropertyOrDefaultAsInteger
-
int getPropertyOrDefaultAsInteger(String name, int defval)
- Parameters:
- name -
- defval -
- Returns:
getRoot
-
FOPRoot getRoot()
- Returns:
getTagName
-
String getTagName()
- Returns:
getUID
-
int getUID()
- Returns:
getWidth
-
double getWidth()
- Returns:
getWidth
-
double getWidth()
- Info:
-
Try to go back component till we get a width, till SimplePageMaster, BlockContainer, InlineContainer - Returns:
hasDebug
-
boolean hasDebug(String tagName)
- Parameters:
- tagName -
- Returns:
hasProperty
-
boolean hasProperty(String name)
- Parameters:
- name -
- Returns:
hasPropertyStarting
-
boolean hasPropertyStarting(String name)
- Parameters:
- name -
- Returns:
isTerminal
-
boolean isTerminal()
- Returns:
log
-
void log(String msg)
- Parameters:
- msg -
onDebug
-
void onDebug()
onDebug
-
void onDebug()
- Info:
-
Subclass may decide how to show component in debug mode
setDebug
-
N setDebug(String[] tags)
- Parameters:
- tags -
- Returns:
setProperties
-
T setProperties(FOPPropertiesContainer source)
- Parameters:
- source -
- Returns:
setProperty
setTerminal
-
void setTerminal()
toFOP
-
String toFOP(int deep)
- Parameters:
- deep -
- Returns:
toFOP
-
String toFOP()
- Returns:
toString
-
String toString()
- Returns:
8 Watermark
Class Ax.fop.Watermark
Constructor Summary
Method | Description |
---|---|
JSFOPWatermark(Object src, String position) | Creates a JSFOPWatermark instance, with the given src watermark at the specified position. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
void | setOverlay(InputStream in, Pages pages) | |
void | setOverlay(File file, Pages pages) | |
void | setOverlay(String fileName, Pages pages) | |
byte[] | toPDF() |
Method Detail
JSFOPWatermark
setOverlay
-
void setOverlay(InputStream in, Pages pages)
- Parameters:
- in -
- pages -
toPDF
-
byte[] toPDF()
- Returns:
9 XHTML2FO
Class Ax.fop.XHTML2FO
Constructor Summary
Method | Description |
---|---|
JSXHTML2FO() | Creates a new XHTML to FO transformer instance. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | isReady() | Checks if the XHTML2FO microservice is ready. |
boolean | isReady(boolean forceOnlineCheck) | Checks if the XHTML2FO microservice is ready. |
boolean | isReady(MicroserviceType arg0) | |
boolean | isReady(MicroserviceType arg0, boolean arg1) | |
String | toFOBody(String xhtml) | Transforms a well formed XHTML document to be used as an include of another FO document. |
String | toFORoot(String xhtml) | Transforms onvert a well formed XHTML document to complete FO document including root and master pages. |
byte[] | toPDF(String xhtml) | Transforms a well formed XHTML document directly to PDF, converting it first to FO and then from FO to PDF. |
Method Detail
JSXHTML2FO
-
JSXHTML2FO()
- Info:
-
Creates a new XHTML to FO transformer instance.
isReady
-
boolean isReady()
- Info:
-
Checks if the XHTML2FO microservice is ready. - Returns:
- true if microservice is ready, false otherwise
isReady
-
boolean isReady(boolean forceOnlineCheck)
- Info:
-
Checks if the XHTML2FO microservice is ready. - Parameters:
- forceOnlineCheck - to disable or force whether the server is reachable
- Returns:
- true if microservice is ready, false otherwise
isReady
-
boolean isReady(MicroserviceType arg0)
- Parameters:
- arg0 -
- Returns:
isReady
-
boolean isReady(MicroserviceType arg0, boolean arg1)
- Parameters:
- arg0 -
- arg1 -
- Returns:
toFOBody
toFORoot
toPDF
-
byte[] toPDF(String xhtml)
- Info:
-
Transforms a well formed XHTML document directly to PDF, converting it first to FO and then from FO to PDF. - Parameters:
- xhtml - XHTML to convert
- Returns:
- pdf file as byte array