Range (Keikai Spreadsheet Build 5.0.0 API)

All Known Implementing Classes:

RangeImpl
```
public interface Range
```
Range can represent a cell, a row, a column, a selection of cells containing one or more contiguous blocks of cells, or a 3-D blocks of cells.
You have to use this class's API to do any operation of the Sheet, then the upload will sync to the UI automatically.
To get the instance of a Range, please use the Ranges API.
Note : the range API doesn't check the sheet protection, if you care it, you have to check it by calling isProtected() before you do any operation.

Since:

3.0.0

Author:

dennis

See Also:

Ranges

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Range.ApplyBorderType`
`static class`	`Range.AutoFillType`
`static class`	`Range.AutoFilterOperation`
`static class`	`Range.CellAttribute`
`static interface`	`Range.CellStyleHelper` a cell style helper to create style relative object for cell
`static class`	`Range.DeleteShift` Shift direction of delete api
`static class`	`Range.InsertCopyOrigin` Copy origin format/style of insert
`static class`	`Range.InsertShift` Shift direction of insert api
`static class`	`Range.PasteOperation`
`static class`	`Range.PasteType`
`static class`	`Range.SheetVisible`
`static class`	`Range.SortDataOption`
`static class`	`Range.SyncLevel` Deprecated. since 3.5 It is always synchronized on Book by a read-write lock

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Chart`	`addChart(SheetAnchor anchor, Chart.Type type, Chart.Grouping grouping, Chart.LegendPosition pos)` Adds chart to sheet
`Picture`	`addPicture(SheetAnchor anchor, byte[] image, Picture.Format format)` Adds picture to sheet
`void`	`applyAutoFilter()` Re-applies the filter, filter by last condition and data again.
`void`	`applyBorders(Range.ApplyBorderType applyType, CellStyle.BorderType borderType, String htmlColor)` apply borders
`String`	`asString()` get formatted string of this range
`void`	`autoFill(Range dest, Range.AutoFillType fillType)` According to current range, fills data to destination range automatically
`void`	`clearAll()` Clears contents, styles and unmerge this range.
`void`	`clearContents()` Clears contents
`void`	`clearStyles()` Clears styles
`Sheet`	`cloneSheet(String name)` Clone this sheet; create a sheet and copy the contents of this sheet; then add to the end of the book.
`Sheet`	`cloneSheetFrom(String name, Sheet sheet)` Clone from the specified source sheet to the owner book of this range.
`void`	`createName(String nameName)` Create a `Name` that refer to this range.
`Sheet`	`createSheet(String name)` Creates a new sheet
`void`	`delete(Range.DeleteShift shift)` Delete cells of the range.
`void`	`deleteChart(Chart chart)` Deletes chart
`void`	`deletePicture(Picture picture)` Deletes picture that in sheet
`void`	`deleteSheet()` Deletes sheet.
`void`	`deleteValidation()` Delete the `Validation` associated in the specified range.
`void`	`enableAutoFilter(boolean enable)` Enable/disable autofilter of the sheet
`void`	`enableAutoFilter(int field, Range.AutoFilterOperation filterOp, Object criteria1, Object criteria2, Boolean showButton)` Enables autofilter and set extra condition
`void`	`fillDown()` Fills cells by copying from first/top row data
`void`	`fillLeft()` Fills cells by copying from last/right column data
`void`	`fillRight()` Fills cells by copying from first/left column data
`void`	`fillUp()` Fills cells by copying from bottom row data
`Range`	`findAutoFilterRange()` To find a range of cells for applying auto filter according to this range.
`Book`	`getBook()` Gets the book of this range
`CellData`	`getCellData()` Gets the first cell(top-left) data of this range
`String`	`getCellDataFormat()` Gets the first cell(top-left) format of this range
`String`	`getCellEditText()` Gets the first cell(top-left) edit text of this range
`String`	`getCellFormatText()` Gets the first cell(top-left) formatted text of this range
`Hyperlink`	`getCellHyperlink()` Gets the first cell(top-left) `Hyperlink` object of this range.
`String`	`getCellRichText()` Returns text in html format; null if not a rich text.
`CellStyle`	`getCellStyle()` Gets the first cell(top-left) style of this range
`Range.CellStyleHelper`	`getCellStyleHelper()` Gets cell-style-helper, this helper helps you to create new style, font or color
`Object`	`getCellValue()` Gets the first cell(top-left) value of this this range
`int`	`getColumn()` Gets the left column of this range
`int`	`getColumnCount()` Gets the column count of this range
`String`	`getCommentRichText()` Return the comment rich edit text of the left top cell of this Range.
`CellRegion`	`getDataRegion()` Returns the region which contains data(including chart, picture, and fills) in the sheet of this Range; return null if empty sheet.
`SRange`	`getInternalRange()` Get internal range implementation
`int`	`getLastColumn()` Gets the right/last column of this range
`int`	`getLastRow()` Gets the bottom/last row of this range
`ReadWriteLock`	`getLock()`
`CellRegion`	`getMergedRegion()` Returns the merged region of the left top cell of this Range if any; otherwise, returns null if not a merged region.
`Font`	`getOrCreateFont(Font.Boldweight boldweight, Color color, int fontHeight, String fontName, boolean italic, boolean strikeout, Font.TypeOffset typeOffset, Font.Underline underline)` Get font if exists or create font if not exists from the book of this range and return it.
`int`	`getRow()` Gets the top row of this range
`int`	`getRowCount()` Gets the row count of this range
`Sheet`	`getSheet()` Gets the sheet of this range
`String`	`getSheetName()` Gets the sheet name
`int`	`getSheetOrder()` Gets the sheet order
`SheetProtection`	`getSheetProtection()` Gets `SheetProtection` which tells what are allowed operations for a protected sheet of this range.
`List<Validation>`	`getValidations()` Gets read only `Validation` associated with the left-top cell of this range; return null if no associated validation.
`boolean`	`hasMergedCell()`
`void`	`insert(Range.InsertShift shift, Range.InsertCopyOrigin copyOrigin)` Insert new cells to the area of this range. To insert a row, you have to call `toRowRange()` first, to insert a column, you have to call `toColumnRange()` first.
`boolean`	`isAutoFilterEnabled()`
`boolean`	`isCommentVisible()` Returns whether the comment is always visible at the left top cell of this range; if no comment at the cell, it returns false.
`boolean`	`isDisplaySheetGridlines()`
`boolean`	`isMergedCell()`
`boolean`	`isProtected()`
`boolean`	`isSheetProtected()`
`boolean`	`isWholeColumn()` Check if this range represents a whole column, which mean all rows are included,
`boolean`	`isWholeRow()` Check if this range represents a whole row, which mean all column are included,
`boolean`	`isWholeSheet()` Check if this range represents a whole sheet, which mean all column and row are included,
`void`	`merge(boolean across)` Merges the range
`void`	`moveChart(SheetAnchor anchor, Chart chart)` Moves chart to new location
`void`	`movePicture(SheetAnchor anchor, Picture picture)` Moves picture
`void`	`notifyChange()` Notify this range has been changed.
`void`	`notifyChange(Range.CellAttribute cellAttr)` Notify this range has been changed on the specifield attribute.
`void`	`notifyChange(String[] variables)` Notify the whole book of specified variables change.
`Range`	`paste(Range dest)` Pastes to destination
`Range`	`paste(Range dstRange, boolean cut)` Cut and paste to destination
`Range`	`pasteSpecial(Range dest, Range.PasteType type, Range.PasteOperation op, boolean skipBlanks, boolean transpose)` Pastes to destination
`void`	`protectSheet(SheetProtection protection)` Protect a `Sheet` so that it cannot be modified.
`void`	`protectSheet(String password)` Deprecated. use `protectSheet(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)` instead Enable sheet protection and apply a password, or null to disable protection
`void`	`protectSheet(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)` Protect a `Sheet` so that it cannot be modified.
`void`	`refresh(boolean includeDependants)` Enforce evaluation(if not cached) and refresh UI of this range and its dependent cells if the includeDependents is true.
`void`	`refresh(boolean includeDependents, boolean clearCache, boolean enforceEval)` Update data model and refresh UI of this range and its dependent cells if the argument includeDependents is true.
`void`	`resetAutoFilter()` Clears condition of filter, show all the data
`boolean`	`setAutoRefresh(boolean auto)` Turn on(true)/off(false) of auto refresh of this range and return previous on/off status; default is true.
`void`	`setCellEditText(String editText)` Sets cell editText, applies it to all cells of this range
`void`	`setCellHyperlink(Hyperlink.HyperlinkType type, String address, String label)` Sets cell hyperlink, applies it too all cells
`void`	`setCellRichText(String html)` Set into the left top cell of this Range the specified text in html format.
`void`	`setCellStyle(CellStyle nstyle)` Sets cell style, applies it to all cells of this range
`void`	`setCellValue(Object value)` Sets cell data value, applies it to all cells
`void`	`setColumnWidth(int widthPx)` Sets the width(in pixel) of column in this range, it effect to whole column.
`void`	`setCommentRichText(String html)` Set comment rich text into the left top cell of this range; null to delete it.
`void`	`setCommentVisible(boolean visible)` Set comment visibility into the left top cell of this range; if no comment at the cell, it simply ignored.
`void`	`setDisplaySheetGridlines(boolean enable)` Displays sheet grid-lines or not
`void`	`setFreezePanel(int rowfreeze, int columnfreeze)` Set the freeze panel
`void`	`setHidden(boolean hidden)` Hide or unhide rows or columns. To hide/unhide a row, you have to call `toRowRange()` first, to hide/un-hide a column, you have to call `toColumnRange()` or a whole column range.
`void`	`setNameName(String namename, String newname)` Set(Rename) the name of the Name(or Table) as specified in this Range(a Book or a Sheet).
`void`	`setRowHeight(int heightPx)` Sets the height(in pixel) of row in this range, it effect to whole row.
`void`	`setRowHeight(int heightPx, boolean isCustom)` Sets the height(in pixel) of row in this range and specify it's custom size or not.
`void`	`setSheetName(String name)` Sets the sheet name
`void`	`setSheetOrder(int pos)` Sets the sheet order
`void`	`setSheetVisible(Range.SheetVisible visible)` Setup sheet's visibility; can be VISIBLE, HIDDEN, or VERY_HIDDEN.
`void`	`setStringValue(String value)` Save the specified value into this range as a String no matter the value is prefixed with '=' or not.
`void`	`setSyncLevel(Range.SyncLevel syncLevel)` Deprecated. It is always synchronized on Book by a read-write lock
`void`	`setValidation(Validation.ValidationType validationType, boolean ignoreBlank, Validation.OperatorType operatorType, boolean inCellDropDown, String formula1, String formula2, boolean showInput, String inputTitle, String inputMessage, boolean showError, Validation.AlertStyle alertStyle, String errorTitle, String errorMessage)` Add if not exist or modify an existing `Validation` to this range.
`void`	`shift(int rowOffset, int colOffset)` Shifts/moves cells with a offset row and column
`void`	`sort(boolean desc)` Sort range
`void`	`sort(boolean desc, boolean header, boolean matchCase, boolean sortByRows, Range.SortDataOption dataOption)` Sort range
`void`	`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
`void`	`sync(RangeRunner run)` Runs runer under synchronization protection
`Range`	`toCellRange(int rowOffset, int colOffset)` Returns a new range having on cell according to the offset
`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 delete column)
`Range`	`toRowRange()` Return a range that represents all columns and between the first-row and last-row of this range.
`Range`	`toShiftedRange(int rowOffset, int colOffset)` Return a new range that shift it row and column according to the offset, but has same height and width of original range.
`void`	`unmerge()` Unmerge the range
`boolean`	`unprotectSheet(String password)` Removes protection from a sheet.
`void`	`updateChart(Chart chart)` Notify the component that a chart has change, e.g.
`Validation`	`validate(String editText)` validate the user's input.
`void`	`visit(CellVisitor visitor)` Visits all cells in this range with synchronization protection, make sure you call this in a limited range, don't use it for all row/column selection, it will spend much time to iterate the cell

- Method Detail
  - setSyncLevel
```
void setSyncLevel(Range.SyncLevel syncLevel)
```
    Deprecated. It is always synchronized on Book by a read-write lock
    
    Sets the synchronization level of this range
    
    Parameters:
    
    syncLevel -
  - getLock
```
ReadWriteLock getLock()
```
  - getBook
```
Book getBook()
```
    Gets the book of this range
    
    Returns:
    
    book
  - getSheet
```
Sheet getSheet()
```
    Gets the sheet of this range
    
    Returns:
    
    sheet
  - getColumn
```
int getColumn()
```
    Gets the left column of this range
    
    Returns:
    
    the left column
  - getRow
```
int getRow()
```
    Gets the top row of this range
    
    Returns:
    
    the top row
  - getLastColumn
```
int getLastColumn()
```
    Gets the right/last column of this range
    
    Returns:
  - getLastRow
```
int getLastRow()
```
    Gets the bottom/last row of this range
    
    Returns:
  - getRowCount
```
int getRowCount()
```
    Gets the row count of this range
    
    Returns:
    
    count of row of this range
  - getColumnCount
```
int getColumnCount()
```
    Gets the column count of this range
    
    Returns:
    
    count of column of this range
  - getCellStyleHelper
```
Range.CellStyleHelper getCellStyleHelper()
```
    Gets cell-style-helper, this helper helps you to create new style, font or color
    
    Returns:
  - sync
```
void sync(RangeRunner run)
```
    Runs runer under synchronization protection
    
    Parameters:
    
    run - the runner
    
    See Also:
    
    setSyncLevel(SyncLevel)
  - visit
```
void visit(CellVisitor visitor)
```
    Visits all cells in this range with synchronization protection, make sure you call this in a limited range, don't use it for all row/column selection, it will spend much time to iterate the cell
    
    Parameters:
    
    visitor - the cell visitor
    
    See Also:
    
    setSyncLevel(SyncLevel)
  - toShiftedRange
```
Range toShiftedRange(int rowOffset,
                     int colOffset)
```
    Return a new range that shift it row and column according to the offset, but has same height and width of original range.
    
    Parameters:
    
    rowOffset - row offset of the new range, zero base
    
    colOffset - column offset of the new range, zero base
    
    Returns:
    
    the new range
  - toCellRange
```
Range toCellRange(int rowOffset,
                  int colOffset)
```
    Returns a new range having on cell according to the offset
    
    Parameters:
    
    rowOffset - row offset of the cell, zero base
    
    colOffset - column offset of the cell, zero base
    
    Returns:
    
    the new range of the cell
  - toRowRange
```
Range toRowRange()
```
    Return a range that represents all columns and between the first-row and last-row of this range. It is a useful when you want to manipulate entire row (such as delete row)
  - toColumnRange
```
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 delete column)
  - isWholeColumn
```
boolean isWholeColumn()
```
    Check if this range represents a whole column, which mean all rows are included,
  - isWholeRow
```
boolean isWholeRow()
```
    Check if this range represents a whole row, which mean all column are included,
  - isWholeSheet
```
boolean isWholeSheet()
```
    Check if this range represents a whole sheet, which mean all column and row are included,
  - clearContents
```
void clearContents()
```
    Clears contents
  - clearStyles
```
void clearStyles()
```
    Clears styles
  - clearAll
```
void clearAll()
```
    Clears contents, styles and unmerge this range.
  - paste
```
Range paste(Range dest)
```
    Pastes to destination
    
    Parameters:
    
    dest - the destination
    
    Returns:
    
    a Range contains the final pasted range. paste to a protected sheet will always cause paste return null.
  - paste
```
Range paste(Range dstRange,
            boolean cut)
```
    Cut and paste to destination
  - pasteSpecial
```
Range pasteSpecial(Range dest,
                   Range.PasteType type,
                   Range.PasteOperation op,
                   boolean skipBlanks,
                   boolean transpose)
```
    Pastes to destination
    
    Parameters:
    
    dest - the destination
    
    type - the paste type
    
    op - the paste operation
    
    skipBlanks - skip blanks or not
    
    transpose - transpose the cell or not
    
    Returns:
    
    a Range contains the final pasted range. paste to a protected sheet will always cause paste return null.
    
    Throws:
    
    IllegalOpArgumentException
  - applyBorders
```
void applyBorders(Range.ApplyBorderType applyType,
                  CellStyle.BorderType borderType,
                  String htmlColor)
```
    apply borders
    
    Parameters:
    
    applyType - the apply type
    
    borderType - the border type
    
    htmlColor - the color (#rgb-hex-code, e.x #FF00FF)
  - hasMergedCell
```
boolean hasMergedCell()
```
    Returns:
    
    true if any merged cell inside (fully contains or overlaps) this range
  - isMergedCell
```
boolean isMergedCell()
```
    Returns:
    
    true if entire range is a merged cell.
  - merge
```
void merge(boolean across)
```
    Merges the range
    
    Parameters:
    
    across - true if merge horizontally only
  - unmerge
```
void unmerge()
```
    Unmerge the range
  - insert
```
void insert(Range.InsertShift shift,
            Range.InsertCopyOrigin copyOrigin)
```
    Insert new cells to the area of this range.
    To insert a row, you have to call toRowRange() first, to insert a column, you have to call toColumnRange() first.
    
    Parameters:
    
    shift - the shift direction of original cells
    
    copyOrigin - copy the format from nearby cells when inserting new cells
  - delete
```
void delete(Range.DeleteShift shift)
```
    Delete cells of the range.
    To delete a row, you have to call toRowRange() first, to delete a column, you have to call toColumnRange() first.
    
    Parameters:
    
    shift - the shift direction when deleting.
  - sort
```
void sort(boolean desc)
```
    Sort range
    
    Parameters:
    
    desc - true for descent, false for ascent
  - sort
```
void sort(boolean desc,
          boolean header,
          boolean matchCase,
          boolean sortByRows,
          Range.SortDataOption dataOption)
```
    Sort range
    
    Parameters:
    
    desc - true for descent, false for ascent
    
    header - includes header or not
    
    matchCase - matches character chase of not
    
    sortByRows - sorts by row or not
    
    dataOption - data option for sort
  - sort
```
void 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
    
    Parameters:
    
    index1 - the sort index 1
    
    desc1 - true for descent, false for ascent of index 1
    
    header - includes header or not
    
    matchCase - matches character chase of not
    
    sortByRows - sorts by row or not
    
    dataOption1 - data option 1 for sort
    
    index2 - the sort index 2
    
    desc2 - true for descent, false for ascent of index 2
    
    dataOption2 - data option 2 for sort
    
    index3 - the sort index 3
    
    desc3 - true for descent, false for ascent of index 3
    
    dataOption3 - data option31 for sort
  - autoFill
```
void autoFill(Range dest,
              Range.AutoFillType fillType)
```
    According to current range, fills data to destination range automatically
    
    Parameters:
    
    dest - the destination range
    
    fillType - the fill type
  - fillDown
```
void fillDown()
```
    Fills cells by copying from first/top row data
  - fillLeft
```
void fillLeft()
```
    Fills cells by copying from last/right column data
  - fillUp
```
void fillUp()
```
    Fills cells by copying from bottom row data
  - fillRight
```
void fillRight()
```
    Fills cells by copying from first/left column data
  - shift
```
void shift(int rowOffset,
           int colOffset)
```
    Shifts/moves cells with a offset row and column
  - setColumnWidth
```
void setColumnWidth(int widthPx)
```
    Sets the width(in pixel) of column in this range, it effect to whole column.
    
    Parameters:
    
    widthPx - width in pixel
    
    See Also:
    
    toColumnRange()
  - setRowHeight
```
void setRowHeight(int heightPx)
```
    Sets the height(in pixel) of row in this range, it effect to whole row.
    
    Parameters:
    
    heightPx - height in pixel
    
    See Also:
    
    toRowRange()
  - setRowHeight
```
void setRowHeight(int heightPx,
                  boolean isCustom)
```
    Sets the height(in pixel) of row in this range and specify it's custom size or not.
    
    Parameters:
    
    heightPx - height in pixel
    
    isCustom - true if it's set by users manually, false if it's determined by the system automatically
  - setCellStyle
```
void setCellStyle(CellStyle nstyle)
```
    Sets cell style, applies it to all cells of this range
    
    Parameters:
    
    nstyle - new cell style
    
    See Also:
    
    getCellStyleHelper(), getCellStyle()
  - setCellEditText
```
void setCellEditText(String editText)
```
    Sets cell editText, applies it to all cells of this range
    
    Parameters:
    
    editText - the eidtText, it could be a string, integer string, date string or a formula (start with '=')
    
    Throws:
    
    IllegalFormulaException
  - setCellValue
```
void setCellValue(Object value)
```
    Sets cell data value, applies it to all cells
    
    Parameters:
    
    value - the cell value, could be null, String, Number, Date or Boolean
  - setCellHyperlink
```
void setCellHyperlink(Hyperlink.HyperlinkType type,
                      String address,
                      String label)
```
    Sets cell hyperlink, applies it too all cells
    
    Parameters:
    
    type - the hyperlink type
    
    address - the address, e.x http://www.zkoss.org
    
    label - the label to display
  - getCellHyperlink
```
Hyperlink getCellHyperlink()
```
    Gets the first cell(top-left) Hyperlink object of this range.
    
    Returns:
  - getCellStyle
```
CellStyle getCellStyle()
```
    Gets the first cell(top-left) style of this range
    
    Returns:
    
    cell-style of this cell, if this cell doesn't has cell-style, it will check row/column's cell-style and then sheet's default cell-style
  - getCellData
```
CellData getCellData()
```
    Gets the first cell(top-left) data of this range
    
    Returns:
  - getCellEditText
```
String getCellEditText()
```
    Gets the first cell(top-left) edit text of this range
    
    Returns:
    
    edit text
    
    See Also:
    
    CellData.getEditText()
  - getCellFormatText
```
String getCellFormatText()
```
    Gets the first cell(top-left) formatted text of this range
    
    Returns:
    
    format text
    
    See Also:
    
    CellData.getFormatText()
  - getCellDataFormat
```
String getCellDataFormat()
```
    Gets the first cell(top-left) format of this range
    
    Returns:
    
    Since:
    
    3.5.0
  - getCellValue
```
Object getCellValue()
```
    Gets the first cell(top-left) value of this this range
    
    Returns:
    
    value object
    
    See Also:
    
    CellData.getValue()
  - protectSheet
```
void protectSheet(String password)
```
    Deprecated. use protectSheet(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) instead Enable sheet protection and apply a password, or null to disable protection
  - setDisplaySheetGridlines
```
void setDisplaySheetGridlines(boolean enable)
```
    Displays sheet grid-lines or not
    
    Parameters:
    
    enable - true to display
  - isDisplaySheetGridlines
```
boolean isDisplaySheetGridlines()
```
    Returns:
    
    true if display sheet grid-lines is enabled
  - setHidden
```
void setHidden(boolean hidden)
```
    Hide or unhide rows or columns.
    To hide/unhide a row, you have to call toRowRange() first, to hide/un-hide a column, you have to call toColumnRange() or a whole column range.
    
    Parameters:
    
    hidden - hide or not
  - setSheetName
```
void setSheetName(String name)
```
    Sets the sheet name
    
    Parameters:
    
    name - new sheet name, it must be not same as another sheet name in it's owner book.
  - getSheetName
```
String getSheetName()
```
    Gets the sheet name
    
    Returns:
    
    sheet name
  - setSheetOrder
```
void setSheetOrder(int pos)
```
    Sets the sheet order
    
    Parameters:
    
    pos - the position
  - getSheetOrder
```
int getSheetOrder()
```
    Gets the sheet order
    
    Returns:
  - isProtected
```
boolean isProtected()
```
    Returns:
    
    true if the specified range is protected; i.e. sheet is protected and some cells in the range are locked
  - isAutoFilterEnabled
```
boolean isAutoFilterEnabled()
```
    Returns:
    
    true if auto filter is enabled.
  - findAutoFilterRange
```
Range findAutoFilterRange()
```
    To find a range of cells for applying auto filter according to this range. Usually, these two ranges are different. This method searches the filtering range through a specific rules.
    
    Returns:
    
    a range of cells for applying auto filter or null if can't find one from this Range.
  - enableAutoFilter
```
void enableAutoFilter(boolean enable)
```
    Enable/disable autofilter of the sheet
    
    Parameters:
    
    enable - true to enable
  - enableAutoFilter
```
void enableAutoFilter(int field,
                      Range.AutoFilterOperation filterOp,
                      Object criteria1,
                      Object criteria2,
                      Boolean showButton)
```
    Enables autofilter and set extra condition
    
    Parameters:
    
    field - the filed index (according to current range, 1 base)
    
    filterOp - auto filter operation
    
    criteria1 - criteria for autofilter
    
    criteria2 - criteria for autofilter
    
    showButton - true/false for show/hide dropdown button, null will keep the original setting.
  - resetAutoFilter
```
void resetAutoFilter()
```
    Clears condition of filter, show all the data
  - applyAutoFilter
```
void applyAutoFilter()
```
    Re-applies the filter, filter by last condition and data again. Call this if the data was change and you want to re-new the filter result.
  - addPicture
```
Picture addPicture(SheetAnchor anchor,
                   byte[] image,
                   Picture.Format format)
```
    Adds picture to sheet
    
    Parameters:
    
    anchor - the anchor for picture
    
    image - the image binary array
    
    format - the image format
    
    Returns:
    
    the new added picture
  - deletePicture
```
void deletePicture(Picture picture)
```
    Deletes picture that in sheet
    
    Parameters:
    
    picture -
  - movePicture
```
void movePicture(SheetAnchor anchor,
                 Picture picture)
```
    Moves picture
    
    Parameters:
    
    anchor - the anchor to re-allocate
    
    picture - the picture to re-allocate
  - addChart
```
Chart addChart(SheetAnchor anchor,
               Chart.Type type,
               Chart.Grouping grouping,
               Chart.LegendPosition pos)
```
    Adds chart to sheet
    
    Parameters:
    
    anchor - the destination anchor of the chart
    
    type - the chart type
    
    grouping - the chart grouping
    
    pos - the legend position
    
    Returns:
    
    the new added chart
  - deleteChart
```
void deleteChart(Chart chart)
```
    Deletes chart
    
    Parameters:
    
    chart - the chart to delete
  - moveChart
```
void moveChart(SheetAnchor anchor,
               Chart chart)
```
    Moves chart to new location
    
    Parameters:
    
    anchor - the new location to move
    
    chart - the chart to move
  - createSheet
```
Sheet createSheet(String name)
```
    Creates a new sheet
    
    Parameters:
    
    name - the sheet name, it must not be same as another sheet name in book of this range
    
    Returns:
    
    the new created sheet
  - cloneSheet
```
Sheet cloneSheet(String name)
```
    Clone this sheet; create a sheet and copy the contents of this sheet; then add to the end of the book.
    
    Parameters:
    
    name - the sheet name, it must not be the same as another sheet name in book of this range
    
    Returns:
    
    the new created sheet
    
    Since:
    
    3.6.0
  - setFreezePanel
```
void setFreezePanel(int rowfreeze,
                    int columnfreeze)
```
    Set the freeze panel
    
    Parameters:
    
    rowfreeze - the number of row to freeze, 0 means no freeze
    
    columnfreeze - the number of column to freeze, 0 means no freeze
  - deleteSheet
```
void deleteSheet()
```
    Deletes sheet. Note: You couldn't delete last sheet of a book.
  - notifyChange
```
void notifyChange()
```
    Notify this range has been changed.
  - notifyChange
```
void notifyChange(String[] variables)
```
    Notify the whole book of specified variables change. Then spreadsheet will re-evaluate those cells that reference to these variables.
    
    Parameters:
    
    variables - changed variables
  - asString
```
String asString()
```
    get formatted string of this range
    
    Returns:
  - updateChart
```
void updateChart(Chart chart)
```
    Notify the component that a chart has change, e.g. call it after chart data changes.
    
    Parameters:
    
    chart - the chart that contains change
    
    Since:
    
    3.5.0
  - getInternalRange
```
SRange getInternalRange()
```
    Get internal range implementation
    
    Since:
    
    3.5.0
  - createName
```
void createName(String nameName)
```
    Create a Name that refer to this range.
    
    Parameters:
    
    nameName - name of the Name that you can refer in formulas.
    
    Since:
    
    3.5.0
  - isSheetProtected
```
boolean isSheetProtected()
```
    Returns:
    
    true if the sheet is protected
    
    Since:
    
    3.5.0
  - protectSheet
```
void protectSheet(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)
```
    Protect a Sheet so that it cannot be modified. You can call this method on a protected sheet to change its allowed options if the same password is supplied; otherwise, it is ignored. A protected sheet can be unprotected by calling unprotectSheet(String password). change the protection options; make sure provide
    
    Parameters:
    
    password - a case-sensitive password for the sheet; null or empty string means protect the sheet without password.
    
    allowSelectingLockedCells - true to allow select locked cells; default to true.
    
    allowSelectingUnlockedCells - true to allow select unlocked cells; default to true.
    
    allowFormattingCells - true to allow user to format any cell on the protected sheet; default false.
    
    allowFormattingColumns - true to allow user to format any columns on the protected sheet; default false.
    
    allowFormattingRows - true to allow user to format any rows on the protected sheet; default false.
    
    allowInsertColumns - true to allow user to insert columns on the protected sheet; default false.
    
    allowInsertRows - true to allow user to insert rows on the protected sheet; default false.
    
    allowInsertingHyperlinks - true to allow user to insert hyperlinks on the protected sheet; default false.
    
    allowDeletingColumns - true to allow user to delete columns on the protected sheet; default false.
    
    allowDeletingRows - true to allow user to delete rows on the protected sheet; default false.
    
    allowSorting - true to allow user to sort on the protected sheet; default false.
    
    allowFiltering - true to allow user to set filters on the protected sheet; default false.
    
    allowUsingPivotTables - true to allow user to use pivot table reports on the protected sheet; default false.
    
    drawingObjects - true to protect objects; default to false.
    
    scenarios - true to protect scenarios; default to true.
    
    Since:
    
    3.5.0
    
    See Also:
    
    unprotectSheet(String password), isProtected()
  - protectSheet
```
void protectSheet(SheetProtection protection)
```
    Protect a Sheet so that it cannot be modified.
    
    Parameters:
    
    protection -
    
    Since:
    
    5.0.0
    
    See Also:
    
    SheetProtection
  - unprotectSheet
```
boolean unprotectSheet(String password)
```
    Removes protection from a sheet. This method has no effect if the sheet isn't protected.
    
    Parameters:
    
    password - a case-sensitive password used to unprotect the sheet. If the sheet isn't protected with a password, this argument is ignored. If you omit this argument for a sheet that is protected with a password, you'll be prompted for the password.
    
    Since:
    
    3.5.0
  - getSheetProtection
```
SheetProtection getSheetProtection()
```
    Gets SheetProtection which tells what are allowed operations for a protected sheet of this range.
    
    Returns:
    
    Since:
    
    3.5.0
  - validate
```
Validation validate(String editText)
```
    validate the user's input.
    
    Parameters:
    
    editText -
    
    Returns:
    
    the Validation that constraint the input; null if none.
  - setValidation
```
void setValidation(Validation.ValidationType validationType,
                   boolean ignoreBlank,
                   Validation.OperatorType operatorType,
                   boolean inCellDropDown,
                   String formula1,
                   String formula2,
                   boolean showInput,
                   String inputTitle,
                   String inputMessage,
                   boolean showError,
                   Validation.AlertStyle alertStyle,
                   String errorTitle,
                   String errorMessage)
```
    Add if not exist or modify an existing Validation to this range. There are two ways to input list items for data validation in argument "formula1" and "formula2". One is to specify a range via a formula such as "=A1:A4" where the values in the cells of the range is the constrained value list; another is to input literally the constrained value list delimited by comma such as "1, 2, 3, 4". Note that when you input a formula, must lead the formula with an equal sign('=').
    
    Parameters:
    
    validationType - the type of this validation
    
    ignoreBlank - true if blank values are permitted.
    
    operatorType - the operator for this validation
    
    inCellDropDown - true if want to display dropdown list for acceptable values.
    
    formula1 - the value or expression associated with conditional format or data validation.
    
    formula2 - the 2nd part of a conditional format or data validation. Useful only when operatorType is BETWEEN or NOT_BETWEEN.
    
    showInput - true to show the input message.
    
    inputTitle - title for the data-validation input dialog box.
    
    inputMessage - message for the data-validation input dialog box.
    
    showError - true to show the error message.
    
    alertStyle - validation alert style.
    
    errorTitle - title of the data validation error dialog.
    
    errorMessage - data validation error message.
    
    Since:
    
    3.5.0
  - getValidations
```
List<Validation> getValidations()
```
    Gets read only Validation associated with the left-top cell of this range; return null if no associated validation.
    
    Since:
    
    3.5.0
    
    See Also:
    
    setValidation(Validation.ValidationType, boolean, Validation.OperatorType, boolean, String, String, boolean, String, String, boolean, Validation.AlertStyle, String, String)
  - deleteValidation
```
void deleteValidation()
```
    Delete the Validation associated in the specified range.
    
    Since:
    
    3.5.0
  - setCellRichText
```
void setCellRichText(String html)
```
    Set into the left top cell of this Range the specified text in html format.
    
    Parameters:
    
    html -
    
    Since:
    
    3.6.0
  - getCellRichText
```
String getCellRichText()
```
    Returns text in html format; null if not a rich text.
    
    Since:
    
    3.6.0
  - getOrCreateFont
```
Font getOrCreateFont(Font.Boldweight boldweight,
                     Color color,
                     int fontHeight,
                     String fontName,
                     boolean italic,
                     boolean strikeout,
                     Font.TypeOffset typeOffset,
                     Font.Underline underline)
```
    Get font if exists or create font if not exists from the book of this range and return it.
    
    Returns:
    
    font of the specified font metrics
    
    Since:
    
    3.6.0
  - refresh
```
void refresh(boolean includeDependants)
```
    Enforce evaluation(if not cached) and refresh UI of this range and its dependent cells if the includeDependents is true. This method is equal to refresh(boolean includeDependents, boolean false, boolean true).
    
    Since:
    
    3.6.0
  - setAutoRefresh
```
boolean setAutoRefresh(boolean auto)
```
    Turn on(true)/off(false) of auto refresh of this range and return previous on/off status; default is true.
    
    Parameters:
    
    auto - whether refresh automatically
    
    Returns:
    
    previous status
    
    Since:
    
    3.6.0
  - refresh
```
void refresh(boolean includeDependents,
             boolean clearCache,
             boolean enforceEval)
```
    Update data model and refresh UI of this range and its dependent cells if the argument includeDependents is true. Note that when you set parameter clearCache to true, the cached formula result in data model will be cleared first. If you set parameter enforceEval to true, data model associated with this range will be evaluated immediately; otherwise will be evaluated on demand.
    
    Since:
    
    3.7.0
  - setSheetVisible
```
void setSheetVisible(Range.SheetVisible visible)
```
    Setup sheet's visibility; can be VISIBLE, HIDDEN, or VERY_HIDDEN.
    - VISIBLE: the sheet is visible
    - HIDDEN: the sheet is hidden but can be unhidden using UI
    - VERY_HIDDEN: the sheet is hidden but can be unhidden only via this API.
    Parameters:
    
    visible -
    
    Since:
    
    3.7.0
    
    See Also:
    
    Range.SheetVisible
  - getCommentRichText
```
String getCommentRichText()
```
    Return the comment rich edit text of the left top cell of this Range.
    
    Returns:
    
    the rich edit text of this Range.
    
    Since:
    
    3.7.0
  - setCommentRichText
```
void setCommentRichText(String html)
```
    Set comment rich text into the left top cell of this range; null to delete it.
    
    Since:
    
    3.7.0
  - setCommentVisible
```
void setCommentVisible(boolean visible)
```
    Set comment visibility into the left top cell of this range; if no comment at the cell, it simply ignored.
    
    Parameters:
    
    visible -
    
    Since:
    
    3.7.0
  - isCommentVisible
```
boolean isCommentVisible()
```
    Returns whether the comment is always visible at the left top cell of this range; if no comment at the cell, it returns false.
    
    Returns:
    
    Since:
    
    3.7.0
  - notifyChange
```
void notifyChange(Range.CellAttribute cellAttr)
```
    Notify this range has been changed on the specifield attribute.
    
    Since:
    
    3.8.0
  - setNameName
```
void setNameName(String namename,
                 String newname)
```
    Set(Rename) the name of the Name(or Table) as specified in this Range(a Book or a Sheet).
    
    Parameters:
    
    namename - name of the Name(or Table)
    
    newname - new name for the Name(or Table)
    
    Since:
    
    3.8.0
  - setStringValue
```
void setStringValue(String value)
```
    Save the specified value into this range as a String no matter the value is prefixed with '=' or not.
    
    Parameters:
    
    value -
    
    Since:
    
    3.8.0
  - getMergedRegion
```
CellRegion getMergedRegion()
```
    Returns the merged region of the left top cell of this Range if any; otherwise, returns null if not a merged region.
    
    Returns:
    
    the merged region of the left top cell of this Range if any
    
    Since:
    
    3.8.3
  - getDataRegion
```
CellRegion getDataRegion()
```
    Returns the region which contains data(including chart, picture, and fills) in the sheet of this Range; return null if empty sheet.
    
    Returns:
    
    the region which contains data(including chart, picture, and fills) in the sheet of this Range; return null if empty sheet.
    
    Since:
    
    3.8.3
  - cloneSheetFrom
```
Sheet cloneSheetFrom(String name,
                     Sheet sheet)
```
    Clone from the specified source sheet to the owner book of this range. The book can be different between the owner book of this range and of the specified source sheet.
    
    Parameters:
    
    name - the name of the new created sheet; null would try to use the sheet name of the specified source sheet; if the same sheet name already used in the owner book of this range then use default "SheetX" name where X is the next sheet number of the owner book of this range.
    
    sheet - the source sheet to clone from to the owner book of this range.
    
    Returns:
    
    the new created sheet
    
    Since:
    
    3.9.0

Interface Range

Nested Class Summary

Method Summary

Method Detail

setSyncLevel

getLock

getBook

getSheet

getColumn

getRow

getLastColumn

getLastRow

getRowCount

getColumnCount

getCellStyleHelper

sync

visit

toShiftedRange

toCellRange

toRowRange

toColumnRange

isWholeColumn

isWholeRow

isWholeSheet

clearContents

clearStyles

clearAll

paste

paste

pasteSpecial

applyBorders

hasMergedCell

isMergedCell

merge

unmerge

insert

delete

sort

sort

sort

autoFill

fillDown

fillLeft

fillUp

fillRight

shift

setColumnWidth

setRowHeight

setRowHeight

setCellStyle

setCellEditText

setCellValue

setCellHyperlink

getCellHyperlink

getCellStyle

getCellData

getCellEditText

getCellFormatText

getCellDataFormat

getCellValue

protectSheet

setDisplaySheetGridlines

isDisplaySheetGridlines

setHidden

setSheetName

getSheetName

setSheetOrder

getSheetOrder

isProtected

isAutoFilterEnabled

findAutoFilterRange

enableAutoFilter

enableAutoFilter

resetAutoFilter

applyAutoFilter

addPicture

deletePicture

movePicture

addChart

deleteChart