public interface Range
Modifier and Type | Interface and Description |
---|---|
static class |
Range.AutoFilterOperator
AutoFilterOperator attributes, that can be applied.
|
static class |
Range.DeleteShiftDirection
DeleteShiftDirection attributes, that can be applied.
|
static class |
Range.InsertFormatOrigin
InsertFormatOrigin attributes, that can be applied.
|
static class |
Range.InsertShiftDirection
InsertShiftDirection attributes, that can be applied.
|
Modifier and Type | Method and Description |
---|---|
CompletableFuture<Void> |
activate()
Select a cell or cells with this range.
|
CompletableFuture<Void> |
applyAutoFilter(int field,
Object criteria1,
Range.AutoFilterOperator operator,
Object criteria2,
boolean visibleDropDown)
Applies the auto filter to this range.
|
CompletableFuture<Void> |
applyBorders(Borders borders)
Applies the borders for this range.
|
CompletableFuture<Void> |
applyCellStyle(CellStyle cellStyle)
Applies the cell style to remote data server.
|
CompletableFuture<Void> |
applyColumnWidth(double width)
Applies the column width of this range in character unit width.
|
CompletableFuture<Void> |
applyColumnWidthPx(int width)
Applies the column width of this range in pixels.
|
CompletableFuture<Void> |
applyDataValidation(DataValidation dataValidation)
Applies the data dataValidation
|
CompletableFuture<Void> |
applyFill(Fill fill)
Applies the fill to this range.
|
CompletableFuture<Void> |
applyFont(Font font)
Applies the font to this range.
|
CompletableFuture<Void> |
applyHorizontalAlignment(Alignment.Horizontal alignment)
Applies the horizontal alignment for the given range.
|
CompletableFuture<Void> |
applyHyperlink(Hyperlink hyperlink)
Applies the given hyperlink to this range.
|
CompletableFuture<Void> |
applyNumberFormat(String format)
Applies the number format to this range.
|
CompletableFuture<Void> |
applyRowHeight(double height)
Applies the row height of this range in character unit height.
|
CompletableFuture<Void> |
applyRowHeightPx(int height)
Applies the row height of this range in pixels.
|
CompletableFuture<Void> |
applyValue(Object value)
Applies the range value.
|
CompletableFuture<Void> |
applyValues(Object... values)
Applies the range values.
|
CompletableFuture<Void> |
applyVerticalAlignment(Alignment.Vertical alignment)
Applies the vertical alignment.
|
CompletableFuture<Void> |
applyWrapText(boolean wrapText)
Applies to enable or disable the wrap text.
|
CompletableFuture<Void> |
clear()
Clears the formulas/values/formats of this range.
|
CompletableFuture<Void> |
clearAutoFilter()
Clears the auto filter
|
CompletableFuture<Void> |
clearCellStyle()
Clears the cell style.
|
CompletableFuture<Void> |
clearContents()
Clears formula/values of this range
|
CompletableFuture<Void> |
clearDataValidation()
Clears the data validation
|
CompletableFuture<Void> |
clearHyperlinks()
Clears the hyperlink from this range.
|
Borders |
createBorders()
Creates the borders with (
Borders.BorderIndex.EdgeLeft ,
Borders.BorderIndex.EdgeTop , and Borders.BorderIndex.EdgeBottom ,
Borders.BorderIndex.EdgeRight ) |
Borders |
createBorders(Borders.BorderIndex borderIndex)
Creates the borders from the given border index.
|
CellStyle |
createCellStyle()
Creates a cell style object.
|
DataValidation |
createDataValidation()
Creates a data validation
|
Font |
createFont()
Creates a font
|
Hyperlink |
createHyperlink()
Creates a hyperlink.
|
Fill.PatternFill |
createPatternFill()
Creates a pattern fill.
|
CompletableFuture<Void> |
delete(Range.DeleteShiftDirection deleteShiftDirection)
Deletes cells of the range.
|
String |
getA1Notation()
Returns the A1 notation from this range.
|
Range |
getCell(int row,
int column) |
int |
getColumn()
Returns the left column position for this range.
|
Range |
getColumns()
Return the column part of this range.
|
Range |
getColumns(int index)
Returns a Range that is n-th column(0-based) related to the first area of
this range and in the range.
|
int |
getCount()
Returns the count of cells of this range.
|
int |
getLastColumn()
Returns the end column position for this range.
|
int |
getLastRow()
Returns the end row position for this range.
|
int |
getRow()
Returns the top row position for this range.
|
Range |
getRows()
Returns the row port of this range.
|
Range |
getRows(int index)
Returns a Range that is n-th row(0-based) related to the first area of
this range and in the range.
|
Spreadsheet |
getSpreadsheet() |
CompletableFuture<Void> |
insert(Range.InsertShiftDirection insertShiftDirection,
Range.InsertFormatOrigin insertFormatOrigin)
Insert cells to the range
|
CompletableFuture<CellStyle> |
loadCellStyle()
Loads the cell style from the remote data server.
|
CompletableFuture<Double> |
loadColumnWidth()
Returns the column width of this range in character unit width.
|
CompletableFuture<Integer> |
loadColumnWidthPx()
Returns the column width of this range in pixels.
|
CompletableFuture<List<DataValidationValue>> |
loadDataValidations()
Loads the data validations from the remote data server.
|
CompletableFuture<Hyperlink> |
loadHyperlink()
Loads the hyperlink from the remote data server.
|
CompletableFuture<Double> |
loadRowHeight()
Returns the row height of this range in character unit height.
|
CompletableFuture<Integer> |
loadRowHeightPx()
Returns the row height of this range in pixels.
|
CompletableFuture<RangeValue> |
loadValue()
Returns the first range value from this range.
|
CompletableFuture<List<RangeValue>> |
loadValues()
Returns the range values from this range.
|
CompletableFuture<Workbook> |
loadWorkbook()
Returns the remote workbook which holds this range.
|
CompletableFuture<Worksheet> |
loadWorksheet()
Returns the remote worksheet which holds this range.
|
static final int MAX_COL
static final int MAX_ROW
Spreadsheet getSpreadsheet()
CompletableFuture<Workbook> loadWorkbook()
CompletableFuture<Worksheet> loadWorksheet()
CompletableFuture<RangeValue> loadValue()
CompletableFuture<List<RangeValue>> loadValues()
Range getCell(int row, int column)
String getA1Notation()
int getRow()
int getColumn()
int getLastRow()
int getLastColumn()
CompletableFuture<Void> applyValue(Object value)
value
- Number|StringCompletableFuture<Void> applyValues(Object... values)
values
- a list of Number|StringCompletableFuture<Void> applyVerticalAlignment(Alignment.Vertical alignment)
alignment
- either Alignment.Vertical.Top
, Alignment.Vertical.Center
,
Alignment.Vertical.Bottom
, Alignment.Vertical.Justify
, or Alignment.Vertical.Distributed
CompletableFuture<Void> applyHorizontalAlignment(Alignment.Horizontal alignment)
Borders createBorders(Borders.BorderIndex borderIndex)
Borders.BorderIndex.EdgeLeft
,
Borders.BorderIndex.EdgeTop
, and Borders.BorderIndex.EdgeBottom
,
Borders.BorderIndex.EdgeRight
)Borders createBorders()
Borders.BorderIndex.EdgeLeft
,
Borders.BorderIndex.EdgeTop
, and Borders.BorderIndex.EdgeBottom
,
Borders.BorderIndex.EdgeRight
)CompletableFuture<Void> applyBorders(Borders borders)
borders
- CompletableFuture<Void> applyWrapText(boolean wrapText)
wrapText
- CompletableFuture<Void> delete(Range.DeleteShiftDirection deleteShiftDirection)
deleteShiftDirection
- the shift direction when deleting. either Range.DeleteShiftDirection.ShiftUp
or Range.DeleteShiftDirection.ShiftToLeft
CompletableFuture<Void> insert(Range.InsertShiftDirection insertShiftDirection, Range.InsertFormatOrigin insertFormatOrigin)
insertShiftDirection
- the shift direction off original cells. Either
Range.InsertShiftDirection.ShiftDown
or
Range.InsertShiftDirection.ShiftToRight
insertFormatOrigin
- copy the format from nearby cells when inserting new cells. Either
Range.InsertFormatOrigin.LeftOrAbove
or
Range.InsertFormatOrigin.RightOrBelow
CompletableFuture<Void> applyColumnWidth(double width)
width
- CompletableFuture<Double> loadColumnWidth()
CompletableFuture<Void> applyColumnWidthPx(int width)
width
- CompletableFuture<Integer> loadColumnWidthPx()
CompletableFuture<Void> applyRowHeight(double height)
height
- CompletableFuture<Double> loadRowHeight()
CompletableFuture<Void> applyRowHeightPx(int height)
height
- CompletableFuture<Integer> loadRowHeightPx()
CompletableFuture<Void> activate()
CompletableFuture<Void> clearContents()
Range getColumns()
getColumns(int)
Range getColumns(int index)
Range getRows()
getRows(int)
Range getRows(int index)
int getCount()
CompletableFuture<Void> applyAutoFilter(int field, Object criteria1, Range.AutoFilterOperator operator, Object criteria2, boolean visibleDropDown)
field
- The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field onecriteria1
- The criteria (a string; for example, "101"). Use "=" to find blank fields, or use "<>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").operator
- either Range.AutoFilterOperator.And
, Range.AutoFilterOperator.Bottom10Items
,
Range.AutoFilterOperator.Bottom10Percent
, Range.AutoFilterOperator.FilterCellColor
,
Range.AutoFilterOperator.FilterDynamic
, Range.AutoFilterOperator.FilterFontColor
,
Range.AutoFilterOperator.FilterIcon
, Range.AutoFilterOperator.FilterValues
,
Range.AutoFilterOperator.Top10Items
, or Range.AutoFilterOperator.Top10Percent
criteria2
- The second criteria (a string). Used with Criteria1 and Operator to construct compound criteria.visibleDropDown
- True to display the AutoFilter drop-down arrow for the filtered field.
False to hide the AutoFilter drop-down arrow for the filtered field. True by default.CompletableFuture<Void> clearAutoFilter()
CompletableFuture<CellStyle> loadCellStyle()
CellStyle createCellStyle()
CompletableFuture<Void> applyCellStyle(CellStyle cellStyle)
cellStyle
- CompletableFuture<Void> clearCellStyle()
CompletableFuture<Void> applyNumberFormat(String format)
format
- Font createFont()
CompletableFuture<Void> applyFont(Font font)
font
- Fill.PatternFill createPatternFill()
CompletableFuture<Void> applyFill(Fill fill)
fill
- DataValidation createDataValidation()
CompletableFuture<Void> applyDataValidation(DataValidation dataValidation)
dataValidation
- CompletableFuture<Void> clearDataValidation()
CompletableFuture<List<DataValidationValue>> loadDataValidations()
Hyperlink createHyperlink()
CompletableFuture<Void> applyHyperlink(Hyperlink hyperlink)
hyperlink
- CompletableFuture<Void> clearHyperlinks()
CompletableFuture<Hyperlink> loadHyperlink()
CompletableFuture<Void> clear()
Copyright © 2017. All rights reserved.