1 BlockProperties

Class Ax.fop.BlockProperties


Creates a JSFOPBlockProperties object to use FOPBlockProperties class. FOPBlockProperties is used o configure the block properties.

Constructor Summary

Method
Description
Creates a new JSFOPBlockProperties instance.

Method Summary

Modifier and Type
Method
Description
@org.eclipse.jdt.annotation.NonNull java.lang.String 
encodeXML(@org.eclipse.jdt.annotation.Nullable java.lang.String input)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
encodeXMLAttribute(@org.eclipse.jdt.annotation.NonNull java.lang.String input)
In XML attributes you must escape " to
@org.eclipse.jdt.annotation.NonNull java.lang.String 
formatStringUS(@org.eclipse.jdt.annotation.NonNull java.lang.String format, Object[] args)
Use String.
@org.eclipse.jdt.annotation.NonNull java.lang.String 
getIndent(int deep)
@org.eclipse.jdt.annotation.NonNull java.util.Map 
getProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
Set 
@org.eclipse.jdt.annotation.NonNull java.lang.Object 
getPropertyOrDefault(@org.eclipse.jdt.annotation.NonNull java.lang.String name,@org.eclipse.jdt.annotation.NonNull java.lang.Object defval)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
getPropertyOrDefault(@org.eclipse.jdt.annotation.NonNull java.lang.String name, @org.eclipse.jdt.annotation.NonNull java.lang.String defval)
double 
getPropertyOrDefaultAsCentimeters(@org.eclipse.jdt.annotation.NonNull java.lang.String name,double defval)
int 
getPropertyOrDefaultAsInteger(@org.eclipse.jdt.annotation.NonNull java.lang.String name, int defval)
boolean 
hasProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
boolean 
hasPropertyStarting(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
nonNull(@org.eclipse.jdt.annotation.NonNull java.lang.String s)
setProperties(@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.properties.FOPPropertiesContainer source)
setProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name,@org.eclipse.jdt.annotation.NonNull java.lang.Object value)
setProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name, double value, @org.eclipse.jdt.annotation.NonNull java.lang.String units)

Constructor Detail

Ax.fop.BlockProperties.JSFOPBlockProperties

Ax.fop.BlockProperties.JSFOPBlockProperties()
Info:
Creates a new JSFOPBlockProperties instance.

Method Detail

Ax.fop.BlockProperties.encodeXML

object Ax.fop.BlockProperties.encodeXML(
	object input
)
Parameters:
input - 
Returns:
object

Ax.fop.BlockProperties.encodeXMLAttribute

object Ax.fop.BlockProperties.encodeXMLAttribute(
	object input
)
Info:
In XML attributes you must escape " to
Parameters:
input - 
Returns:
object

Ax.fop.BlockProperties.formatStringUS

object Ax.fop.BlockProperties.formatStringUS(
	object format,
	object[] args
)
Info:
Use String.format with US locale to force numnbers to be formatted with "." as number separator. This method should be called when formatting font-size, extent, paddings, margins... etc
Parameters:
format - 
args - 
Returns:
object

Ax.fop.BlockProperties.getIndent

object Ax.fop.BlockProperties.getIndent(
	smallint deep
)
Parameters:
deep - 
Returns:
object

Ax.fop.BlockProperties.getProperties

object Ax.fop.BlockProperties.getProperties()
Returns:
object

Ax.fop.BlockProperties.getProperty

object Ax.fop.BlockProperties.getProperty(
	object name
)
Parameters:
name - 
Returns:
object

Ax.fop.BlockProperties.getPropertyNames

object Ax.fop.BlockProperties.getPropertyNames()
Returns:
object

Ax.fop.BlockProperties.getPropertyOrDefault

object Ax.fop.BlockProperties.getPropertyOrDefault(
	object name,
	object defval
)
Parameters:
name - 
defval - 
Returns:
object

Ax.fop.BlockProperties.getPropertyOrDefault

object Ax.fop.BlockProperties.getPropertyOrDefault(
	object name,
	object defval
)
Parameters:
name - 
defval - 
Returns:
object

Ax.fop.BlockProperties.getPropertyOrDefaultAsCentimeters

double Ax.fop.BlockProperties.getPropertyOrDefaultAsCentimeters(
	object name,
	double defval
)
Parameters:
name - 
defval - 
Returns:
double

Ax.fop.BlockProperties.getPropertyOrDefaultAsInteger

smallint Ax.fop.BlockProperties.getPropertyOrDefaultAsInteger(
	object name,
	smallint defval
)
Parameters:
name - 
defval - 
Returns:
smallint

Ax.fop.BlockProperties.hasProperty

boolean Ax.fop.BlockProperties.hasProperty(
	object name
)
Parameters:
name - 
Returns:
boolean

Ax.fop.BlockProperties.hasPropertyStarting

boolean Ax.fop.BlockProperties.hasPropertyStarting(
	object name
)
Parameters:
name - 
Returns:
boolean

Ax.fop.BlockProperties.nonNull

object Ax.fop.BlockProperties.nonNull(
	object s
)
Parameters:
s - 
Returns:
object

Ax.fop.BlockProperties.setProperties

object Ax.fop.BlockProperties.setProperties(
	object source
)
Parameters:
source - 
Returns:
object

Ax.fop.BlockProperties.setProperty

object Ax.fop.BlockProperties.setProperty(
	object name,
	object value
)
Parameters:
name - 
value - 
Returns:
object

Ax.fop.BlockProperties.setProperty

object Ax.fop.BlockProperties.setProperty(
	object name,
	double value,
	object units
)
Parameters:
name - 
value - 
units - 
Returns:
object

2 DocumentBuilder

Class Ax.fop.DocumentBuilder


Creates a JSFOPDocumentBuilder object to use FOPDocumentBuilder class. FOPDocumentBuilder is used as a document basis from which the document will be created.

Constructor Summary

Method
Description
Creates a new JSFOPDocumentBuilder instance.

Method Summary

Modifier and Type
Method
Description
addPageSequence(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
addSimplePageMaster(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
Add a default simple page master A4 with no margins
addSimplePageMaster(@org.eclipse.jdt.annotation.NonNull java.lang.String name, double marginLeft, double marginRight, double marginTop, double marginBottom)
addSimplePageMaster(@org.eclipse.jdt.annotation.NonNull java.lang.String name,@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.PageSize.DIN din,double marginLeft,double marginRight,double marginTop,double marginBottom)
addSimplePageMaster(@org.eclipse.jdt.annotation.NonNull java.lang.String name, @org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.PageSize size, double marginLeft, double marginRight, double marginTop, double marginBottom)
build()
createDocument(Ax.text.String pageSize)
createDocument(@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.PageSize.DIN din)
createDocument(double width,double height,double left,double right,double top,double bottom)
setDoubleSided(@org.eclipse.jdt.annotation.NonNull java.lang.String name,@org.eclipse.jdt.annotation.NonNull java.lang.String evenPageName,@org.eclipse.jdt.annotation.NonNull java.lang.String oddPageName)

Constructor Detail

Ax.fop.DocumentBuilder.JSFOPDocumentBuilder

Ax.fop.DocumentBuilder.JSFOPDocumentBuilder()
Info:
Creates a new JSFOPDocumentBuilder instance.

Method Detail

Ax.fop.DocumentBuilder.addPageSequence

object Ax.fop.DocumentBuilder.addPageSequence(
	object name
)
Parameters:
name - 
Returns:
object

Ax.fop.DocumentBuilder.addSimplePageMaster

object Ax.fop.DocumentBuilder.addSimplePageMaster(
	object name
)
Info:
Add a default simple page master A4 with no margins
Parameters:
name - 
Returns:
object

Ax.fop.DocumentBuilder.addSimplePageMaster

object Ax.fop.DocumentBuilder.addSimplePageMaster(
	object name,
	double marginLeft,
	double marginRight,
	double marginTop,
	double marginBottom
)
Parameters:
name - 
marginLeft - 
marginRight - 
marginTop - 
marginBottom - 
Returns:
object

Ax.fop.DocumentBuilder.addSimplePageMaster

object Ax.fop.DocumentBuilder.addSimplePageMaster(
	object name,
	object din,
	double marginLeft,
	double marginRight,
	double marginTop,
	double marginBottom
)
Parameters:
name - 
din - 
marginLeft - 
marginRight - 
marginTop - 
marginBottom - 
Returns:
object

Ax.fop.DocumentBuilder.addSimplePageMaster

object Ax.fop.DocumentBuilder.addSimplePageMaster(
	object name,
	object size,
	double marginLeft,
	double marginRight,
	double marginTop,
	double marginBottom
)
Parameters:
name - 
size - 
marginLeft - 
marginRight - 
marginTop - 
marginBottom - 
Returns:
object

Ax.fop.DocumentBuilder.build

object Ax.fop.DocumentBuilder.build()
Returns:
object

Ax.fop.DocumentBuilder.createA4Document

object Ax.fop.DocumentBuilder.createA4Document()
Returns:
object

Ax.fop.DocumentBuilder.createDocument

object Ax.fop.DocumentBuilder.createDocument(
	string pageSize
)
Parameters:
pageSize - 
Returns:
object

Ax.fop.DocumentBuilder.createDocument

object Ax.fop.DocumentBuilder.createDocument(
	object din
)
Parameters:
din - 
Returns:
object

Ax.fop.DocumentBuilder.createDocument

object Ax.fop.DocumentBuilder.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:
object

Ax.fop.DocumentBuilder.setDebug

object Ax.fop.DocumentBuilder.setDebug(
	string[] tags
)
Parameters:
tags - 
Returns:
object

Ax.fop.DocumentBuilder.setDoubleSided

object Ax.fop.DocumentBuilder.setDoubleSided(
	object name,
	object evenPageName,
	object oddPageName
)
Parameters:
name - 
evenPageName - 
oddPageName - 
Returns:
object

3 PageSize

Class Ax.fop.PageSize


Creates a JSFOPPageSize object to use PageSize class. PageSize is used to set the page sizing.

Constructor Summary

Method
Description
JSFOPPageSize(Ax.text.String din)
Creates a JSFOPPageSize instance with the specified format.

Method Summary

Modifier and Type
Method
Description
double 
cm2Points(double cm)
double 
double 
boolean 
boolean 
void 
Prevent a future call to rotate.
double 
points2CM(double pt)
rotate()
void 
setDin(DIN din)
Ax.text.String 

Constructor Detail

Ax.fop.PageSize.JSFOPPageSize

Ax.fop.PageSize.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

Method Detail

Ax.fop.PageSize.cm2Points

double Ax.fop.PageSize.cm2Points(
	double cm
)
Parameters:
cm - 
Returns:
double

Ax.fop.PageSize.getHeight

double Ax.fop.PageSize.getHeight()
Returns:
double

Ax.fop.PageSize.getWidth

double Ax.fop.PageSize.getWidth()
Returns:
double

Ax.fop.PageSize.isLandscape

boolean Ax.fop.PageSize.isLandscape()
Returns:
boolean

Ax.fop.PageSize.isPortrait

boolean Ax.fop.PageSize.isPortrait()
Returns:
boolean

Ax.fop.PageSize.lockRotation

null Ax.fop.PageSize.lockRotation()
Info:
Prevent a future call to rotate.
Returns:
null

Ax.fop.PageSize.points2CM

double Ax.fop.PageSize.points2CM(
	double pt
)
Parameters:
pt - 
Returns:
double

Ax.fop.PageSize.rotate

object Ax.fop.PageSize.rotate()
Returns:
object

Ax.fop.PageSize.setDin

null Ax.fop.PageSize.setDin(
	object din
)
Parameters:
din - 
Returns:
null

Ax.fop.PageSize.toString

string Ax.fop.PageSize.toString()
Returns:
string

4 Processor

Class Ax.fop.Processor


Formatting Objects Processor microservice. MicroserviceExecutorService.getInstance().execute(new FOPExecution()) will automatically select the service for FOP.

Constructor Summary

Method
Description
Creates a new instance of the FOP microservice.

Method Summary

Modifier and Type
Method
Description
List 
Returns a list with the available fonts.
byte[] 
Returns pdf file with the system fonts.
byte[] 
group()
SEE: function_fop_form_group TODO TODO TODO TODO
boolean 
Checks if the FOP microservice is ready.
boolean 
isReady(boolean forceOnlineCheck)
Checks if the FOP microservice is ready.
boolean 
boolean 
isReady(MicroserviceType arg0, boolean arg1)
byte[] 
transform(Ax.text.String xml)
Transforms a string containing an xml to FO format.
byte[] 
transform(Ax.io.File file)
Transforms the xml contents of a file to FO format.
byte[] 
transform(Ax.sql.Blob blob)
Transforms the contents of a BLOB to FO format.

Constructor Detail

Ax.fop.Processor.JSFOPProcessor

Ax.fop.Processor.JSFOPProcessor()
Info:
Creates a new instance of the FOP microservice.

Method Detail

Ax.fop.Processor.getFonts

array Ax.fop.Processor.getFonts()
Info:
Returns a list with the available fonts.
Returns:
array

Ax.fop.Processor.getFontsSample

byte[] Ax.fop.Processor.getFontsSample()
Info:
Returns pdf file with the system fonts.
Returns:
byte[]

Ax.fop.Processor.group

byte[] Ax.fop.Processor.group()
Info:
SEE: function_fop_form_group TODO TODO TODO TODO
Returns:
byte[]

Ax.fop.Processor.isReady

boolean Ax.fop.Processor.isReady()
Info:
Checks if the FOP microservice is ready.
Returns:
boolean

Ax.fop.Processor.isReady

boolean Ax.fop.Processor.isReady(
	boolean forceOnlineCheck
)
Info:
Checks if the FOP microservice is ready.
Parameters:
forceOnlineCheck - to disable or force whether the server is reachable
Returns:
boolean

Ax.fop.Processor.isReady

boolean Ax.fop.Processor.isReady(
	object arg0
)
Parameters:
arg0 - 
Returns:
boolean

Ax.fop.Processor.isReady

boolean Ax.fop.Processor.isReady(
	object arg0,
	boolean arg1
)
Parameters:
arg0 - 
arg1 - 
Returns:
boolean

Ax.fop.Processor.transform

byte[] Ax.fop.Processor.transform(
	string xml
)
Info:
Transforms a string containing an xml to FO format.
Parameters:
xml - xml to process
Returns:
byte[]

Ax.fop.Processor.transform

byte[] Ax.fop.Processor.transform(
	file file
)
Info:
Transforms the xml contents of a file to FO format.
Parameters:
file - file that contains the xml to process
Returns:
byte[]

Ax.fop.Processor.transform

byte[] Ax.fop.Processor.transform(
	object blob
)
Info:
Transforms the contents of a BLOB to FO format.
Parameters:
blob - BLOB containing the xml to process in binary
Returns:
byte[]

5 SinglePageTemplate

Class Ax.fop.SinglePageTemplate


Wrapper for FOP SinglePageTemplate

Constructor Summary

Method
Description
JSFOPSinglePageTemplate(Ax.text.String din)
Creates a new JSFOPSinglePageTemplate with the specified format.

Method Summary

Modifier and Type
Method
Description
Ax.fop.SinglePageTemplate 
Configures the single page template after region.
Ax.fop.SinglePageTemplate 
Configures the single page template before region.
Ax.fop.SinglePageTemplate 
Configures the single page template body.
Ax.fop.SinglePageTemplate 
Configures the single page template footnote.
Ax.fop.SinglePageTemplate 
Configures the single page template end region.
Ax.fop.SinglePageTemplate 
Configures the single page template root.
Ax.fop.SinglePageTemplate 
Configures the single page template start region.
Ax.text.String 
toFOP()
Converts the single page template to an xml in a string.

Constructor Detail

Ax.fop.SinglePageTemplate.JSFOPSinglePageTemplate

Ax.fop.SinglePageTemplate.JSFOPSinglePageTemplate()

Ax.fop.SinglePageTemplate.JSFOPSinglePageTemplate

Ax.fop.SinglePageTemplate.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

Method Detail

Ax.fop.SinglePageTemplate.setAfter

object Ax.fop.SinglePageTemplate.setAfter(
	object after
)
Info:
Configures the single page template after region.
Parameters:
after - after region configuration function
Returns:
object

Ax.fop.SinglePageTemplate.setBefore

object Ax.fop.SinglePageTemplate.setBefore(
	object before
)
Info:
Configures the single page template before region.
Parameters:
before - before region configuration function
Returns:
object

Ax.fop.SinglePageTemplate.setBody

object Ax.fop.SinglePageTemplate.setBody(
	object body
)
Info:
Configures the single page template body.
Parameters:
body - body configuration function
Returns:
object

Ax.fop.SinglePageTemplate.setBodyFootNote

object Ax.fop.SinglePageTemplate.setBodyFootNote(
	object footnote
)
Info:
Configures the single page template footnote.
Parameters:
footnote - footnote configuration function
Returns:
object

Ax.fop.SinglePageTemplate.setEnd

object Ax.fop.SinglePageTemplate.setEnd(
	object end
)
Info:
Configures the single page template end region.
Parameters:
end - end region configuration function
Returns:
object

Ax.fop.SinglePageTemplate.setRoot

object Ax.fop.SinglePageTemplate.setRoot(
	object root
)
Info:
Configures the single page template root.
Parameters:
root - root configuration function
Returns:
object

Ax.fop.SinglePageTemplate.setStart

object Ax.fop.SinglePageTemplate.setStart(
	object start
)
Info:
Configures the single page template start region.
Parameters:
start - start region configuration function
Returns:
object

Ax.fop.SinglePageTemplate.toFOP

string Ax.fop.SinglePageTemplate.toFOP()
Info:
Converts the single page template to an xml in a string.
Returns:
string

6 Table

Class Ax.fop.Table


Creates a JSFOPTable object to use FOPTable class. FOPTable is used to represent a table in fop documents.

Constructor Summary

Method
Description
JSFOPTable(String[] columnNames)
Creates a new JSFOPTable instance with the specified column names.

Method Summary

Modifier and Type
Method
Description
@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.tables.FOPTableColumn 
@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.tables.FOPTableColumn 
addColumn(@org.eclipse.jdt.annotation.NonNull java.lang.String columnName)
@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.tables.FOPTableColumn 
addColumn(@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.tables.FOPTableColumn column)
Add a table-column to table
@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.tables.FOPTable 
addColumns(@org.eclipse.jdt.annotation.NonNull java.lang.String[] columnNames)
void 
Some tags require a newline (fo:flow!)
void 
Some tags we wish to have a comment with it's name to clarify
build(Consumer<N> object)
Allow from any object (for example root), create a BlockProperties.
createColumns(int ncols)
Automatically create N columns to an empty table
@org.eclipse.jdt.annotation.NonNull java.lang.String 
encodeXML(@org.eclipse.jdt.annotation.Nullable java.lang.String input)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
encodeXMLAttribute(@org.eclipse.jdt.annotation.NonNull java.lang.String input)
In XML attributes you must escape " to
@org.eclipse.jdt.annotation.NonNull java.lang.String 
formatStringUS(@org.eclipse.jdt.annotation.NonNull java.lang.String format,Object[] args)
Use String.
@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.tables.FOPTableColumn 
getColumn(int column)
int 
@org.eclipse.jdt.annotation.NonNull java.util.List 
List 
double 
Try to go back component till we get a height, till SimplePageMaster
@org.eclipse.jdt.annotation.NonNull java.lang.String 
getIndent(int deep)
boolean 
@org.eclipse.jdt.annotation.NonNull P 
@org.eclipse.jdt.annotation.NonNull java.util.Map 
getProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
Set 
@org.eclipse.jdt.annotation.NonNull java.lang.Object 
getPropertyOrDefault(@org.eclipse.jdt.annotation.NonNull java.lang.String name,@org.eclipse.jdt.annotation.NonNull java.lang.Object defval)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
getPropertyOrDefault(@org.eclipse.jdt.annotation.NonNull java.lang.String name, @org.eclipse.jdt.annotation.NonNull java.lang.String defval)
double 
getPropertyOrDefaultAsCentimeters(@org.eclipse.jdt.annotation.NonNull java.lang.String name,double defval)
int 
getPropertyOrDefaultAsInteger(@org.eclipse.jdt.annotation.NonNull java.lang.String name, int defval)
boolean 
@org.eclipse.jdt.annotation.NonNull java.lang.String 
int 
getUID()
double 
Try to go back component till we get a width, till SimplePageMaster, BlockContainer, InlineContainer
boolean 
hasDebug(Ax.text.String tagName)
boolean 
hasProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
boolean 
hasPropertyStarting(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
boolean 
void 
log(@org.eclipse.jdt.annotation.NonNull java.lang.String msg)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
nonNull(@org.eclipse.jdt.annotation.NonNull java.lang.String s)
void 
void 
Subclass may decide how to show component in debug mode
@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.tables.FOPTable 
pack()
Given data in table, compute the width in percents
setCaption(@org.eclipse.jdt.annotation.NonNull java.lang.String text)
setProperties(@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.properties.FOPPropertiesContainer source)
setProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name, @org.eclipse.jdt.annotation.NonNull java.lang.Object value)
setProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name,double value,@org.eclipse.jdt.annotation.NonNull java.lang.String units)
void 
FOPText|Literal|String|Inline
Ax.text.String 
toFOP(int deep)
Ax.text.String 
toFOP()
Ax.text.String 

Constructor Detail

Ax.fop.Table.JSFOPTable

Ax.fop.Table.JSFOPTable(
	string[] columnNames
						)
Info:
Creates a new JSFOPTable instance with the specified column names.
Parameters:
columnNames - column names, one parameter per name

Method Detail

Ax.fop.Table.addColumn

object Ax.fop.Table.addColumn()
Returns:
object

Ax.fop.Table.addColumn

object Ax.fop.Table.addColumn(
	object columnName
)
Parameters:
columnName - 
Returns:
object

Ax.fop.Table.addColumn

object Ax.fop.Table.addColumn(
	object column
)
Info:
Add a table-column to table
Parameters:
column - 
Returns:
object

Ax.fop.Table.addColumns

object Ax.fop.Table.addColumns(
	object columnNames
)
Parameters:
columnNames - 
Returns:
object

Ax.fop.Table.addNewLine

null Ax.fop.Table.addNewLine()
Info:
Some tags require a newline (fo:flow!)
Returns:
null

Ax.fop.Table.addResultSet

object Ax.fop.Table.addResultSet(
	resultset rs
)
Parameters:
rs - 
Returns:
object

Ax.fop.Table.addTagComment

null Ax.fop.Table.addTagComment()
Info:
Some tags we wish to have a comment with it's name to clarify
Returns:
null

Ax.fop.Table.build

object Ax.fop.Table.build(
	object object
)
Parameters:
object - 
Returns:
object

Ax.fop.Table.createBlockProperties

object Ax.fop.Table.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:
object

Ax.fop.Table.createColumns

object Ax.fop.Table.createColumns(
	smallint ncols
)
Info:
Automatically create N columns to an empty table
Parameters:
ncols - 
Returns:
object

Ax.fop.Table.encodeXML

object Ax.fop.Table.encodeXML(
	object input
)
Parameters:
input - 
Returns:
object

Ax.fop.Table.encodeXMLAttribute

object Ax.fop.Table.encodeXMLAttribute(
	object input
)
Info:
In XML attributes you must escape " to
Parameters:
input - 
Returns:
object

Ax.fop.Table.forEach

object Ax.fop.Table.forEach(
	object column
)
Parameters:
column - 
Returns:
object

Ax.fop.Table.formatStringUS

object Ax.fop.Table.formatStringUS(
	object format,
	object[] args
)
Info:
Use String.format with US locale to force numnbers to be formatted with "." as number separator. This method should be called when formatting font-size, extent, paddings, margins... etc
Parameters:
format - 
args - 
Returns:
object

Ax.fop.Table.getBody

object Ax.fop.Table.getBody()
Returns:
object

Ax.fop.Table.getColumn

object Ax.fop.Table.getColumn(
	smallint column
)
Parameters:
column - 
Returns:
object

Ax.fop.Table.getColumnCount

smallint Ax.fop.Table.getColumnCount()
Returns:
smallint

Ax.fop.Table.getColumns

object Ax.fop.Table.getColumns()
Returns:
object

Ax.fop.Table.getDebug

array Ax.fop.Table.getDebug()
Returns:
array

Ax.fop.Table.getFooter

object Ax.fop.Table.getFooter()
Returns:
object

Ax.fop.Table.getHeader

object Ax.fop.Table.getHeader()
Returns:
object

Ax.fop.Table.getHeight

double Ax.fop.Table.getHeight()
Info:
Try to go back component till we get a height, till SimplePageMaster
Returns:
double

Ax.fop.Table.getIndent

object Ax.fop.Table.getIndent(
	smallint deep
)
Parameters:
deep - 
Returns:
object

Ax.fop.Table.getNewLine

boolean Ax.fop.Table.getNewLine()
Returns:
boolean

Ax.fop.Table.getParent

object Ax.fop.Table.getParent()
Returns:
object

Ax.fop.Table.getParentOrThrow

object Ax.fop.Table.getParentOrThrow()
Returns:
object

Ax.fop.Table.getProperties

object Ax.fop.Table.getProperties()
Returns:
object

Ax.fop.Table.getProperty

object Ax.fop.Table.getProperty(
	object name
)
Parameters:
name - 
Returns:
object

Ax.fop.Table.getPropertyNames

object Ax.fop.Table.getPropertyNames()
Returns:
object

Ax.fop.Table.getPropertyOrDefault

object Ax.fop.Table.getPropertyOrDefault(
	object name,
	object defval
)
Parameters:
name - 
defval - 
Returns:
object

Ax.fop.Table.getPropertyOrDefault

object Ax.fop.Table.getPropertyOrDefault(
	object name,
	object defval
)
Parameters:
name - 
defval - 
Returns:
object

Ax.fop.Table.getPropertyOrDefaultAsCentimeters

double Ax.fop.Table.getPropertyOrDefaultAsCentimeters(
	object name,
	double defval
)
Parameters:
name - 
defval - 
Returns:
double

Ax.fop.Table.getPropertyOrDefaultAsInteger

smallint Ax.fop.Table.getPropertyOrDefaultAsInteger(
	object name,
	smallint defval
)
Parameters:
name - 
defval - 
Returns:
smallint

Ax.fop.Table.getRoot

object Ax.fop.Table.getRoot()
Returns:
object

Ax.fop.Table.getTagComment

boolean Ax.fop.Table.getTagComment()
Returns:
boolean

Ax.fop.Table.getTagName

object Ax.fop.Table.getTagName()
Returns:
object

Ax.fop.Table.getUID

smallint Ax.fop.Table.getUID()
Returns:
smallint

Ax.fop.Table.getWidth

double Ax.fop.Table.getWidth()
Info:
Try to go back component till we get a width, till SimplePageMaster, BlockContainer, InlineContainer
Returns:
double

Ax.fop.Table.hasDebug

boolean Ax.fop.Table.hasDebug(
	string tagName
)
Parameters:
tagName - 
Returns:
boolean

Ax.fop.Table.hasProperty

boolean Ax.fop.Table.hasProperty(
	object name
)
Parameters:
name - 
Returns:
boolean

Ax.fop.Table.hasPropertyStarting

boolean Ax.fop.Table.hasPropertyStarting(
	object name
)
Parameters:
name - 
Returns:
boolean

Ax.fop.Table.isTerminal

boolean Ax.fop.Table.isTerminal()
Returns:
boolean

Ax.fop.Table.log

null Ax.fop.Table.log(
	object msg
)
Parameters:
msg - 
Returns:
null

Ax.fop.Table.nonNull

object Ax.fop.Table.nonNull(
	object s
)
Parameters:
s - 
Returns:
object

Ax.fop.Table.onDebug

null Ax.fop.Table.onDebug()
Returns:
null

Ax.fop.Table.onDebug

null Ax.fop.Table.onDebug()
Info:
Subclass may decide how to show component in debug mode
Returns:
null

Ax.fop.Table.pack

object Ax.fop.Table.pack()
Info:
Given data in table, compute the width in percents
Returns:
object

Ax.fop.Table.setCaption

object Ax.fop.Table.setCaption(
	object text
)
Parameters:
text - 
Returns:
object

Ax.fop.Table.setDebug

object Ax.fop.Table.setDebug(
	string[] tags
)
Parameters:
tags - 
Returns:
object

Ax.fop.Table.setProperties

object Ax.fop.Table.setProperties(
	object source
)
Parameters:
source - 
Returns:
object

Ax.fop.Table.setProperty

object Ax.fop.Table.setProperty(
	object name,
	object value
)
Parameters:
name - 
value - 
Returns:
object

Ax.fop.Table.setProperty

object Ax.fop.Table.setProperty(
	object name,
	double value,
	object units
)
Parameters:
name - 
value - 
units - 
Returns:
object

Ax.fop.Table.setTerminal

null Ax.fop.Table.setTerminal()
Info:
FOPText|Literal|String|Inline
Returns:
null

Ax.fop.Table.toFOP

string Ax.fop.Table.toFOP(
	smallint deep
)
Parameters:
deep - 
Returns:
string

Ax.fop.Table.toFOP

string Ax.fop.Table.toFOP()
Returns:
string

Ax.fop.Table.toString

string Ax.fop.Table.toString()
Returns:
string

7 Text

Class Ax.fop.Text


Creates a JSFOPText object to use FOPBlock class. FOPBlock is used to represent a text block in fop documents.

Constructor Summary

Method
Description
JSFOPText(Ax.text.String text)
Creates a new JSFOPText instance containing the specified text.

Method Summary

Modifier and Type
Method
Description
void 
void 
Some tags require a newline (fo:flow!)
addRetrieveMarker(Ax.text.String id)
void 
Some tags we wish to have a comment with it's name to clarify
build(Consumer<N> object)
Allow from any object (for example root), create a BlockProperties.
@org.eclipse.jdt.annotation.NonNull java.lang.String 
encodeXML(@org.eclipse.jdt.annotation.Nullable java.lang.String input)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
encodeXMLAttribute(@org.eclipse.jdt.annotation.NonNull java.lang.String input)
In XML attributes you must escape " to
@org.eclipse.jdt.annotation.NonNull java.lang.String 
formatStringUS(@org.eclipse.jdt.annotation.NonNull java.lang.String format,Object[] args)
Use String.
List 
List 
double 
Try to go back component till we get a height, till SimplePageMaster
@org.eclipse.jdt.annotation.NonNull java.lang.String 
getIndent(int deep)
Ax.text.String 
Recursively get inner text to try to compute width
List 
boolean 
@org.eclipse.jdt.annotation.NonNull P 
@org.eclipse.jdt.annotation.NonNull java.util.Map 
getProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
Set 
@org.eclipse.jdt.annotation.NonNull java.lang.Object 
getPropertyOrDefault(@org.eclipse.jdt.annotation.NonNull java.lang.String name, @org.eclipse.jdt.annotation.NonNull java.lang.Object defval)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
getPropertyOrDefault(@org.eclipse.jdt.annotation.NonNull java.lang.String name,@org.eclipse.jdt.annotation.NonNull java.lang.String defval)
double 
getPropertyOrDefaultAsCentimeters(@org.eclipse.jdt.annotation.NonNull java.lang.String name, double defval)
int 
getPropertyOrDefaultAsInteger(@org.eclipse.jdt.annotation.NonNull java.lang.String name,int defval)
boolean 
@org.eclipse.jdt.annotation.NonNull java.lang.String 
int 
getUID()
double 
double 
Try to go back component till we get a width, till SimplePageMaster, BlockContainer, InlineContainer
boolean 
hasDebug(Ax.text.String tagName)
boolean 
hasProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
boolean 
hasPropertyStarting(@org.eclipse.jdt.annotation.NonNull java.lang.String name)
boolean 
void 
log(@org.eclipse.jdt.annotation.NonNull java.lang.String msg)
@org.eclipse.jdt.annotation.NonNull java.lang.String 
nonNull(@org.eclipse.jdt.annotation.NonNull java.lang.String s)
void 
void 
Subclass may decide how to show component in debug mode
setProperties(@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.properties.FOPPropertiesContainer source)
setProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name, @org.eclipse.jdt.annotation.NonNull java.lang.Object value)
setProperty(@org.eclipse.jdt.annotation.NonNull java.lang.String name,double value,@org.eclipse.jdt.annotation.NonNull java.lang.String units)
@org.eclipse.jdt.annotation.NonNull deister.axional.server.fop.model.blocks.block.FOPBlock 
setSpan(@org.eclipse.jdt.annotation.NonNull java.lang.String span)
void 
FOPText|Literal|String|Inline
Ax.text.String 
toFOP(int deep)
Ax.text.String 
toFOP()
Ax.text.String 

Constructor Detail

Ax.fop.Text.JSFOPText

Ax.fop.Text.JSFOPText(
	string text
						)
Info:
Creates a new JSFOPText instance containing the specified text.
Parameters:
text - block text content

Method Detail

Ax.fop.Text.addItem

null Ax.fop.Text.addItem(
	object item
)
Parameters:
item - 
Returns:
null

Ax.fop.Text.addNewLine

null Ax.fop.Text.addNewLine()
Info:
Some tags require a newline (fo:flow!)
Returns:
null

Ax.fop.Text.addRetrieveMarker

object Ax.fop.Text.addRetrieveMarker(
	string id
)
Parameters:
id - 
Returns:
object

Ax.fop.Text.addRetrieveMarker

object Ax.fop.Text.addRetrieveMarker(
	object retrieveMarker
)
Parameters:
retrieveMarker - 
Returns:
object

Ax.fop.Text.addTagComment

null Ax.fop.Text.addTagComment()
Info:
Some tags we wish to have a comment with it's name to clarify
Returns:
null

Ax.fop.Text.build

object Ax.fop.Text.build(
	object object
)
Parameters:
object - 
Returns:
object

Ax.fop.Text.createBlockProperties

object Ax.fop.Text.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:
object

Ax.fop.Text.encodeXML

object Ax.fop.Text.encodeXML(
	object input
)
Parameters:
input - 
Returns:
object

Ax.fop.Text.encodeXMLAttribute

object Ax.fop.Text.encodeXMLAttribute(
	object input
)
Info:
In XML attributes you must escape " to
Parameters:
input - 
Returns:
object

Ax.fop.Text.formatStringUS

object Ax.fop.Text.formatStringUS(
	object format,
	object[] args
)
Info:
Use String.format with US locale to force numnbers to be formatted with "." as number separator. This method should be called when formatting font-size, extent, paddings, margins... etc
Parameters:
format - 
args - 
Returns:
object

Ax.fop.Text.getChildren

array Ax.fop.Text.getChildren()
Returns:
array

Ax.fop.Text.getDebug

array Ax.fop.Text.getDebug()
Returns:
array

Ax.fop.Text.getHeight

double Ax.fop.Text.getHeight()
Info:
Try to go back component till we get a height, till SimplePageMaster
Returns:
double

Ax.fop.Text.getIndent

object Ax.fop.Text.getIndent(
	smallint deep
)
Parameters:
deep - 
Returns:
object

Ax.fop.Text.getInnerText

string Ax.fop.Text.getInnerText()
Info:
Recursively get inner text to try to compute width
Returns:
string

Ax.fop.Text.getItems

array Ax.fop.Text.getItems()
Returns:
array

Ax.fop.Text.getNewLine

boolean Ax.fop.Text.getNewLine()
Returns:
boolean

Ax.fop.Text.getParent

object Ax.fop.Text.getParent()
Returns:
object

Ax.fop.Text.getParentOrThrow

object Ax.fop.Text.getParentOrThrow()
Returns:
object

Ax.fop.Text.getProperties

object Ax.fop.Text.getProperties()
Returns:
object

Ax.fop.Text.getProperty

object Ax.fop.Text.getProperty(
	object name
)
Parameters:
name - 
Returns:
object

Ax.fop.Text.getPropertyNames

object Ax.fop.Text.getPropertyNames()
Returns:
object

Ax.fop.Text.getPropertyOrDefault

object Ax.fop.Text.getPropertyOrDefault(
	object name,
	object defval
)
Parameters:
name - 
defval - 
Returns:
object

Ax.fop.Text.getPropertyOrDefault

object Ax.fop.Text.getPropertyOrDefault(
	object name,
	object defval
)
Parameters:
name - 
defval - 
Returns:
object

Ax.fop.Text.getPropertyOrDefaultAsCentimeters

double Ax.fop.Text.getPropertyOrDefaultAsCentimeters(
	object name,
	double defval
)
Parameters:
name - 
defval - 
Returns:
double

Ax.fop.Text.getPropertyOrDefaultAsInteger

smallint Ax.fop.Text.getPropertyOrDefaultAsInteger(
	object name,
	smallint defval
)
Parameters:
name - 
defval - 
Returns:
smallint

Ax.fop.Text.getRoot

object Ax.fop.Text.getRoot()
Returns:
object

Ax.fop.Text.getTagComment

boolean Ax.fop.Text.getTagComment()
Returns:
boolean

Ax.fop.Text.getTagName

object Ax.fop.Text.getTagName()
Returns:
object

Ax.fop.Text.getUID

smallint Ax.fop.Text.getUID()
Returns:
smallint

Ax.fop.Text.getWidth

double Ax.fop.Text.getWidth()
Returns:
double

Ax.fop.Text.getWidth

double Ax.fop.Text.getWidth()
Info:
Try to go back component till we get a width, till SimplePageMaster, BlockContainer, InlineContainer
Returns:
double

Ax.fop.Text.hasDebug

boolean Ax.fop.Text.hasDebug(
	string tagName
)
Parameters:
tagName - 
Returns:
boolean

Ax.fop.Text.hasProperty

boolean Ax.fop.Text.hasProperty(
	object name
)
Parameters:
name - 
Returns:
boolean

Ax.fop.Text.hasPropertyStarting

boolean Ax.fop.Text.hasPropertyStarting(
	object name
)
Parameters:
name - 
Returns:
boolean

Ax.fop.Text.isTerminal

boolean Ax.fop.Text.isTerminal()
Returns:
boolean

Ax.fop.Text.log

null Ax.fop.Text.log(
	object msg
)
Parameters:
msg - 
Returns:
null

Ax.fop.Text.nonNull

object Ax.fop.Text.nonNull(
	object s
)
Parameters:
s - 
Returns:
object

Ax.fop.Text.onDebug

null Ax.fop.Text.onDebug()
Returns:
null

Ax.fop.Text.onDebug

null Ax.fop.Text.onDebug()
Info:
Subclass may decide how to show component in debug mode
Returns:
null

Ax.fop.Text.setDebug

object Ax.fop.Text.setDebug(
	string[] tags
)
Parameters:
tags - 
Returns:
object

Ax.fop.Text.setProperties

object Ax.fop.Text.setProperties(
	object source
)
Parameters:
source - 
Returns:
object

Ax.fop.Text.setProperty

object Ax.fop.Text.setProperty(
	object name,
	object value
)
Parameters:
name - 
value - 
Returns:
object

Ax.fop.Text.setProperty

object Ax.fop.Text.setProperty(
	object name,
	double value,
	object units
)
Parameters:
name - 
value - 
units - 
Returns:
object

Ax.fop.Text.setSpan

object Ax.fop.Text.setSpan(
	object span
)
Parameters:
span - 
Returns:
object

Ax.fop.Text.setTerminal

null Ax.fop.Text.setTerminal()
Info:
FOPText|Literal|String|Inline
Returns:
null

Ax.fop.Text.toFOP

string Ax.fop.Text.toFOP(
	smallint deep
)
Parameters:
deep - 
Returns:
string

Ax.fop.Text.toFOP

string Ax.fop.Text.toFOP()
Returns:
string

Ax.fop.Text.toString

string Ax.fop.Text.toString()
Returns:
string

8 Watermark

Class Ax.fop.Watermark


Creates a JSFOPWatermark object to use PDFWaterWark class. PDFWaterWark is used to represent a watermark.

Constructor Summary

Method
Description
JSFOPWatermark(Object src, Ax.text.String position)
Creates a JSFOPWatermark instance, with the given src watermark at the specified position.

Method Summary

Modifier and Type
Method
Description
void 
void 
setOverlay(File file,Pages pages)
void 
setOverlay(Ax.text.String fileName, Pages pages)
byte[] 
toPDF()

Constructor Detail

Ax.fop.Watermark.JSFOPWatermark

Ax.fop.Watermark.JSFOPWatermark(
	object src,
	string position
						)
Info:
Creates a JSFOPWatermark instance, with the given src watermark at the specified position.
Parameters:
src - watermark source object
position - position to locate the watermark: FOREGROUND, BACKGROUND

Method Detail

Ax.fop.Watermark.setOverlay

null Ax.fop.Watermark.setOverlay(
	object in,
	object pages
)
Parameters:
in - 
pages - 
Returns:
null

Ax.fop.Watermark.setOverlay

null Ax.fop.Watermark.setOverlay(
	file file,
	object pages
)
Parameters:
file - 
pages - 
Returns:
null

Ax.fop.Watermark.setOverlay

null Ax.fop.Watermark.setOverlay(
	string fileName,
	object pages
)
Parameters:
fileName - 
pages - 
Returns:
null

Ax.fop.Watermark.toPDF

byte[] Ax.fop.Watermark.toPDF()
Returns:
byte[]

9 XHTML2FO

Class Ax.fop.XHTML2FO


This class lets you transform XHTML to FO format 2 ways: 1. XHTML is whole HTML document and will be transformed to a whole FO object 2. XHTML is only part of an HTML document and will be transformed to a part of FO object

Constructor Summary

Method
Description
Creates a new XHTML to FO transformer instance.

Method Summary

Modifier and Type
Method
Description
boolean 
Checks if the XHTML2FO microservice is ready.
boolean 
isReady(boolean forceOnlineCheck)
Checks if the XHTML2FO microservice is ready.
boolean 
boolean 
isReady(MicroserviceType arg0,boolean arg1)
Ax.text.String 
toFOBody(Ax.text.String xhtml)
Transforms a well formed XHTML document to be used as an include of another FO document.
Ax.text.String 
toFORoot(Ax.text.String xhtml)
Transforms onvert a well formed XHTML document to complete FO document including root and master pages.
byte[] 
toPDF(Ax.text.String xhtml)
Transforms a well formed XHTML document directly to PDF, converting it first to FO and then from FO to PDF.

Constructor Detail

Ax.fop.XHTML2FO.JSXHTML2FO

Ax.fop.XHTML2FO.JSXHTML2FO()
Info:
Creates a new XHTML to FO transformer instance.

Method Detail

Ax.fop.XHTML2FO.isReady

boolean Ax.fop.XHTML2FO.isReady()
Info:
Checks if the XHTML2FO microservice is ready.
Returns:
boolean

Ax.fop.XHTML2FO.isReady

boolean Ax.fop.XHTML2FO.isReady(
	boolean forceOnlineCheck
)
Info:
Checks if the XHTML2FO microservice is ready.
Parameters:
forceOnlineCheck - to disable or force whether the server is reachable
Returns:
boolean

Ax.fop.XHTML2FO.isReady

boolean Ax.fop.XHTML2FO.isReady(
	object arg0
)
Parameters:
arg0 - 
Returns:
boolean

Ax.fop.XHTML2FO.isReady

boolean Ax.fop.XHTML2FO.isReady(
	object arg0,
	boolean arg1
)
Parameters:
arg0 - 
arg1 - 
Returns:
boolean

Ax.fop.XHTML2FO.toFOBody

string Ax.fop.XHTML2FO.toFOBody(
	string xhtml
)
Info:
Transforms a well formed XHTML document to be used as an include of another FO document.
Parameters:
xhtml - XHTML fragment to convert
Returns:
string

Ax.fop.XHTML2FO.toFORoot

string Ax.fop.XHTML2FO.toFORoot(
	string xhtml
)
Info:
Transforms onvert a well formed XHTML document to complete FO document including root and master pages.
Parameters:
xhtml - XHTML document to convert
Returns:
string

Ax.fop.XHTML2FO.toPDF

byte[] Ax.fop.XHTML2FO.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:
byte[]