Uses of Class
io.starter.OpenXLS.WorkBookHandle

Packages that use WorkBookHandle

Package	Description
io.starter.formats.OOXML
io.starter.formats.XLS
io.starter.formats.XLS.charts
io.starter.OpenXLS	The OpenXLS package contains the primary classes for working with spreadsheets.

Uses of WorkBookHandle in io.starter.formats.OOXML

Methods in io.starter.formats.OOXML with parameters of type WorkBookHandle

Modifier and Type	Method and Description
void	Dxf.createBorder(WorkBookHandle bk, int[] styles, int[] colors) for BIFF8->OOXML Compatiblity, create a dxf from Cf style info
void	Dxf.createFill(int fs, int fg, int bg, WorkBookHandle bk) for BIFF8->OOXML Compatiblity, create a dxf from Cf style info
int	Title.getFontId(WorkBookHandle wb) return the font index for this title
static void	OOXMLHandle.getOOXML(WorkBookHandle bk, String path) generates OOXML for a workbook Creates the ZIP file and writes all files into proper directory structure Will create either an .xlsx or an .xlsm output, depending upon whether WorkBookHandle bk contains macros
static void	OOXMLHandle.parseNBind(WorkBookHandle bk, String fName) OOXML parseNBind - reads in an OOXML (Excel 7) workbook
static PivotTableHandle	PivotTableDefinition.parseOOXML(WorkBookHandle bk, Boundsheet sheet, InputStream ii) NOT COMPLETED DO NOT USE parse a pivotTable OOXML element Top-level attributes Location information Collection of fields Fields on the row axis Items on the row axis (specific values) Fields on the column axis Items on the column axis (specific values) Fields on the report filter region Fields in the values region Style information Outline of the XML for a pivotTableDefinition (sequence) pivotTableDefinition location pivotFields rowFields rowItems colFields colItems pageFields dataFields conditionalFormats pivotTableStyleInfo
void	Theme.parseOOXML(WorkBookHandle bk, InputStream ii) given Theme OOXML inputstream, retrieve theme colors for later use This element holds all the different formatting options available to a document through a theme and defines the overall look and feel of the document when themed objects are used within the document.
static PivotCacheDefinition	PivotCacheDefinition.parseOOXML(WorkBookHandle bk, String cacheid, InputStream ii)
static OOXMLElement	Fill.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, boolean isDxf, WorkBookHandle bk)
static OOXMLElement	Color.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, short type, WorkBookHandle bk) parses a color element root= color, fgColor or bgColor
static OOXMLElement	DefRPr.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	ObjectChoice.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	TwoCellAnchor.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	TextRun.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static GrpSp	GrpSp.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) parse grpSp element OOXML
static OOXMLElement	Marker.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) parse marker OOXML element
static OOXMLElement	FillGroup.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	DPt.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	Style.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	SpPr.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) parse shape OOXML element spPr
static OOXMLElement	DLbls.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	Pic.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	TxPr.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	TxBody.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	P.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	Sp.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) return the OOXML specific for this object
static OOXMLElement	Title.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) parse title OOXML element title
static OOXMLElement	OneCellAnchor.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	CxnSp.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static Text	Text.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) parse this Text element into a unicode string with formatting runs
static OOXMLElement	ColorChoice.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	Ln.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
static OOXMLElement	Legend.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) parse OOXML legend element
static OOXMLElement	Ss_rPr.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle bk)
static OOXMLElement	Border.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle bk)
static OOXMLElement	Dxf.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle bk)
static Theme	Theme.parseThemeOOXML(WorkBookHandle bk, InputStream ii)

Constructors in io.starter.formats.OOXML with parameters of type WorkBookHandle

Constructor and Description
Border(WorkBookHandle bk, int[] styles, int[] colors) set borders
Dxf(Font fnt, NumFmt nf, Fill f, Alignment a, Border b, WorkBookHandle wbh)

Uses of WorkBookHandle in io.starter.formats.XLS

cell table - specifies rows and cells with types and values (see below) -- REQUIRED ("Supporting Features" -- all optional)

Methods in io.starter.formats.XLS with parameters of type WorkBookHandle

Modifier and Type	Method and Description
void	WorkBook.addPivotCache(String ref, WorkBookHandle wbh, int sId) adds the Pivot Cache Directory Storage +Stream records necessary to define the pivot cache (==pivot table data) for pivot table(s) NOTE: at this time only 1 pivot cache is supported
Sxview	Boundsheet.addPivotTable(String ref, WorkBookHandle wbh, int sId, String tablename) adds a sxview - pivot table lead record - and required associated records to the worksheet other methods that add data, row, col and page fields will fill in the pivot table fields and formatting info
Condfmt	Boundsheet.createCondfmt(String location, WorkBookHandle wbh) Create a Condfmt (Conditional format) record and add it to sheet recs
void	PivotCache.createPivotCache(StorageTable directories, WorkBookHandle wbh, String ref, int sId) Creates the pivot table cache == defines pivot table data A pivot table cache requires 2 directory storages _SX_DB_CUR = parent pivot cache 0001, 0002 ...
String	Condfmt.getOOXML(WorkBookHandle bk, int[] priority) generate the proper OOXML to define this set of Conditional Formatting
String	Cf.getOOXML(WorkBookHandle bk, int priority, ArrayList dxfs) generate OOXML for this Cf (BIFF8->OOXML) attributes: type, dxfId, priority (REQ), stopIfTrue, aboveAverage, percent, bottom, operator, text, timePeriod, rank, stdDev, equalAverage children: SEQ: formula (0-3), colorScale, dataBar, iconSet
void	OOXMLWriter.getOOXML(WorkBookHandle bk, OutputStream out) generates OOXML for a workbook (see specification above) Creates the ZIP file and writes all files into proper directory structure re: OPC
void	OOXMLWriter.getOOXML(WorkBookHandle bk, String path) generates OOXML for a workbook Creates the ZIP file and writes all files into proper directory structure Will create either an .xlsx or an .xlsm output, depending upon whether WorkBookHandle bk contains macros
protected static void	OOXMLReader.handlePassThroughs(ZipFile zip, WorkBookHandle bk, String parentDir, String externalDir, String[] c) pass-through current OOXML element/file - i.e.
protected static void	OOXMLReader.handleSheetPassThroughs(ZipFile zip, WorkBookHandle bk, Boundsheet sht, String parentDir, String externalDir, String[] c, String attrs) pass-through current sheet-level OOXML element/file - i.e.
void	PivotCache.init(StorageTable directories, WorkBookHandle wbh)
void	Mergedcells.initCells(WorkBookHandle wbook) Initialize the CellRanges containing the Merged Cells.
void	Hlink.initCells(WorkBookHandle wbook)
protected void	OOXMLReader.parseBookLevelElements(WorkBookHandle bk, WorkSheetHandle sheet, ZipFile zip, ArrayList cl, String parentDir, ArrayList formulas, ArrayList hyperlinks, HashMap inlineStrs, HashMap<String,String> pivotCaches, HashMap<String,WorkSheetHandle> pivotTables) parses OOXML content files given a content list cl from zip file zip recurses if content file has it's own content ************************************* NOTE: certain elements we do not as of yet process; we "pass-through" or store such elements along with any embedded objects associated with them for example, activeX objects, vbaProject.bin, etc.
void	OOXMLReader.parseNBind(WorkBookHandle bk, String fName) OOXML parseNBind - reads in an OOXML (Excel 7) workbook
static ArrayList	Sst.parseOOXML(WorkBookHandle bk, InputStream ii) given SharedStrings.xml OOXML inputstream, read in string and formatting data, if any and parse into ArrayList for later use in parseSheetOOXML
static Font	Font.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle bk) parse incoming OOXML into a Font object
static Condfmt	Condfmt.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle wb, Boundsheet bs) create one or more Data Validation records based on OOXML input
protected void	Boundsheet.parseSheetElements(WorkBookHandle bk, ZipFile zip, ArrayList cl, String parentDir, String externalDir, ArrayList formulas, ArrayList hyperlinks, HashMap inlineStrs, HashMap<String,WorkSheetHandle> pivotTables) parses OOXML content files given a content list cl from zip file zip recurses if content file has it's own content ************************************* NOTE: certain elements we do not as of yet process; we "pass-through" or store such elements along with any embedded objects associated with them for example, activeX objects, vbaProject.bin, etc.
static void	OOXMLAdapter.refreshPassThroughFiles(WorkBookHandle wbh) re-save to temp directroy any "pass-through" OOXML files i.e.
protected void	OOXMLWriter.writeOOXML(WorkBookHandle bk) Calls all the necessary methods to create style OOXML, workbook OOXML, sheet(s) OOXML ...
protected void	OOXMLWriter.writeSheetOOXML(WorkBookHandle bk, WorkSheetHandle sheet, int id) writeSheetOOXML writes XML data in SheetML specificaiton to [worksheet].xml Main portion is the section, containing all row and cell information format of SheetML: ROOT autoFilter (AutoFilter Settings) Hides rows based upon criteria cellWatches (Cell Watch Items) colBreaks (Vertical Page Breaks) cols (Column Information) conditionalFormatting (Conditional Formatting) controls (Embedded Controls) customProperties (Custom Properties) customSheetViews (Custom Sheet Views) dataConsolidate (Data Consolidate) dataValidations (Data Validations) dimension (Worksheet Dimensions) drawing (Drawing) extLst (Future Feature Data Storage Area) headerFooter (Header Footer Settings) hyperlinks (Hyperlinks) ignoredErrors (Ignored Errors) legacyDrawing (Legacy Drawing Reference) legacyDrawingHF (Legacy Drawing Reference in Header Footer) mergeCells (Merge Cells) oleObjects (Embedded Objects) pageMargins (Page Margins) pageSetup (Page Setup Settings) phoneticPr (Phonetic Properties) picture (Background Image) printOptions (Print Options) protectedRanges (Protected Ranges) rowBreaks (Horizontal Page Breaks (Row)) scenarios (Scenarios) sheetCalcPr (Sheet Calculation Properties) sheetData (Sheet Data) sheetFormatPr (Sheet Format Properties) sheetPr (Sheet Properties) sheetProtection (Sheet Protection Options) sheetViews (Sheet Views) smartTags (Smart Tags) sortState (Sort State) tableParts (Table Parts) webPublishItems (Web Publishing Items) * ORDER OF THE ABOVE: (sheet properties -- all optional) indicates that an autofilter has been applied indicates the used range on the sheet (there should be no data or formulas outside this range) indicates which cell and sheet are active default row height
protected void	OOXMLWriter.writeSheetPrefix(WorkSheetHandle sheet, WorkBookHandle bk, int id) Handles preliminary writing of worksheets, essentially everything before elements start

Uses of WorkBookHandle in io.starter.formats.XLS.charts

Fields in io.starter.formats.XLS.charts declared as WorkBookHandle

Modifier and Type	Field and Description
WorkBookHandle	Chart.wbh

Methods in io.starter.formats.XLS.charts with parameters of type WorkBookHandle

Modifier and Type	Method and Description
org.json.JSONObject	DoughnutChart.getJSON(ChartSeriesHandle[] series, WorkBookHandle wbh, Double[] minMax) return the JSON that
org.json.JSONObject	ScatterChart.getJSON(ChartSeriesHandle[] series, WorkBookHandle wbh, Double[] minMax)
org.json.JSONObject	PieChart.getJSON(ChartSeriesHandle[] series, WorkBookHandle wbh, Double[] minMax) return the JSON that
org.json.JSONObject	AreaChart.getJSON(ChartSeriesHandle[] series, WorkBookHandle wbh, Double[] minMax)
org.json.JSONObject	BarChart.getJSON(ChartSeriesHandle[] series, WorkBookHandle wbh, Double[] minMax) replaces generic getJSON with Bar/Column specifics (necessary for stacked-type charts)
org.json.JSONObject	ChartType.getJSON(ChartSeries s, WorkBookHandle wbh, Double[] minMax)
org.json.JSONObject	ChartAxes.getJSON(int axisType, WorkBookHandle wbh, int chartType, double yMax, double yMin, int nSeries)
org.json.JSONObject	Axis.getJSON(WorkBookHandle wbh, int chartType, double yMax, double yMin, int nSeries) return the JSON/Dojo representation of this axis chartType int necessary for parsing AXIS options: horizontal charts "switch" axes ...
HashMap	Chart.getMetrics(WorkBookHandle wbh)
double[]	Chart.getMinMax(WorkBookHandle wbh) returns the minimum and maximum values by examining all series on the chart
org.json.JSONObject	Axis.getMinMaxJSON(WorkBookHandle wbh, int chartType, double yMax, double yMin, int nSeries) return the JSON/Dojo representation of this axis chartType int necessary for parsing AXIS options: horizontal charts "switch" axes ...
void	ChartAxes.parseOOXML(int axisType, org.xmlpull.v1.XmlPullParser xpp, String tnm, Stack<String> lastTag, WorkBookHandle bk) parse OOXML axis element
void	ChartLine.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, ChartFormat cf, WorkBookHandle bk) parse a Chart Line OOXML element: either dropLines hiLowLines serLines
void	Axis.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, String axisTag, Stack<String> lastTag, WorkBookHandle bk) parse OOXML axis element
static ChartType	ChartType.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle wbh, Chart parentChart, int nChart) parse the chart object OOXML element (barchart, area3DChart, etc.) and create the corresponding chart type objects
static Series	ChartSeries.parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle wbh, ChartType parentChart, boolean hasPivotTableSource, Stack<String> lastTag) parse a chartSpace->chartType->ser element into our Series record/structure
void	ChartFormat.parseUpDownBarsOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) parse upDownBars OOXML element (controled by 2 DropBar records in this subArray) Valid for Line and Stock charts only
void	Series.setLegend(String newLegend, WorkBookHandle wbh) sets the legend for this series to a text value
void	OOXMLChart.setOOXMLTitle(Title t, WorkBookHandle wb) set the OOXML title element for this chart

Constructors in io.starter.formats.XLS.charts with parameters of type WorkBookHandle

Constructor and Description
OOXMLChart(Chart c, WorkBookHandle wbh) create a new OOXMLChart from a 2003-v chart object

Uses of WorkBookHandle in io.starter.OpenXLS

Fields in io.starter.OpenXLS declared as WorkBookHandle

Modifier and Type	Field and Description
protected WorkBookHandle	ChartHandle.wbh

Methods in io.starter.OpenXLS that return WorkBookHandle

Modifier and Type	Method and Description
WorkBookHandle	WorkBookHandle.getNoSheetWorkBook() Returns a WorkBookHandle containing an empty version of this WorkBook.
WorkBookHandle	WorkBook.getNoSheetWorkBook() Returns a WorkBookHandle containing an empty version of this WorkBook.
WorkBookHandle	WorkSheetHandle.getWorkBook() Returns the WorkBookHandle for this Sheet
WorkBookHandle	ChartHandle.getWorkBookHandle()

Methods in io.starter.OpenXLS with parameters of type WorkBookHandle

Modifier and Type	Method and Description
static int	FormatHandle.addFont(Font f, WorkBookHandle bk) adds a font to the global font store only if exact font is not already present
boolean	WorkBookHandle.addSheetFromWorkBook(WorkBookHandle sourceBook, String sourceSheetName, String destSheetName) Deprecated. - use addWorkSheet(WorkSheetHandle sht, String NewSheetName){
boolean	WorkBook.addSheetFromWorkBook(WorkBookHandle sourceBook, String sourceSheetName, String destSheetName) Inserts a worksheet from a Source WorkBook.
boolean	WorkBookHandle.addSheetFromWorkBookWithFormatting(WorkBookHandle sourceBook, String sourceSheetName, String destSheetName) Deprecated. - use addWorkSheet(WorkSheetHandle sht, String NewSheetName){
static CellRangeRef	CellRangeRef.fromA1(String reference, WorkBookHandle book) Convenience method combining CellRangeRef.fromA1(String) and CellRangeRef.resolve(WorkBookHandle).
static CellHandle[]	CellRange.getCells(String range, WorkBookHandle wbh) returns the cells for a given range static version
void	CellRangeRef.resolve(WorkBookHandle book) Resolves sheet names into sheet handles against the given book.

Constructors in io.starter.OpenXLS with parameters of type WorkBookHandle

Constructor and Description
ChartHandle(Chart c, WorkBookHandle wb) Constructor which creates a new ChartHandle from an existing Chart Object
ChartSeriesHandle(Series series, WorkBookHandle wbk) Constructor, used internally.
NameHandle(Name c, WorkBookHandle myb) Create a NameHandle from an internal Name record
NameHandle(String name, String location, WorkBookHandle book) Create a new named range in the workbook
NameHandle(String namestr, WorkBookHandle myb) Deprecated.
PivotTableHandle(Sxview f, WorkBookHandle bk) Create a new PivotTableHandle from an Excel PivotTable
WorkSheetHandle(Boundsheet sht, WorkBookHandle b) Constructor which takes a WorkBook and sheetname as parameters.