Uses of Interface
io.keikai.api.Range

Packages that use Range

Package	Description
io.keikai.api	Keikai Spreadsheet API classes.
io.keikai.api.impl	Keikai Spreadsheet API implementation classes, internal use only
io.keikai.api.model	Keikai Spreadsheet Model API classes.
io.keikai.api.model.impl	Keikai Spreadsheet Model API implementation classes, Internal use only
io.keikai.ui.event	Events of Keikai Spreadsheet UI Component.
io.keikai.ui.impl	Classes for implementing Keikai Spreadsheet UI Components (implementation only).
io.keikai.ui.impl.ua	Classes that doing system user action control on Keikai Spreadsheet UI Components.
io.keikai.ui.impl.undo	Classes that doing system undoable action control on Keikai Spreadsheet UI Components.
io.keikaiex.ui.impl.ua	Classes that doing system user action control on Keikai Spreadsheet UI Components.

Uses of Range in io.keikai.api

Methods in io.keikai.api that return Range

Modifier and Type	Method	Description
static Range	CellOperationUtil.cut(Range src, Range dest)	Cuts data and style from src to destination
Range	Range.findAutoFilterRange()	To find a range of cells for applying auto filter according to this range.
static Range	CellOperationUtil.paste(Range src, Range dest)	Paste data and style from src to destination
Range	Range.paste(Range dest)	Pastes to destination.
Range	Range.paste(Range dstRange, boolean cut)	Cut and paste to destination.
static Range	CellOperationUtil.pasteAllExceptBorder(Range src, Range dest)	Paste all (except border) from src to destination
static Range	CellOperationUtil.pasteFormula(Range src, Range dest)	Paste formula only from src to destination
static Range	CellOperationUtil.pasteSpecial(Range src, Range dest, Range.PasteType pasteType, Range.PasteOperation pasteOperation, boolean skipBlank, boolean transpose)	Paste according the argument from src to destination
Range	Range.pasteSpecial(Range dest, Range.PasteType type, Range.PasteOperation op, boolean skipBlanks, boolean transpose)	Pastes to destination.
static Range	CellOperationUtil.pasteTranspose(Range src, Range dest)	Paste and transpose from src to destination
static Range	CellOperationUtil.pasteValue(Range src, Range dest)	Paste value only from src to destination
static Range	Ranges.range(Book book)	Returns the associated Range of the whole specified Book.
static Range	Ranges.range(Sheet sheet)	Returns the associated Range of the whole specified Sheet.
static Range	Ranges.range(Sheet sheet, int row, int col)	Returns the associated Range of the specified Sheet and cell row and column.
static Range	Ranges.range(Sheet sheet, int tRow, int lCol, int bRow, int rCol)	Returns the associated XRange of the specified XSheet and area.
static Range	Ranges.range(Sheet sheet, AreaRef selection)	Returns the associated Range of the specified Sheet and cell row and column.
static Range	Ranges.range(Sheet sheet, CellRegion cellRegion)	Returns the associated Range of the specified Sheet and cell row and column.
static Range	Ranges.range(Sheet sheet, String areaReference)	Returns the associated Range of the specified Sheet and area reference string (e.g.
static Range	Ranges.rangeByName(Sheet sheet, String name)	Returns the associated Range of the specified name of a NamedRange (e.g.
Range	Range.toCellRange(int rowOffset, int colOffset)	Returns a new range having one cell according to the offset based on the left-top corner.
Range	Range.toColumnRange()	Return a range that represents all rows and between the first-column and last-column of this range It is a useful when you want to manipulate entire column (such as deleting columns)
Range	Range.toRowRange()	Return a range that represents all columns and between the first-row and last-row of this range.
Range	Range.toShiftedRange(int rowOffset, int colOffset)	Return a new range by shifting the current Range according to the offsets but still keep the original height and width e.g.

Methods in io.keikai.api that return types with arguments of type Range

Modifier and Type	Method	Description
List<Range>	Range.getColumnGroups()	Returns all group ranges for columns, which intersect with this range.
List<Range>	Range.getColumnGroups(int outlineLevel)	Returns all group ranges matched the given outline level for columns, which intersect with this range.
List<Range>	Range.getColumnGroups(int fromOutlineLevel, int toOutlineLevel)	Returns all group ranges matched between fromOutlineLevel and toOutlineLevel for columns, which intersect with this range.
Set<Range>	Range.getDependents()	Returns all Range(s) that are the direct or indirect dependents of this cell Range.
Set<Range>	Range.getDirectDependents()	Returns Range(s) that are the direct dependents of this cell Range.
Set<Range>	Range.getDirectPrecedents()	Returns Range(s) that are the direct precedents of this cell Range.
Set<Range>	Range.getPrecedents()	Returns all Range(s) that are the direct or indirect precedents of this cell Range.
List<Range>	Range.getRowGroups()	Returns all group ranges for rows, which intersect with this range.
List<Range>	Range.getRowGroups(int outlineLevel)	Returns all group ranges matched the given outline level for rows, which intersect with this range.
List<Range>	Range.getRowGroups(int fromOutlineLevel, int toOutlineLevel)	Returns all group ranges matched between fromOutlineLevel and toOutlineLevel for rows, which intersect with this range.
Stream<Range>	Range.nOrderStream()	Returns a n-order cell range stream which treats a merged cell as one range.
Stream<Range>	Range.zOrderStream()	Returns a z-order cell range stream which treats a merged cell as one range.

Methods in io.keikai.api with parameters of type Range

Modifier and Type	Method	Description
static Chart	SheetOperationUtil.addChart(Range range, Chart.Type type, Chart.Grouping grouping, Chart.LegendPosition pos)	Adds a chart to specified sheet range in pre-defined position and size.
static Chart	SheetOperationUtil.addChart(Range range, SheetAnchor anchor, Chart.Type type, Chart.Grouping grouping, Chart.LegendPosition pos)	Adds a chart at the specified location
static Chart	SheetOperationUtil.addChart(String name, Range range, Chart.Type type, Chart.Grouping grouping, Chart.LegendPosition pos)	Adds a chart to specified sheet range in pre-defined position and size.
static Chart	SheetOperationUtil.addChart(String name, Range range, SheetAnchor anchor, Chart.Type type, Chart.Grouping grouping, Chart.LegendPosition pos)	Adds a chart at the specified location
static Picture	SheetOperationUtil.addPicture(Range range, byte[] binary, Picture.Format format, int widthPx, int heightPx)	Add picture to the range
static Picture	SheetOperationUtil.addPicture(Range range, SheetAnchor anchor, byte[] binary, Picture.Format format)	Add picture to the range
static Picture	SheetOperationUtil.addPicture(Range range, org.zkoss.image.AImage image)	Add picture to the range
static void	SheetOperationUtil.addSheet(Range range, String prefix)	Add a new sheet to this book
void	CellOperationUtil.CellStyleApplier.apply(Range cellRange)	apply style to a single cell range
static void	CellOperationUtil.applyAlignment(Range range, CellStyle.Alignment alignment)	Apply alignment to cells in the range
static void	SheetOperationUtil.applyAutoFilter(Range range)	Re-apply autofilter
static void	CellOperationUtil.applyBackColor(Range range, String htmlColor)	Apply back-color to cells in the range
static void	CellOperationUtil.applyBorder(Range range, Range.ApplyBorderType applyType, CellStyle.BorderType borderType, String htmlColor)	Apply border to cells in the range
static void	CellOperationUtil.applyCellStyle(Range range, CellOperationUtil.CellStyleApplier applyer)	Apply style according to the cell style applier
static void	CellOperationUtil.applyDataFormat(Range range, String format)	Apply data-format to cells in the range
static void	CellOperationUtil.applyFillColor(Range range, String htmlColor)	Apply fill-color to cells in the range
static void	CellOperationUtil.applyFontBoldweight(Range range, Font.Boldweight boldweight)	Apply font bold-weight to cells in the range
static void	CellOperationUtil.applyFontColor(Range range, String htmlColor)	Apply font color to cells in the range
static void	CellOperationUtil.applyFontHeightPoints(Range range, int fontHeightPoints)	Apply font height to cells in the range, it will also enlarge the row height if row height is smaller than font height
static void	CellOperationUtil.applyFontItalic(Range range, boolean italic)	Apply font italic to cells in the range
static void	CellOperationUtil.applyFontName(Range range, String fontName)	Apply font to cells in the range
static void	CellOperationUtil.applyFontStrikeout(Range range, boolean strikeout)	Apply font strike-out to cells in the range
static void	CellOperationUtil.applyFontTypeOffset(Range range, Font.TypeOffset offset)	Apply font typeOffset to cells in the range
static void	CellOperationUtil.applyFontUnderline(Range range, Font.Underline underline)	Apply font underline to cells in the range
static void	CellOperationUtil.applyHyperlink(Range range, Hyperlink.HyperlinkType type, String address, String label)
static void	CellOperationUtil.applyIndentionOffset(Range range, int offset)	Apply indention to cells in the range
static void	CellOperationUtil.applyLocked(Range range, boolean locked)	Apply the locked status only to cells in the range
static void	CellOperationUtil.applyRotation(Range range, int rotation)	Apply alignment to cells in the range
static void	CellOperationUtil.applyVerticalAlignment(Range range, CellStyle.VerticalAlignment alignment)	Apply vertical-alignment to cells in the range
void	CellOperationUtil.CellStyleApplierEx.applyWhole(Range cellRange)	apply style to new cell
static void	CellOperationUtil.applyWrapText(Range range, boolean wraptext)	Apply text-warp to cells in the range
static void	CellOperationUtil.autoFill(Range src, Range dest, Range.AutoFillType type)	Fills data from source range to destination range automatically upon auto fill type
void	Range.autoFill(Range dest, Range.AutoFillType fillType)	According to current range, fills data to destination range automatically
static void	CellOperationUtil.clearAll(Range range)	Clear all
static void	CellOperationUtil.clearContents(Range range)	Clear contents
static void	CellOperationUtil.clearStyles(Range range)	Clear style
static void	SheetOperationUtil.copySheet(Range range)	Copy the sheet with the naming pattern "ORIGINAL_SHEET_NAME (n)".
static void	SheetOperationUtil.createSheet(Range range, String name)	Add a new sheet as the last sheet to this book
static Range	CellOperationUtil.cut(Range src, Range dest)	Cuts data and style from src to destination
static void	CellOperationUtil.delete(Range range, Range.DeleteShift shift)	Delete cells of the range.
static void	SheetOperationUtil.deleteChart(Range range, Chart chart)	Delete a chart if the specified Range has the specified chart.
static void	CellOperationUtil.deleteColumn(Range range)	Delete columns to the range.
static void	SheetOperationUtil.deletePicture(Range range, Picture picture)	Delete a picture
static void	CellOperationUtil.deleteRow(Range range)	Delete rows of the range.
static void	SheetOperationUtil.deleteSheet(Range range)	Deletes the sheet, notice that it prevents you from deleting the last sheet
static void	SheetOperationUtil.displaySheetGridlines(Range range, boolean enable)	Enables/disables to show a sheet's gridlines.
static void	CellOperationUtil.fitFontHeightPoints(Range range)	Detect the highest words in each row.
static boolean	SheetOperationUtil.hasChart(Range range, Chart chart)	Returns whether the range of sheet has the chart.
static boolean	SheetOperationUtil.hasPicture(Range range, Picture picture)	Returns whether the range of sheet has the picture
static void	CellOperationUtil.hide(Range range)	Hide the range.
static void	CellOperationUtil.insert(Range range, Range.InsertShift shift, Range.InsertCopyOrigin copyOrigin)	Insert cells to the range.
static void	CellOperationUtil.insertColumn(Range range)	Insert columns to the range.
static void	CellOperationUtil.insertRow(Range range)	Insert rows to the range.
static void	CellOperationUtil.merge(Range range, boolean across)	merge the range
static void	SheetOperationUtil.moveChart(Range range, Chart chart, int rowIndex, int columnIndex)	Move a chart to specified row and column.
static void	SheetOperationUtil.movePicture(Range range, Picture picture, int rowIndex, int columnIndex)	Move a picture to specified row and column.
void	CellOperationUtil.CellStyleApplier.notifyChange(Range range)	NotifyChange after applying the style to all cells.
static Range	CellOperationUtil.paste(Range src, Range dest)	Paste data and style from src to destination
Range	Range.paste(Range dest)	Pastes to destination.
Range	Range.paste(Range dstRange, boolean cut)	Cut and paste to destination.
static Range	CellOperationUtil.pasteAllExceptBorder(Range src, Range dest)	Paste all (except border) from src to destination
static Range	CellOperationUtil.pasteFormula(Range src, Range dest)	Paste formula only from src to destination
static Range	CellOperationUtil.pasteSpecial(Range src, Range dest, Range.PasteType pasteType, Range.PasteOperation pasteOperation, boolean skipBlank, boolean transpose)	Paste according the argument from src to destination
Range	Range.pasteSpecial(Range dest, Range.PasteType type, Range.PasteOperation op, boolean skipBlanks, boolean transpose)	Pastes to destination.
static Range	CellOperationUtil.pasteTranspose(Range src, Range dest)	Paste and transpose from src to destination
static Range	CellOperationUtil.pasteValue(Range src, Range dest)	Paste value only from src to destination
static void	SheetOperationUtil.protectSheet(Range range, String password, boolean allowSelectingLockedCells, boolean allowSelectingUnlockedCells, boolean allowFormattingCells, boolean allowFormattingColumns, boolean allowFormattingRows, boolean allowInsertColumns, boolean allowInsertRows, boolean allowInsertingHyperlinks, boolean allowDeletingColumns, boolean allowDeletingRows, boolean allowSorting, boolean allowFiltering, boolean allowUsingPivotTables, boolean drawingObjects, boolean scenarios)
static void	SheetOperationUtil.protectSheet(Range range, String password, String newpasswrod)
static void	SheetOperationUtil.renameSheet(Range range, String newname)	Rename a sheet
static void	SheetOperationUtil.resetAutoFilter(Range range)	Resets AutoFilter
void	RangeRunner.run(Range range)	main execution method
static void	CellOperationUtil.setColumnWidth(Range range, int widthPx)	Sets the column width.
static void	CellOperationUtil.setRowHeight(Range range, int heightPx)	Sets the row height and make it as custom modified
static void	CellOperationUtil.setRowHeight(Range range, int heightPx, boolean isCustom)	Sets the row height and provide a custom flag, a custom flag to indicate this height was set by user or system.
static void	SheetOperationUtil.setSheetOrder(Range range, int pos)	Sets a sheet's position order, used to move a sheet
static void	CellOperationUtil.shift(Range range, int rowOffset, int colOffset)	Shifts/moves cells with a offset row and column
static void	CellOperationUtil.sort(Range range, boolean desc)	Sort range
static void	CellOperationUtil.sort(Range range, Range index1, boolean desc1, Range.SortDataOption dataOption1, Range index2, boolean desc2, Range.SortDataOption dataOption2, Range index3, boolean desc3, Range.SortDataOption dataOption3, boolean header, boolean matchCase, boolean sortByRows)	Sort range
void	Range.sort(Range index1, boolean desc1, Range.SortDataOption dataOption1, Range index2, boolean desc2, Range.SortDataOption dataOption2, Range index3, boolean desc3, Range.SortDataOption dataOption3, boolean header, boolean matchCase, boolean sortByRows)	Sort range
static SheetAnchor	SheetOperationUtil.toChartAnchor(Range range)	Create a anchor by range's row/column data
static void	SheetOperationUtil.toggleAutoFilter(Range range)	Toggles AutoFilter on or off
static void	CellOperationUtil.toggleMergeCenter(Range range)	Toggle merge/unmerge of the range, if merging it will also set alignment to center
static void	CellOperationUtil.unhide(Range range)	Unhide the range.
static void	CellOperationUtil.unmerge(Range range)	Unmerge the range
static boolean	SheetOperationUtil.unprotectSheet(Range range, String password)
boolean	CellVisitor.visit(Range cellRange)	Visits the cell

Uses of Range in io.keikai.api.impl

Classes in io.keikai.api.impl that implement Range

Modifier and Type	Class	Description
class	RangeImpl	1.Range does not handle the protection issue.

Methods in io.keikai.api.impl that return Range

Modifier and Type	Method	Description
Range	RangeImpl.findAutoFilterRange()
Range	RangeImpl.paste(Range dest)
Range	RangeImpl.paste(Range dest, boolean cut)
Range	RangeImpl.pasteSpecial(Range dest, Range.PasteType type, Range.PasteOperation op, boolean skipBlanks, boolean transpose)

Methods in io.keikai.api.impl that return types with arguments of type Range

Modifier and Type	Method	Description
List<Range>	RangeImpl.getColumnGroups()
List<Range>	RangeImpl.getColumnGroups(int outlineLevel)
List<Range>	RangeImpl.getColumnGroups(int fromOutlineLevel, int toOutlineLevel)
Set<Range>	RangeImpl.getDependents()
Set<Range>	RangeImpl.getDirectDependents()
Set<Range>	RangeImpl.getDirectPrecedents()
Set<Range>	RangeImpl.getPrecedents()
List<Range>	RangeImpl.getRowGroups()
List<Range>	RangeImpl.getRowGroups(int outlineLevel)
List<Range>	RangeImpl.getRowGroups(int fromOutlineLevel, int toOutlineLevel)
Stream<Range>	RangeImpl.nOrderStream()
Stream<Range>	RangeImpl.zOrderStream()

Methods in io.keikai.api.impl with parameters of type Range

Modifier and Type	Method	Description
void	RangeImpl.autoFill(Range dest, Range.AutoFillType fillType)
Range	RangeImpl.paste(Range dest)
Range	RangeImpl.paste(Range dest, boolean cut)
Range	RangeImpl.pasteSpecial(Range dest, Range.PasteType type, Range.PasteOperation op, boolean skipBlanks, boolean transpose)
void	RangeImpl.sort(Range key1, boolean desc1, Range.SortDataOption dataOption1, Range key2, boolean desc2, Range.SortDataOption dataOption2, Range key3, boolean desc3, Range.SortDataOption dataOption3, boolean header, boolean matchCase, boolean sortByRows)

Uses of Range in io.keikai.api.model

Methods in io.keikai.api.model with parameters of type Range

Modifier and Type	Method	Description
void	Chart.setDataRange(Range range)	change the data range and rerender

Uses of Range in io.keikai.api.model.impl

Methods in io.keikai.api.model.impl with parameters of type Range

Modifier and Type	Method	Description
void	ChartImpl.setDataRange(Range range)

Uses of Range in io.keikai.ui.event

Methods in io.keikai.ui.event that return Range

Modifier and Type	Method	Description
Range	GroupOpenEvent.getRange()	Returns the group range in a whole rows or columns based on GroupOpenEvent.isRow().

Methods in io.keikai.ui.event that return types with arguments of type Range

Modifier and Type	Method	Description
List<Range>	GroupHeaderClickEvent.getCollapsedGroups()	Returns all the collapsed groups in rows or columns.
List<Range>	GroupHeaderClickEvent.getExpandedGroups()	Returns all the expanded groups in rows or columns.

Uses of Range in io.keikai.ui.impl

Methods in io.keikai.ui.impl with parameters of type Range

Modifier and Type	Method	Description
static void	ActionHelper.collectRichTextStyleActions(Range range, CellOperationUtil.CellStyleApplier applier, List<UndoableAction> actions)	Scan the given range and collect rich text cells actions which will be applied with the applier.

Uses of Range in io.keikai.ui.impl.ua

Methods in io.keikai.ui.impl.ua with parameters of type Range

Modifier and Type	Method	Description
protected boolean	AbstractHandler.checkInArrayFormula(Range range)
protected boolean	AbstractHandler.checkInCornerFreezePanel(Range range)

Uses of Range in io.keikai.ui.impl.undo

Constructors in io.keikai.ui.impl.undo with parameters of type Range

Modifier	Constructor	Description
	SortCellAction(String label, Sheet sheet, int row, int column, int lastRow, int lastColumn, Range index1, boolean desc1)
	SortCellAction(String label, Sheet sheet, int row, int column, int lastRow, int lastColumn, Range index1, boolean desc1, Range.SortDataOption dataOption1, Range index2, boolean desc2, Range.SortDataOption dataOption2, Range index3, boolean desc3, Range.SortDataOption dataOption3, boolean header, boolean matchCase, boolean sortByRows)

Uses of Range in io.keikaiex.ui.impl.ua

Methods in io.keikaiex.ui.impl.ua with parameters of type Range

Modifier and Type	Method	Description
protected boolean	DataValidationHandler.isOverlapped(Range range)	Detect if current selection has two validation or 1 validation with any empty cells
protected void	DataValidationHandler.validTableTotalRows(Range range)