Uses of Class
io.starter.OpenXLS.WorkSheetHandle

Packages that use WorkSheetHandle

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

Uses of WorkSheetHandle 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 WorkSheetHandle

Modifier and Type	Method and Description
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.
protected CellHandle	OOXMLReader.sheetAdd(WorkSheetHandle sheet, Object val, Object cachedval, int r, int c, int fmtid) intercept Sheet adds and hand off to parse event listener as needed
protected void	OOXMLWriter.writeMergedCellRecords(WorkSheetHandle sheet) Write the merged cell records for a worksheet
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

Method parameters in io.starter.formats.XLS with type arguments of type WorkSheetHandle

Modifier and Type	Method and Description
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.
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.

Uses of WorkSheetHandle in io.starter.OpenXLS

Methods in io.starter.OpenXLS that return WorkSheetHandle

Modifier and Type	Method and Description
WorkSheetHandle	WorkBookHandle.addWorkSheet(WorkSheetHandle sourceSheet) Inserts a WorkSheetHandle from a separate WorkBookhandle into the current WorkBookHandle.
WorkSheetHandle	WorkBookHandle.addWorkSheet(WorkSheetHandle sourceSheet, String NewSheetName) Inserts a WorkSheetHandle from a separate WorkBookhandle into the current WorkBookHandle.
WorkSheetHandle	WorkBook.addWorkSheet(WorkSheetHandle sht, String NewSheetName) Inserts a new worksheet and places it at the end of the workbook
WorkSheetHandle	WorkBookHandle.copyWorkSheet(String SourceSheetName, String NewSheetName) Copy (duplicate) a worksheet in the workbook and add it to the end of the workbook with a new name
WorkSheetHandle	WorkBook.copyWorkSheet(String SourceSheetName, String NewSheetName) Copy (duplicate) a worksheet in the workbook and add it to the end of the workbook with a new name
WorkSheetHandle	WorkBookHandle.createWorkSheet(String name) Creates a new worksheet and places it at the end of the workbook.
WorkSheetHandle	WorkBook.createWorkSheet(String name) Creates a new worksheet and places it at the end of the workbook
WorkSheetHandle	WorkBookHandle.createWorkSheet(String name, int sheetpos) Creates a new worksheet and places it at the specified position.
WorkSheetHandle	WorkBookHandle.getActiveSheet() returns the active or selected worksheet tab
WorkSheetHandle	CellRangeRef.getFirstSheet() Returns the first sheet in this range.
WorkSheetHandle	CellRangeRef.getLastSheet() Returns the last sheet in this range.
WorkSheetHandle[]	NameHandle.getReferencedSheets() Get WorkSheetHandles for all of the Boundsheets referenced in this NameHandle.
WorkSheetHandle	CellRange.getSheet() Returns the WorkSheet referenced in this CellRange.
WorkSheetHandle	WorkBookHandle.getWorkSheet(int sheetnum) returns the handle to a WorkSheet by number.
WorkSheetHandle	WorkBook.getWorkSheet(int i) returns the handle to a WorkSheet by name.
WorkSheetHandle	WorkBookHandle.getWorkSheet(String handstr) returns the handle to a WorkSheet by name.
WorkSheetHandle	WorkBook.getWorkSheet(String handstr) returns the handle to a WorkSheet by name.
WorkSheetHandle	CellHandle.getWorkSheetHandle() get the WorkSheetHandle for this Cell
WorkSheetHandle	ChartHandle.getWorkSheetHandle()
WorkSheetHandle	RowHandle.getWorkSheetHandle()
WorkSheetHandle	ConditionalFormatHandle.getWorkSheetHandle() get the WorkSheetHandle for this ConditionalFormat ConditionalFormats are bound to a specific worksheet and cannot be applied to multiple worksheets
WorkSheetHandle	PivotTableHandle.getWorkSheetHandle()
WorkSheetHandle[]	WorkBookHandle.getWorkSheets() Returns an array of handles to all of the WorkSheets in the Workbook.
WorkSheetHandle[]	WorkBook.getWorkSheets() Returns an array of handles to all of the WorkSheets in the Workbook.

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

Modifier and Type	Method and Description
WorkSheetHandle	WorkBookHandle.addWorkSheet(WorkSheetHandle sourceSheet) Inserts a WorkSheetHandle from a separate WorkBookhandle into the current WorkBookHandle.
WorkSheetHandle	WorkBookHandle.addWorkSheet(WorkSheetHandle sourceSheet, String NewSheetName) Inserts a WorkSheetHandle from a separate WorkBookhandle into the current WorkBookHandle.
WorkSheetHandle	WorkBook.addWorkSheet(WorkSheetHandle sht, String NewSheetName) Inserts a new worksheet and places it at the end of the workbook
CellRange	CellRange.copy(WorkSheetHandle sheet, int row, int col, int what) Copies this range to another location.
static CellHandle	CellHandle.copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet) Create a copy of this Cell in another WorkBook
static CellHandle	CellHandle.copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet, int row, int col) Creates a copy of this cell on the given worksheet at the given address.
static CellHandle	CellHandle.copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet, int row, int col, boolean copyByValue) Creates a copy of this cell on the given worksheet at the given address.
void	WorkBookHandle.copyChartToSheet(ChartHandle chart, WorkSheetHandle sheet) Copies an existing Chart to another WorkSheet
void	WorkBook.copyChartToSheet(ChartHandle chart, WorkSheetHandle sheet) Copies an existing Chart to another WorkSheet
ChartHandle	WorkBookHandle.createChart(String name, WorkSheetHandle wsh) Creates a new Chart and places it at the end of the workbook
static ChartHandle	ChartHandle.createNewChart(WorkSheetHandle sheet, int chartType, EnumSet<ChartHandle.ChartOptions> options) Static method to create a new chart on WorkSheet sheet of type chartType with chart Options options After creating, you can set the chart title via ChartHandle.setTitle and Position via ChartHandle.setRelativeBounds (row/col-based) or ChartHandle.setCoords (pixel-based) as well as several other customizations possible
void	WorkBookHandle.deleteChart(String chartname, WorkSheetHandle wsh) delete an existing chart of the workbook
static CellHandle[]	ExcelTools.getCellHandlesFromSheet(String strRange, WorkSheetHandle sheet) Return an array of cell handles specified from the string passed in.
void	ChartHandle.parseXML(WorkSheetHandle sht, org.xmlpull.v1.XmlPullParser xpp, HashMap<?,?> maps) given a XmlPullParser positioned at the chart element, parse all chart elements to create desired chart
void	CellRangeRef.setFirstSheet(WorkSheetHandle sheet) Sets the first sheet in this range.
void	CellRangeRef.setLastSheet(WorkSheetHandle sheet) Sets the last sheet in this range.
void	CellRange.setSheet(WorkSheetHandle aSheet) Sets the sheet reference for this CellRange.
void	CellHandle.setWorkSheetHandle(WorkSheetHandle handle) set the WorkSheetHandle for this Cell

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

Constructor and Description
CellRange(WorkSheetHandle sht, int[] coords) Constructor to create a new CellRange from a WorkSheetHandle and a set of range coordinates: coords[0] = first row coords[1] = first col coords[2] = last row coords[3] = last col
CellRange(WorkSheetHandle sht, int[] coords, boolean cb) Constructor to create a new CellRange from a WorkSheetHandle and a set of range coordinates: coords[0] = first row coords[1] = first col coords[2] = last row coords[3] = last col
CellRange(WorkSheetHandle sheet, int row, int col, int width, int height) Protected constructor for creating result ranges.
CellRangeRef(int first_row, int first_col, int last_row, int last_col, WorkSheetHandle first_sheet, WorkSheetHandle last_sheet)
ColHandle(Colinfo c, WorkSheetHandle sheet) creates a new ColHandle from a Colinfo Object and reference to a worksheet (WorkSheetHandle Object)
ConditionalFormatHandle(Condfmt c, WorkSheetHandle workSheetHandle) For internal use only.
ImageHandle(InputStream imagebytestream, WorkSheetHandle _sheet) Constructor which takes image file bytes and inserts into specific sheet
RowHandle(Row c, WorkSheetHandle ws)