1 Excel

Class Ax.ms.Excel


EXAMPLES: https://github.com/jbolaky/multi-java-frameworks-tutorials/tree/master/apache-poi/src/main/java/org/apache/poi/xssf/usermodel/examples Charts using JFreeChart http://thinktibits.blogspot.com/2012/12/Create-Bar-Chart-Excel-Java-Example-Program-POI-JFreeChart-Tutorial.html PPT chart https://github.com/cuba-platform/apache-poi/blob/master/poi/src/examples/src/org/apache/poi/xslf/usermodel/PieChartDemo.java ExcelReporter https://github.com/TTAutomation/HQA/blob/master/CBF-2.5.6/src/cbf/reporting/ExcelReporter.java

Constructor Summary

MethodDescription
JSExcelWorkbook()
JSExcelWorkbook(ExcelType type)
JSExcelWorkbook(String name)
JSExcelWorkbook(ExcelType type, String name)

Method Summary

Modifier and TypeMethodDescription
CheckFunctionsSupported checkFunctionsSupported()
JSExcelSheet cloneSheet(String sheetName)
JSExcelSheet cloneSheet(int sheetNum)
String columnToString(int col)
JSExcelCellStyle createCellStyle()
JSExcelFont createFont()
JSExcelSheet createSheet(String name)
JSExcelSheet createSheet(String name, Consumer<SheetCreateOptions> options)Create a sheet and fill it with given data producing a header with column names and named cells.
JSExcelDBExport dbexport()
JSExcelDBImport dbimport()
int delete(String tableName)
int delete(String tableName, int numRowsToDelete)
List diff(JSExcelWorkbook other)Returns the list of differences between this Wb an other
void dump()A debug to standard output of contents of the workbook to inspect each sheet content
void evaluate()Re-calculating all formulas in a Workbook
void forEach(Consumer arg0)
JSExcelCell getCellByName(String name)
org.apache.poi.ss.usermodel.CellStyle getCellStyleDate()
org.apache.poi.ss.usermodel.CellStyle getCellStyleHref()
org.apache.poi.ss.usermodel.CellStyle getCellStyleRightAligned()
String getName()
int getNamedRow(String tableName)
int getNumberOfSheets()
JSExcelSheet getSheet(int index)
JSExcelSheet getSheet(String name)
JSExcelSheet getSheetAt(int index)
ExcelType getType()
Iterator iterator()
JSExcelWorkbook load(Object src)
JSExcelWorkbook load(byte[] data)
long nextColumnId()
long nextTableId()
void resetEvaluator()Resets the current evaluator
File save(String name)
SQLResultSetArray select(Consumer<SQLSelectOptions> configurator)
void setAutoSizeColumns()
void setEvaluatorCache(boolean cache)
void setEvaluatorDebug(boolean debug)TODO!! does not work!!
void setForceFormulaRecalculation(boolean force)Whether the application shall perform a full recalculation when the workbook is opened.
void setName(String name)
Spliterator spliterator()
JDBCBlobJMEM toBlob()
String toCell(int row, int col)
org.apache.poi.ss.util.CellReference toCellReference(int row, int col)
int update(Map<ObjectObject> map, Consumer<SQLOptions> configurator)
int update(IResultSetConvertible rsconv, Consumer<SQLOptions> configurator)Updates all columns from ResultSet into workbook named cells

Method Detail

JSExcelWorkbook

 JSExcelWorkbook()

JSExcelWorkbook

 JSExcelWorkbook(ExcelType type)
Parameters:
type - 

JSExcelWorkbook

 JSExcelWorkbook(String name)
Parameters:
name - 

JSExcelWorkbook

 JSExcelWorkbook(ExcelType type, String name)
Parameters:
type - 
name - 

checkFunctionsSupported

                        CheckFunctionsSupported checkFunctionsSupported()
Returns:

cloneSheet

                        JSExcelSheet cloneSheet(String sheetName)
Parameters:
sheetName - 
Returns:

cloneSheet

                        JSExcelSheet cloneSheet(int sheetNum)
Parameters:
sheetNum - 
Returns:

columnToString

                        String columnToString(int col)
Parameters:
col - 
Returns:

createCellStyle

                        JSExcelCellStyle createCellStyle()
Returns:

createFont

                        JSExcelFont createFont()
Returns:

createSheet

                        JSExcelSheet createSheet(String name)
Parameters:
name - 
Returns:

createSheet

                        JSExcelSheet createSheet(String name, Consumer<SheetCreateOptions> options)
Info:
Create a sheet and fill it with given data producing a header with column names and named cells.
Parameters:
name - can the table name we are referring if using as a dbexport workbook
options - 
Returns:

dbexport

                        JSExcelDBExport dbexport()
Returns:
a DBExport for given worksheet

dbimport

                        JSExcelDBImport dbimport()
Returns:
a DBImport for given worksheet

delete

int delete(String tableName)
Parameters:
tableName - 
Returns:

delete

int delete(String tableName, int numRowsToDelete)
Parameters:
tableName - 
numRowsToDelete - 
Returns:

diff

                        List diff(JSExcelWorkbook other)
Info:
Returns the list of differences between this Wb an other
Parameters:
other - 
Returns:

dump

void dump()
Info:
A debug to standard output of contents of the workbook to inspect each sheet content

evaluate

void evaluate()
Info:
Re-calculating all formulas in a Workbook

forEach

void forEach(Consumer arg0)
Parameters:
arg0 - 

getCellByName

                        JSExcelCell getCellByName(String name)
Parameters:
name - 
Returns:

getCellStyleDate

org.apache.poi.ss.usermodel.CellStyle getCellStyleDate()
Returns:
a cached cell style for dates to avoid create a new style for each date placed in a cell witch leas into: The maximum number of cell styles was exceeded. You can define up to 4000 styles in a .xls workbook

getCellStyleHref

org.apache.poi.ss.usermodel.CellStyle getCellStyleHref()
Returns:

getCellStyleRightAligned

org.apache.poi.ss.usermodel.CellStyle getCellStyleRightAligned()
Returns:
a cached cell style for dates to avoid create a new style for each date placed in a cell witch leas into: The maximum number of cell styles was exceeded. You can define up to 4000 styles in a .xls workbook

getName

                        String getName()
Returns:
the name of excel workbook

getNamedRow

int getNamedRow(String tableName)
Parameters:
tableName - 
Returns:
the starting row for named cells in rectangular format.

getNumberOfSheets

int getNumberOfSheets()
Returns:

getSheet

                        JSExcelSheet getSheet(int index)
Parameters:
index - 
Returns:

getSheet

                        JSExcelSheet getSheet(String name)
Parameters:
name - 
Returns:

getSheetAt

                        JSExcelSheet getSheetAt(int index)
Parameters:
index - 
Returns:

getType

                        ExcelType getType()
Returns:

iterator

                        Iterator iterator()
Returns:

load

                        JSExcelWorkbook load(Object src)
Parameters:
src - (blob |byte[] | inputStream | string[ url, base64 or filename ])
Returns:

load

                        JSExcelWorkbook load(byte[] data)
Parameters:
data - 
Returns:

nextColumnId

long nextColumnId()
Returns:

nextTableId

long nextTableId()
Returns:

resetEvaluator

void resetEvaluator()
Info:
Resets the current evaluator

save

                        File save(String name)
Parameters:
name - 
Returns:

select

                        SQLResultSetArray select(Consumer<SQLSelectOptions> configurator)
Parameters:
configurator - 
Returns:

setAutoSizeColumns

void setAutoSizeColumns()

setEvaluatorCache

void setEvaluatorCache(boolean cache)
Parameters:
cache - 

setEvaluatorDebug

void setEvaluatorDebug(boolean debug)
Info:
TODO!! does not work!!
Parameters:
debug - 

setForceFormulaRecalculation

void setForceFormulaRecalculation(boolean force)
Info:
Whether the application shall perform a full recalculation when the workbook is opened. Typically you want to force formula recalculation when you modify cell formulas or values of a workbook previously created by Excel. When set to true, this flag will tell Excel that it needs to recalculate all formulas in the workbook the next time the file is opened.
Parameters:
force - 

setName

void setName(String name)
Parameters:
name - 

spliterator

                        Spliterator spliterator()
Returns:

toBlob

                        JDBCBlobJMEM toBlob()
Returns:

toCell

                        String toCell(int row, int col)
Parameters:
row - 
col - 
Returns:

toCellReference

org.apache.poi.ss.util.CellReference toCellReference(int row, int col)
Parameters:
row - 
col - 
Returns:

update

int update(Map<ObjectObject> map, Consumer<SQLOptions> configurator)
Parameters:
map - a map of values probably passed from javascript. To support ScriptObjectMirror as argument we must accept Map < Object, Object > as argument. var x={} var wb = new Ax.ms.Excel(); wb.update(x, options = > { } );
configurator - 
Returns:

update

int update(IResultSetConvertible rsconv, Consumer<SQLOptions> configurator)
Info:
Updates all columns from ResultSet into workbook named cells
Parameters:
rsconv - 
configurator - 
Returns:

2 Word

Class Ax.ms.Word


The target samples https://plumsail.com/docs/actions/v1.x/document-generation/docx/demos.html A more complete doc system (with loop capabilities) is: http://obeonetwork.github.io/M2Doc/ref-doc/nightly/index.html http://www.dskims.com/how-to-copy-a-paragraph-of-docx-to-another-docx-withjava-and-retain-the-style/ WhiteRabbit https://github.com/OHDSI/WhiteRabbit DocumentVisitor https://github.com/INL/OpenConvert/blob/master/src/org/apache/poi/xwpf/converter/core/XWPFDocumentVisitor.java Binary preorder-traversal https://javarevisited.blogspot.com/2016/07/binary-tree-preorder-traversal-in-java-using-recursion-iteration-example.html

Constructor Summary

MethodDescription
JSWord()
JSWord(String name)
JSWord(String name, org.apache.poi.xwpf.usermodel.XWPFDocument object)

Method Summary

Modifier and TypeMethodDescription
void addPageBreak(JSWord doc)
void addPageBreak(org.apache.poi.xwpf.usermodel.XWPFDocument doc)
String asString()
JSWordParagraph createParagraph()
JSWordTable createTable()
JSWordTable createTable(IResultSetConvertible rs)
JSWordTable createTable(ResultSet rs)
void dump()
String getName()
List getParagraphs()
String getText()
JSWord load(Object src)
JSWordRun print(String value)Create as paragraph and a run with new text
void scanParagraph(org.apache.poi.xwpf.usermodel.IBodyElement element)
void scanTable(org.apache.poi.xwpf.usermodel.IBodyElement element)
void setName(String name)
JDBCBlob toBlob()
int toEMU(double points)
void toPDF()
JSWord update(jdk.nashorn.api.scripting.JSObject data)

Method Detail

JSWord

 JSWord()

JSWord

 JSWord(String name)
Parameters:
name - 

JSWord

 JSWord(String name, org.apache.poi.xwpf.usermodel.XWPFDocument object)
Parameters:
name - 
object - 

addPageBreak

void addPageBreak(JSWord doc)
Parameters:
doc - 

addPageBreak

void addPageBreak(org.apache.poi.xwpf.usermodel.XWPFDocument doc)
Parameters:
doc - 

asString

                        String asString()
Returns:

createParagraph

                        JSWordParagraph createParagraph()
Returns:
a new paragraph

createTable

                        JSWordTable createTable()
Returns:
a new table

createTable

                        JSWordTable createTable(IResultSetConvertible rs)
Parameters:
rs - 
Returns:

createTable

                        JSWordTable createTable(ResultSet rs)
Parameters:
rs - 
Returns:

dump

void dump()

getName

                        String getName()
Returns:
the name of document

getParagraphs

                        List getParagraphs()
Returns:
the list of XWPFParagraph decorated in JSWordParagraph

getText

                        String getText()
Returns:
The text of a word document extracted with XWPFWordExtractor

load

                        JSWord load(Object src)
Parameters:
src - (blob | string[ url, base64 or filename ])
Returns:

print

                        JSWordRun print(String value)
Info:
Create as paragraph and a run with new text
Parameters:
value - 
Returns:

scanParagraph

void scanParagraph(org.apache.poi.xwpf.usermodel.IBodyElement element)
Parameters:
element - 

scanTable

void scanTable(org.apache.poi.xwpf.usermodel.IBodyElement element)
Parameters:
element - 

setName

void setName(String name)
Parameters:
name - the name of the document

toBlob

                        JDBCBlob toBlob()
Returns:

toEMU

int toEMU(double points)
Parameters:
points - 
Returns:

toPDF

void toPDF()

update

                        JSWord update(jdk.nashorn.api.scripting.JSObject data)
Parameters:
data - 
Returns:

3 PowerPoint

Class Ax.ms.PowerPoint


Constructor Summary

MethodDescription
JSPowerPoint()
JSPowerPoint(String name)

Method Summary

Modifier and TypeMethodDescription
JSPowerPointSlide createSlide(JSPowerPointSlideLayout layout)
void dump()
String getName()
JSPowerPointSlideMaster getSlideMaster(int index)When adding a new slide to a presentation, we can also choose to create it from a predefined layout.
void load(Object src)
JDBCBlob toBlob()

Method Detail

JSPowerPoint

 JSPowerPoint()

JSPowerPoint

 JSPowerPoint(String name)
Parameters:
name - 

createSlide

                        JSPowerPointSlide createSlide(JSPowerPointSlideLayout layout)
Parameters:
layout - 
Returns:

dump

void dump()

getName

                        String getName()
Returns:
the name of excel workbook

getSlideMaster

                        JSPowerPointSlideMaster getSlideMaster(int index)
Info:
When adding a new slide to a presentation, we can also choose to create it from a predefined layout. To achieve this, we first have to retrieve the XSLFSlideMaster that holds layouts (the first one (0) is the default master):
Parameters:
index - 
Returns:

load

void load(Object src)
Parameters:
src - (blob | string[ url, base64 or filename ])

toBlob

                        JDBCBlob toBlob()
Returns: