Skip navigation links
A B C D E G H I M N O R S T V 

A

addCategory(Object) - Method in class com.github.miachm.sods.Chart
Adds a category value to this chart.
addChart(Chart) - Method in class com.github.miachm.sods.Sheet
Adds a chart associated with this sheet.
addCondition(ConditionalFormat) - Method in class com.github.miachm.sods.Style
Add a conditional format subrule in the style.
addData(String) - Method in class com.github.miachm.sods.Chart
Adds a data range address to this chart.
addImage(Range, byte[], String) - Method in class com.github.miachm.sods.Sheet
Adds an image anchored to a range in this sheet.
addImage(SheetImage) - Method in class com.github.miachm.sods.Sheet
Adds a preconfigured image to this sheet.
addLabel(Object) - Method in class com.github.miachm.sods.ChartSeries
Adds a label to the series.
addSeries(ChartSeries) - Method in class com.github.miachm.sods.Chart
Adds a series to this chart.
addSheet(Sheet, int) - Method in class com.github.miachm.sods.SpreadSheet
Add a new sheet in a specific position
addValue(Object) - Method in class com.github.miachm.sods.ChartSeries
Adds a value to the series.
anyBorder() - Method in class com.github.miachm.sods.Borders
Tells if there is any border set on.
appendColumn() - Method in class com.github.miachm.sods.Sheet
Append a column at the end of the Spreadsheet
appendColumns(int) - Method in class com.github.miachm.sods.Sheet
Append many columns at the end of the Spreadsheet.
appendRow() - Method in class com.github.miachm.sods.Sheet
Append a new row at the end of the heet
appendRows(int) - Method in class com.github.miachm.sods.Sheet
Append many rows at the end of the Spreadsheet
appendSheet(Sheet) - Method in class com.github.miachm.sods.SpreadSheet
Append a new sheet at the end of the book

B

Borders - Class in com.github.miachm.sods
This a class which represents the nature of the borders of a cell.
Borders() - Constructor for class com.github.miachm.sods.Borders
 
Borders(boolean) - Constructor for class com.github.miachm.sods.Borders
Constructor with all borders the same, and default properties: 0.035cm solid #000000
Borders(boolean, String) - Constructor for class com.github.miachm.sods.Borders
Constructor with all borders the same, specifying its properties.
Borders(boolean, boolean, boolean, boolean) - Constructor for class com.github.miachm.sods.Borders
Constructor specifying which borders to activate, with default properties: 0.035cm solid #000000.
Borders(boolean, String, boolean, String, boolean, String, boolean, String) - Constructor for class com.github.miachm.sods.Borders
Constructor specifying which borders to activate, specifying their properties.
build() - Method in class com.github.miachm.sods.OfficeAnnotationBuilder
 

C

Chart - Class in com.github.miachm.sods
Represents a chart embedded in a Sheet.
Chart() - Constructor for class com.github.miachm.sods.Chart
 
ChartAxis - Class in com.github.miachm.sods
Represents a chart axis configuration.
ChartAxis() - Constructor for class com.github.miachm.sods.ChartAxis
 
ChartGraphicProperties - Class in com.github.miachm.sods
Holds graphic properties for chart elements.
ChartGraphicProperties() - Constructor for class com.github.miachm.sods.ChartGraphicProperties
 
ChartProperties - Class in com.github.miachm.sods
Holds chart-specific properties.
ChartProperties() - Constructor for class com.github.miachm.sods.ChartProperties
 
ChartProperties.TreatEmptyCells - Enum in com.github.miachm.sods
How empty cells are treated in chart data.
ChartSeries - Class in com.github.miachm.sods
Represents a series within a Chart.
ChartSeries() - Constructor for class com.github.miachm.sods.ChartSeries
 
ChartStyle - Class in com.github.miachm.sods
Groups chart style properties (chart, graphic, and text).
ChartStyle() - Constructor for class com.github.miachm.sods.ChartStyle
 
ChartTextProperties - Class in com.github.miachm.sods
Holds text properties for chart labels and titles.
ChartTextProperties() - Constructor for class com.github.miachm.sods.ChartTextProperties
 
clear() - Method in class com.github.miachm.sods.Range
Clear all the content/styles of the cells in this range
clear() - Method in class com.github.miachm.sods.Sheet
Clear all the content of the sheet.
clear() - Method in class com.github.miachm.sods.SpreadSheet
Remove all sheets of the book.
clone() - Method in class com.github.miachm.sods.Borders
 
clone() - Method in class com.github.miachm.sods.Color
 
clone() - Method in class com.github.miachm.sods.ConditionalFormat
 
clone() - Method in class com.github.miachm.sods.Sheet
 
clone() - Method in class com.github.miachm.sods.SpreadSheet
 
clone() - Method in class com.github.miachm.sods.Style
 
Color - Class in com.github.miachm.sods
Color is a inmutable class for represent colors.
Color(int, int, int) - Constructor for class com.github.miachm.sods.Color
It creates a color object from a RGB format (red, green, blue).
Color(String) - Constructor for class com.github.miachm.sods.Color
It creates a color object from a String representation (CSS Style).
columnIsHidden(int) - Method in class com.github.miachm.sods.Sheet
Determinies if a specific column is hidden or not
com.github.miachm.sods - package com.github.miachm.sods
Package of the library.
compareTo(Sheet) - Method in class com.github.miachm.sods.Sheet
compareTo method, this comparator only compare the names Note: this class has a natural ordering that is inconsistent with equals.
ConditionalFormat - Class in com.github.miachm.sods
This class refers to a specific rule to apply a conditional style.
conditionWhenCellIsEmpty(Style) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "cell is empty".
conditionWhenCellIsNotEmpty(Style) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "cell is not empty".
conditionWhenTextContains(Style, String) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "text contains X".
conditionWhenTextDoesNotContain(Style, String) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "text does not contain X".
conditionWhenTextEndsWith(Style, String) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "text ends with X".
conditionWhenTextStartsWith(Style, String) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "text starts with X".
conditionWhenValueIsBetween(Style, double, double) - Static method in class com.github.miachm.sods.ConditionalFormat
 
conditionWhenValueIsEqual(Style, double) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "values equals to X".
conditionWhenValueIsEqual(Style, String) - Static method in class com.github.miachm.sods.ConditionalFormat
 
conditionWhenValueIsGreater(Style, double) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "values greater than X".
conditionWhenValueIsGreaterOrEqual(Style, double) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "values greater than or equal to X".
conditionWhenValueIsLower(Style, double) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "values lower than X".
conditionWhenValueIsLowerOrEqual(Style, double) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "values lower than or equal to X".
conditionWhenValueIsNotEqual(Style, double) - Static method in class com.github.miachm.sods.ConditionalFormat
Create a ConditionalFormat rule where the boolean condition is "values not equal to X".
conditionWhenValueIsNotEqual(Style, String) - Static method in class com.github.miachm.sods.ConditionalFormat
 
copyTo(Range) - Method in class com.github.miachm.sods.Range
Copy the content of this range to another, this include values and formatting

D

deleteColumn(int) - Method in class com.github.miachm.sods.Sheet
Delete a specific column on the sheet
deleteColumns(int, int) - Method in class com.github.miachm.sods.Sheet
Delete a number of columns starting in a specific index
deleteRow(int) - Method in class com.github.miachm.sods.Sheet
Delete a specific row in the sheet
deleteRows(int, int) - Method in class com.github.miachm.sods.Sheet
Delete a number of rows starting in a specific index
deleteSheet(int) - Method in class com.github.miachm.sods.SpreadSheet
Remove a specific sheet from the book
deleteSheet(String) - Method in class com.github.miachm.sods.SpreadSheet
Remove a specific sheet from the book specified by the name.
deleteSheet(Sheet) - Method in class com.github.miachm.sods.SpreadSheet
Remove the specified sheet of the book.

E

equals(Object) - Method in class com.github.miachm.sods.Borders
 
equals(Object) - Method in class com.github.miachm.sods.Color
 
equals(Object) - Method in class com.github.miachm.sods.ConditionalFormat
 
equals(Object) - Method in class com.github.miachm.sods.OfficeAnnotation
 
equals(Object) - Method in class com.github.miachm.sods.OfficeCurrency
 
equals(Object) - Method in class com.github.miachm.sods.OfficePercentage
 
equals(Object) - Method in class com.github.miachm.sods.Sheet
Equals method, two sheets are considered the same if have the same name and the same content (include formatting)
equals(Object) - Method in class com.github.miachm.sods.SpreadSheet
Compare two spreadsheets.
equals(Object) - Method in class com.github.miachm.sods.Style
 

G

GenerateOdsException - Exception in com.github.miachm.sods
An unexpected error occurred when generate the ODS file
getAnchorColumn() - Method in class com.github.miachm.sods.SheetImage
Returns the anchor column index.
getAnchorRow() - Method in class com.github.miachm.sods.SheetImage
Returns the anchor row index.
getAnnotation() - Method in class com.github.miachm.sods.Range
Returns the annotation/comment of the first Cell in this range.
getAnnotations() - Method in class com.github.miachm.sods.Range
Returns the rectangular grid of the annotations for this range.
getAutoPosition() - Method in class com.github.miachm.sods.ChartProperties
Returns whether auto-positioning is enabled.
getAutoSize() - Method in class com.github.miachm.sods.ChartProperties
Returns whether auto-sizing is enabled.
getAxisPosition() - Method in class com.github.miachm.sods.ChartProperties
Returns the axis position index.
getBackgroundColor() - Method in class com.github.miachm.sods.Style
Returns the cell background color.
getBlue() - Method in class com.github.miachm.sods.Color
 
getBorderBottomProperties() - Method in class com.github.miachm.sods.Borders
Gets bottom border properties.
getBorderLeftProperties() - Method in class com.github.miachm.sods.Borders
Gets left border properties.
getBorderProperties() - Method in class com.github.miachm.sods.Borders
Gets global border properties.
getBorderRightProperties() - Method in class com.github.miachm.sods.Borders
Gets right border properties.
getBorders() - Method in class com.github.miachm.sods.Style
Returns the borders properties.
getBorderTopProperties() - Method in class com.github.miachm.sods.Borders
Gets top border properties.
getCategories() - Method in class com.github.miachm.sods.Chart
Returns the category values used by the chart.
getCategoriesRangeAddress() - Method in class com.github.miachm.sods.Chart
Returns the A1 range address for the categories.
getCategoriesRangeObject() - Method in class com.github.miachm.sods.Chart
Resolves the categories range address into a Range.
getCell(int, int) - Method in class com.github.miachm.sods.Range
Get a specific cell of this Range using relative coords for example, (0,0) would be the first cell of this range
getChartProperties() - Method in class com.github.miachm.sods.ChartStyle
Returns the chart properties.
getCharts() - Method in class com.github.miachm.sods.Sheet
Return all the charts associated with this sheet.
getColor() - Method in class com.github.miachm.sods.ChartTextProperties
Returns the text color.
getColumn() - Method in class com.github.miachm.sods.Range
Get the starting column index of this range.
getColumnWidth(int) - Method in class com.github.miachm.sods.Sheet
Get the width of a column.
getConditions() - Method in class com.github.miachm.sods.Style
Get a list of all conditional format rules Conditional format rules are specific properties which are applied if the cell fullfills a specific condition
getCssStyles() - Method in class com.github.miachm.sods.Borders
Returns a Map representing this class as css-styles.
getCssStyles() - Method in class com.github.miachm.sods.Style
Returns a Map representing this class as css-styles.
getCurrency() - Method in class com.github.miachm.sods.OfficeCurrency
 
getData() - Method in class com.github.miachm.sods.Chart
Returns the data ranges used by the chart.
getData() - Method in class com.github.miachm.sods.SheetImage
Returns a copy of the image bytes.
getDataRange() - Method in class com.github.miachm.sods.Sheet
Get a @Range which contains the whole Sheet content.
getDataStyle() - Method in class com.github.miachm.sods.Style
Returns the data style.
getDefaultColumnCellStyle(int) - Method in class com.github.miachm.sods.Sheet
Gets the default cell style of a specific column.
getDisplayLabel() - Method in class com.github.miachm.sods.ChartProperties
Returns whether labels are displayed.
getEdgeRounding() - Method in class com.github.miachm.sods.ChartGraphicProperties
Returns the edge rounding value.
getFill() - Method in class com.github.miachm.sods.ChartGraphicProperties
Returns the fill style.
getFillColor() - Method in class com.github.miachm.sods.ChartGraphicProperties
Returns the fill color.
getFontColor() - Method in class com.github.miachm.sods.Style
Returns the font color.
getFontFamily() - Method in class com.github.miachm.sods.ChartTextProperties
Returns the font family.
getFontSize() - Method in class com.github.miachm.sods.Style
Returns the font size
getFontSizeAsianPt() - Method in class com.github.miachm.sods.ChartTextProperties
Returns the Asian font size in points.
getFontSizeComplexPt() - Method in class com.github.miachm.sods.ChartTextProperties
Returns the complex font size in points.
getFontSizePt() - Method in class com.github.miachm.sods.ChartTextProperties
Returns the font size in points.
getFontStyle() - Method in class com.github.miachm.sods.ChartTextProperties
Returns the font style.
getFontWeight() - Method in class com.github.miachm.sods.ChartTextProperties
Returns the font weight.
getFooter() - Method in class com.github.miachm.sods.Chart
Returns the chart footer text.
getFormula() - Method in class com.github.miachm.sods.Range
Get the formula String of the first cell of the range
getFormulas() - Method in class com.github.miachm.sods.Range
Returns the formulas (A1 notation) for the cells in the range.
getGraphicProperties() - Method in class com.github.miachm.sods.ChartStyle
Returns the graphic properties.
getGreen() - Method in class com.github.miachm.sods.Color
 
getHeight() - Method in class com.github.miachm.sods.Chart
Returns the chart height.
getHeight() - Method in class com.github.miachm.sods.SheetImage
Returns the image height.
getImages() - Method in class com.github.miachm.sods.Sheet
Return all the images associated with this sheet.
getIncludeHiddenCells() - Method in class com.github.miachm.sods.ChartProperties
Returns whether hidden cells are included.
getLabelRangeAddress() - Method in class com.github.miachm.sods.ChartSeries
Returns the A1 range address for labels.
getLabels() - Method in class com.github.miachm.sods.ChartSeries
Returns the series labels.
getLastColumn() - Method in class com.github.miachm.sods.Range
Returns the end column position.
getLastColumn() - Method in class com.github.miachm.sods.Sheet
Deprecated.
Use getMaxColumn() instead Return the last column of the sheet which contains useful data
getLastModified() - Method in class com.github.miachm.sods.OfficeAnnotation
Get the date of the comment (last modification date)
getLastModified() - Method in class com.github.miachm.sods.OfficeAnnotationBuilder
 
getLastRow() - Method in class com.github.miachm.sods.Range
Returns the end row position.
getLastRow() - Method in class com.github.miachm.sods.Sheet
Deprecated.
Use getMaxRow() instead Return the last row of the sheet which contains useful data
getLegend() - Method in class com.github.miachm.sods.Chart
Returns the legend configuration string.
getLinkDataStyleToSource() - Method in class com.github.miachm.sods.ChartProperties
Returns whether data style is linked to the source.
getLogarithmic() - Method in class com.github.miachm.sods.ChartProperties
Returns whether logarithmic scaling is enabled.
getLogger() - Method in class com.github.miachm.sods.OdsOptionParameters
 
getMaxColumns() - Method in class com.github.miachm.sods.Sheet
The number of columns created in this sheet
getMaxRows() - Method in class com.github.miachm.sods.Sheet
The number of rows created in this sheet
getMergedCells() - Method in class com.github.miachm.sods.Range
Returns an array of Range objects representing merged cells that either are fully within the current range, or contain at least one cell in the current range.
getMessage() - Method in exception com.github.miachm.sods.GenerateOdsException
 
getMessage() - Method in exception com.github.miachm.sods.NotAnOdsException
 
getMessage() - Method in exception com.github.miachm.sods.OperationNotSupportedException
 
getMessage() - Method in exception com.github.miachm.sods.SodsException
 
getMimeType() - Method in class com.github.miachm.sods.SheetImage
Returns the image MIME type.
getMsg() - Method in class com.github.miachm.sods.OfficeAnnotation
Returns the msg contained in the comment
getMsg() - Method in class com.github.miachm.sods.OfficeAnnotationBuilder
 
getName() - Method in class com.github.miachm.sods.Sheet
Obtains the name of this sheet
getName() - Method in class com.github.miachm.sods.SheetImage
Returns the image name.
getNumColumns() - Method in class com.github.miachm.sods.Range
Number of columns which contains this range
getNumRows() - Method in class com.github.miachm.sods.Range
Number of rows which contains this range
getNumSheets() - Method in class com.github.miachm.sods.SpreadSheet
Return the number of sheets in the book
getNumValues() - Method in class com.github.miachm.sods.Range
Return the number of cells which contains this range
getPath() - Method in class com.github.miachm.sods.SheetImage
Returns the internal path for this image.
getPlotAreaStyle() - Method in class com.github.miachm.sods.Chart
Returns the plot area style.
getRange(int, int) - Method in class com.github.miachm.sods.Sheet
Obtains a @Range which contains a specific cell of the sheet
getRange(int, int, int) - Method in class com.github.miachm.sods.Sheet
Obtains a @Range which represents a number of rows starting in a specific Cell.
getRange(int, int, int, int) - Method in class com.github.miachm.sods.Sheet
Obtains a @Range which represents a subset of the Sheet.
getRange(String) - Method in class com.github.miachm.sods.Sheet
Obtains a @Range using the A1 Notation format.
getRed() - Method in class com.github.miachm.sods.Color
 
getReverseDirection() - Method in class com.github.miachm.sods.ChartProperties
Returns whether the axis direction is reversed.
getRightAngledAxes() - Method in class com.github.miachm.sods.ChartProperties
Returns whether right-angled axes are enabled.
getRow() - Method in class com.github.miachm.sods.Range
Get the starting row index of this range.
getRowHeight(int) - Method in class com.github.miachm.sods.Sheet
Get the height of a row.
getSeries() - Method in class com.github.miachm.sods.Chart
Returns the series list associated with this chart.
getSheet() - Method in class com.github.miachm.sods.Chart
Returns the sheet that owns this chart.
getSheet() - Method in class com.github.miachm.sods.Range
Returns the sheet where this range is contained
getSheet(String) - Method in class com.github.miachm.sods.SpreadSheet
Return a sheet with a given name.
getSheet(int) - Method in class com.github.miachm.sods.SpreadSheet
Return a sheet with a given index.
getSheetNumbers() - Method in class com.github.miachm.sods.OdsOptionParameters
Gets the list of sheet numbers to load.
getSheets() - Method in class com.github.miachm.sods.SpreadSheet
Return all the sheets of the book in a list.
getStroke() - Method in class com.github.miachm.sods.ChartGraphicProperties
Returns the stroke style.
getStrokeColor() - Method in class com.github.miachm.sods.ChartGraphicProperties
Returns the stroke color.
getStrokeWidth() - Method in class com.github.miachm.sods.ChartGraphicProperties
Returns the stroke width.
getStyle() - Method in class com.github.miachm.sods.Chart
Returns the chart style.
getStyle() - Method in class com.github.miachm.sods.ChartAxis
Returns the axis style.
getStyle() - Method in class com.github.miachm.sods.ChartSeries
Returns the series style.
getStyle() - Method in class com.github.miachm.sods.Range
Returns the formating style of the top-left cell in the range.
getStyleApplied() - Method in class com.github.miachm.sods.ConditionalFormat
 
getStyles() - Method in class com.github.miachm.sods.Range
Returns the rectangular grid of formating styles for this range.
getSymbolHeight() - Method in class com.github.miachm.sods.ChartProperties
Returns the symbol height.
getSymbolName() - Method in class com.github.miachm.sods.ChartProperties
Returns the symbol name.
getSymbolType() - Method in class com.github.miachm.sods.ChartProperties
Returns the symbol type.
getSymbolWidth() - Method in class com.github.miachm.sods.ChartProperties
Returns the symbol width.
getTextAligment() - Method in class com.github.miachm.sods.Style
Get text aligment of the cell
getTextLineBreak() - Method in class com.github.miachm.sods.ChartProperties
Returns whether text line breaks are enabled.
getTextProperties() - Method in class com.github.miachm.sods.ChartStyle
Returns the text properties.
getTitle() - Method in class com.github.miachm.sods.Chart
Returns the chart title.
getTreatEmptyCells() - Method in class com.github.miachm.sods.ChartProperties
Returns the empty-cell behavior.
getTryStaggeringFirst() - Method in class com.github.miachm.sods.ChartProperties
Returns whether to try staggering labels first.
getType() - Method in class com.github.miachm.sods.Chart
Returns the chart type identifier.
getValue() - Method in class com.github.miachm.sods.OfficeCurrency
 
getValue() - Method in class com.github.miachm.sods.OfficePercentage
 
getValue() - Method in class com.github.miachm.sods.Range
Returns the value of the top-left cell in the range.
getValues() - Method in class com.github.miachm.sods.ChartSeries
Returns the series values.
getValues() - Method in class com.github.miachm.sods.Range
Returns the rectangular grid of values for this range.
getValuesRangeAddress() - Method in class com.github.miachm.sods.ChartSeries
Returns the A1 range address for values.
getValuesRangeObject() - Method in class com.github.miachm.sods.ChartSeries
Resolves the values range address into a Range.
getVerticalTextAligment() - Method in class com.github.miachm.sods.Style
Get the vertical text aligment of the cell
getWallStyle() - Method in class com.github.miachm.sods.Chart
Returns the wall style.
getWidth() - Method in class com.github.miachm.sods.Chart
Returns the chart width.
getWidth() - Method in class com.github.miachm.sods.SheetImage
Returns the image width.
getX() - Method in class com.github.miachm.sods.Chart
Returns the X position.
getX() - Method in class com.github.miachm.sods.SheetImage
Returns the X position.
getXAxis() - Method in class com.github.miachm.sods.Chart
Returns the X axis configuration.
getXAxisLabel() - Method in class com.github.miachm.sods.Chart
Returns the label for the X axis.
getY() - Method in class com.github.miachm.sods.Chart
Returns the Y position.
getY() - Method in class com.github.miachm.sods.SheetImage
Returns the Y position.
getYAxis() - Method in class com.github.miachm.sods.Chart
Returns the Y axis configuration.
getYAxisLabel() - Method in class com.github.miachm.sods.Chart
Returns the label for the Y axis.

H

hasBorders() - Method in class com.github.miachm.sods.Style
Tells if the style has any border.
hashCode() - Method in class com.github.miachm.sods.Borders
 
hashCode() - Method in class com.github.miachm.sods.Color
 
hashCode() - Method in class com.github.miachm.sods.ConditionalFormat
 
hashCode() - Method in class com.github.miachm.sods.OfficeAnnotation
 
hashCode() - Method in class com.github.miachm.sods.OfficeCurrency
 
hashCode() - Method in class com.github.miachm.sods.OfficePercentage
 
hashCode() - Method in class com.github.miachm.sods.Sheet
 
hashCode() - Method in class com.github.miachm.sods.SpreadSheet
 
hashCode() - Method in class com.github.miachm.sods.Style
 
hasTableCellProperties() - Method in class com.github.miachm.sods.Style
Tells whether the style has table cell properties.
hideColumn(int) - Method in class com.github.miachm.sods.Sheet
Hides a column specified by his index
hideColumns(int, int) - Method in class com.github.miachm.sods.Sheet
Hides a column specified by a range
hideRow(int) - Method in class com.github.miachm.sods.Sheet
Hides a row specified by his index
hideRows(int, int) - Method in class com.github.miachm.sods.Sheet
Hides a row specified by a range
hideSheet() - Method in class com.github.miachm.sods.Sheet
Mark this sheet as hidden

I

insertColumnAfter(int) - Method in class com.github.miachm.sods.Sheet
Insert a column after a specific position
insertColumnBefore(int) - Method in class com.github.miachm.sods.Sheet
Insert a column before a specific position
insertColumnsAfter(int, int) - Method in class com.github.miachm.sods.Sheet
Insert a number of columns after a specific position
insertColumnsBefore(int, int) - Method in class com.github.miachm.sods.Sheet
Insert a number of columns before a specific position
insertRowAfter(int) - Method in class com.github.miachm.sods.Sheet
Insert a row after a specific position
insertRowBefore(int) - Method in class com.github.miachm.sods.Sheet
Insert a row before a specific position
insertRowsAfter(int, int) - Method in class com.github.miachm.sods.Sheet
Insert a row after a specific position
insertRowsBefore(int, int) - Method in class com.github.miachm.sods.Sheet
Insert a row before a specific position
isBold() - Method in class com.github.miachm.sods.Style
Determines if the font has bold style or not.
isBorder() - Method in class com.github.miachm.sods.Borders
Determines if the style has all borders or not.
isBorderBottom() - Method in class com.github.miachm.sods.Borders
Determines if the style has bottom border or not.
isBorderLeft() - Method in class com.github.miachm.sods.Borders
Determines if the style has left border or not.
isBorderRight() - Method in class com.github.miachm.sods.Borders
Determines if the style has right border or not.
isBorderTop() - Method in class com.github.miachm.sods.Borders
Determines if the style has top border or not.
isDefault() - Method in class com.github.miachm.sods.Style
Determine if this has default rules or not
isDisplayLabel() - Method in class com.github.miachm.sods.Chart
Returns whether labels are displayed.
isHidden() - Method in class com.github.miachm.sods.Sheet
Determinies if the sheet is marked as hidden or not
isItalic() - Method in class com.github.miachm.sods.Style
Determines if the font has italic style or not.
isLineThrough() - Method in class com.github.miachm.sods.Style
Returns if the font has a lineThrough style or not
isLoadGraphs() - Method in class com.github.miachm.sods.OdsOptionParameters
If it should load charts/graphs or not.
isLoadImages() - Method in class com.github.miachm.sods.OdsOptionParameters
If it should load images or not.
isLoadStyles() - Method in class com.github.miachm.sods.OdsOptionParameters
If it should load Formatting styles or not.
isPartOfMerge() - Method in class com.github.miachm.sods.Range
Determines if the range is part of an existing cell's block
isProtected() - Method in class com.github.miachm.sods.Sheet
Determines if this sheet is protected by a password or not
isShowWall() - Method in class com.github.miachm.sods.Chart
Returns whether the wall is displayed.
isUnderline() - Method in class com.github.miachm.sods.Style
Returns if the font has a underline style or not
isWrap() - Method in class com.github.miachm.sods.Style
Gets the wrapping nature.

M

merge() - Method in class com.github.miachm.sods.Range
Merges the cells in the range together into a single block.

N

NotAnOdsException - Exception in com.github.miachm.sods
The file provided is not an ODS file

O

OdsOptionParameters - Class in com.github.miachm.sods
Custom Load options for reading a Spreadsheet
OdsOptionParameters() - Constructor for class com.github.miachm.sods.OdsOptionParameters
 
OfficeAnnotation - Class in com.github.miachm.sods
This class represent an Annotation in a Cell of the Sheet.
OfficeAnnotation() - Constructor for class com.github.miachm.sods.OfficeAnnotation
 
OfficeAnnotation(String, LocalDateTime) - Constructor for class com.github.miachm.sods.OfficeAnnotation
 
OfficeAnnotationBuilder - Class in com.github.miachm.sods
A helper class whose objetive is to build a OfficeAnnotation class
OfficeAnnotationBuilder() - Constructor for class com.github.miachm.sods.OfficeAnnotationBuilder
 
OfficeCurrency - Class in com.github.miachm.sods
This class represents a Currency in a Spreadsheet It contains the current currency object (java.util.Currency) and the numeric value
OfficeCurrency(Currency, Double) - Constructor for class com.github.miachm.sods.OfficeCurrency
It builds an inmutable class of the OfficeCurrency
OfficeCurrency(Currency, Double, NumberFormat) - Constructor for class com.github.miachm.sods.OfficeCurrency
It builds an inmutable class of the OfficeCurrency
OfficePercentage - Class in com.github.miachm.sods
This class defines a percentage in a Spreadsheet
OfficePercentage(Double) - Constructor for class com.github.miachm.sods.OfficePercentage
Build a default object with a value
OfficePercentage(String) - Constructor for class com.github.miachm.sods.OfficePercentage
Build a default object using the string representation of percentage
OperationNotSupportedException - Exception in com.github.miachm.sods
Describe an legal operation which it's not already supported

R

Range - Class in com.github.miachm.sods
A range represents a subset of a Sheet.
removeCondition(int) - Method in class com.github.miachm.sods.Style
Remove a specific condition rule in an index
rowIsHidden(int) - Method in class com.github.miachm.sods.Sheet
Determinies if a specific row is hidden or not

S

save(File) - Method in class com.github.miachm.sods.SpreadSheet
Save this SpreadSheet in a ODS file.
save(OutputStream) - Method in class com.github.miachm.sods.SpreadSheet
Save this Spreadsheet to the stream in the ODS format
setAnchorColumn(Integer) - Method in class com.github.miachm.sods.SheetImage
Sets the anchor column index.
setAnchorRow(Integer) - Method in class com.github.miachm.sods.SheetImage
Sets the anchor row index.
setAnnotation(OfficeAnnotation) - Method in class com.github.miachm.sods.Range
Set an annotation for all the cells in this range.
setAnnotations(OfficeAnnotation...) - Method in class com.github.miachm.sods.Range
Set a set of anotations to the range.
setAnnotations(OfficeAnnotation[][]) - Method in class com.github.miachm.sods.Range
Set a set of annotations to the range.
setAutoPosition(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether auto-positioning is enabled.
setAutoSize(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether auto-sizing is enabled.
setAxisPosition(int) - Method in class com.github.miachm.sods.ChartProperties
Sets the axis position index.
setBackgroundColor(Color) - Method in class com.github.miachm.sods.Range
Set a cell background color to the entire range
setBackgroundColor(Color) - Method in class com.github.miachm.sods.Style
Set the background color
setBackgroundColors(Color...) - Method in class com.github.miachm.sods.Range
Set a set of cell background colors to the range.
setBackgroundColors(Color[][]) - Method in class com.github.miachm.sods.Range
Set a set of cell background colors formatting to the range.
setBold(boolean) - Method in class com.github.miachm.sods.Style
Set a bold font style
setBorder(boolean) - Method in class com.github.miachm.sods.Borders
Sets all borders on/off.
setBorderBottom(boolean) - Method in class com.github.miachm.sods.Borders
Sets bottom border on/off.
setBorderBottomProperties(String) - Method in class com.github.miachm.sods.Borders
Sets bottom border properties.
setBorderLeft(boolean) - Method in class com.github.miachm.sods.Borders
Sets left border on/off.
setBorderLeftProperties(String) - Method in class com.github.miachm.sods.Borders
Sets left border properties.
setBorderProperties(String) - Method in class com.github.miachm.sods.Borders
Sets global border properties.
setBorderRight(boolean) - Method in class com.github.miachm.sods.Borders
Sets right border on/off.
setBorderRightProperties(String) - Method in class com.github.miachm.sods.Borders
Sets right border properties.
setBorders(Borders) - Method in class com.github.miachm.sods.Style
Sets the borders properties.
setBorderTop(boolean) - Method in class com.github.miachm.sods.Borders
Sets top border on/off.
setBorderTopProperties(String) - Method in class com.github.miachm.sods.Borders
Sets top border properties.
setCategoriesRangeAddress(String) - Method in class com.github.miachm.sods.Chart
Sets the A1 range address for categories.
setColor(Color) - Method in class com.github.miachm.sods.ChartTextProperties
Sets the text color.
setColumnWidth(int, Double) - Method in class com.github.miachm.sods.Sheet
Set a specific column width to a specific column.
setColumnWidths(int, int, Double) - Method in class com.github.miachm.sods.Sheet
Set a column width to a specific set of columns.
setDataStyle(String) - Method in class com.github.miachm.sods.Style
Sets the data style that tells office software how to interpret and format content entered into a cell.
setDefaultColumnCellStyle(int, Style) - Method in class com.github.miachm.sods.Sheet
Sets the default cell style of a specific column.
setDisplayLabel(boolean) - Method in class com.github.miachm.sods.Chart
Enables or disables label display.
setDisplayLabel(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether labels are displayed.
setEdgeRounding(String) - Method in class com.github.miachm.sods.ChartGraphicProperties
Sets the edge rounding value.
setFill(String) - Method in class com.github.miachm.sods.ChartGraphicProperties
Sets the fill style.
setFillColor(Color) - Method in class com.github.miachm.sods.ChartGraphicProperties
Sets the fill color.
setFontBold(boolean) - Method in class com.github.miachm.sods.Range
Set a font bold style to the entire range
setFontBolds(boolean...) - Method in class com.github.miachm.sods.Range
Set a set of font bolds styles to the range.
setFontBolds(boolean[][]) - Method in class com.github.miachm.sods.Range
Set a set of font bolds formatting to the range.
setFontColor(Color) - Method in class com.github.miachm.sods.Range
Set a font color to the entire range
setFontColor(Color) - Method in class com.github.miachm.sods.Style
Set the font color
setFontColors(Color...) - Method in class com.github.miachm.sods.Range
Set a set of font colors styles to the range.
setFontColors(Color[][]) - Method in class com.github.miachm.sods.Range
Set a set of font colors formatting to the range.
setFontFamily(String) - Method in class com.github.miachm.sods.ChartTextProperties
Sets the font family.
setFontItalic(boolean) - Method in class com.github.miachm.sods.Range
Set a font italic style to the entire range
setFontItalics(boolean...) - Method in class com.github.miachm.sods.Range
Set a set of font italics styles to the range.
setFontItalics(boolean[][]) - Method in class com.github.miachm.sods.Range
Set a set of font italics formatting to the range.
setFontLineThrough(boolean) - Method in class com.github.miachm.sods.Range
Set a font lineThrough style to the entire range
setFontLineThroughs(boolean...) - Method in class com.github.miachm.sods.Range
Set a set of font lineThroughs styles to the range.
setFontLineThroughs(boolean[][]) - Method in class com.github.miachm.sods.Range
Set a set of font lineThroughs formatting to the range.
setFontSize(int) - Method in class com.github.miachm.sods.Range
Set the font size to the entire range
setFontSize(int) - Method in class com.github.miachm.sods.Style
Sets the font size
setFontSizeAsianPt(double) - Method in class com.github.miachm.sods.ChartTextProperties
Sets the Asian font size in points.
setFontSizeComplexPt(double) - Method in class com.github.miachm.sods.ChartTextProperties
Sets the complex font size in points.
setFontSizePt(double) - Method in class com.github.miachm.sods.ChartTextProperties
Sets the font size in points.
setFontSizes(int...) - Method in class com.github.miachm.sods.Range
Set a set of font sizes to the range.
setFontSizes(int[][]) - Method in class com.github.miachm.sods.Range
Set a set of font sizes to the range.
setFontStyle(String) - Method in class com.github.miachm.sods.ChartTextProperties
Sets the font style.
setFontUnderline(boolean) - Method in class com.github.miachm.sods.Range
Set a font underline style to the entire range
setFontUnderlines(boolean...) - Method in class com.github.miachm.sods.Range
Set a set of font underlines styles to the range.
setFontUnderlines(boolean[][]) - Method in class com.github.miachm.sods.Range
Set a set of font underlines formatting to the range.
setFontWeight(String) - Method in class com.github.miachm.sods.ChartTextProperties
Sets the font weight.
setFooter(String) - Method in class com.github.miachm.sods.Chart
Sets the chart footer text.
setFormula(String) - Method in class com.github.miachm.sods.Range
Set a formula for every cell in the range.
setFormulas(String...) - Method in class com.github.miachm.sods.Range
Set a set of formulas to the range.
setFormulas(String[][]) - Method in class com.github.miachm.sods.Range
Set a set of formulas to the range.
setHeight(String) - Method in class com.github.miachm.sods.Chart
Sets the chart height.
setHeight(String) - Method in class com.github.miachm.sods.SheetImage
Sets the image height.
setIncludeHiddenCells(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether hidden cells are included.
setItalic(boolean) - Method in class com.github.miachm.sods.Style
Set a italic font style
setLabelRangeAddress(String) - Method in class com.github.miachm.sods.ChartSeries
Sets the A1 range address for labels.
setLastModified(LocalDateTime) - Method in class com.github.miachm.sods.OfficeAnnotationBuilder
 
setLegend(String) - Method in class com.github.miachm.sods.Chart
Sets the legend configuration value.
setLineThrough(boolean) - Method in class com.github.miachm.sods.Style
Set a lineThrough font style
setLinkDataStyleToSource(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether data style is linked to the source.
setLoadGraphs(boolean) - Method in class com.github.miachm.sods.OdsOptionParameters
 
setLoadImages(boolean) - Method in class com.github.miachm.sods.OdsOptionParameters
 
setLoadStyles(boolean) - Method in class com.github.miachm.sods.OdsOptionParameters
 
setLogarithmic(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether logarithmic scaling is enabled.
setLogger(Logger) - Method in class com.github.miachm.sods.OdsOptionParameters
 
setMsg(String) - Method in class com.github.miachm.sods.OfficeAnnotationBuilder
 
setName(String) - Method in class com.github.miachm.sods.Sheet
Rename this sheet
setName(String) - Method in class com.github.miachm.sods.SheetImage
Sets the image name.
setPassword(String) - Method in class com.github.miachm.sods.Sheet
Sets a password for a sheet.
setPlotAreaStyle(ChartStyle) - Method in class com.github.miachm.sods.Chart
Sets the plot area style.
setReverseDirection(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether the axis direction is reversed.
setRightAngledAxes(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether right-angled axes are enabled.
setRowHeight(int, Double) - Method in class com.github.miachm.sods.Sheet
Set a specific row height to a specific row.
setRowHeights(int, int, Double) - Method in class com.github.miachm.sods.Sheet
Set a row height to a specific set of rows.
setSheet(Sheet, int) - Method in class com.github.miachm.sods.SpreadSheet
Replace the sheet in the position pos.
setSheetNumbers(List<Integer>) - Method in class com.github.miachm.sods.OdsOptionParameters
Sets the list of sheet numbers to load.
setShowWall(boolean) - Method in class com.github.miachm.sods.Chart
Enables or disables wall display.
setStroke(String) - Method in class com.github.miachm.sods.ChartGraphicProperties
Sets the stroke style.
setStrokeColor(Color) - Method in class com.github.miachm.sods.ChartGraphicProperties
Sets the stroke color.
setStrokeWidth(String) - Method in class com.github.miachm.sods.ChartGraphicProperties
Sets the stroke width.
setStyle(ChartStyle) - Method in class com.github.miachm.sods.Chart
Sets the chart style.
setStyle(ChartStyle) - Method in class com.github.miachm.sods.ChartAxis
Sets the axis style.
setStyle(ChartStyle) - Method in class com.github.miachm.sods.ChartSeries
Sets the series style.
setStyle(Style) - Method in class com.github.miachm.sods.Range
Set a format style for all the cells of the range
setStyles(Style...) - Method in class com.github.miachm.sods.Range
Set a set of format styles to the range.
setStyles(Style[][]) - Method in class com.github.miachm.sods.Range
Set a set of styles to the range.
setSymbolHeight(String) - Method in class com.github.miachm.sods.ChartProperties
Sets the symbol height.
setSymbolName(String) - Method in class com.github.miachm.sods.ChartProperties
Sets the symbol name.
setSymbolType(String) - Method in class com.github.miachm.sods.ChartProperties
Sets the symbol type.
setSymbolWidth(String) - Method in class com.github.miachm.sods.ChartProperties
Sets the symbol width.
setTextAligment(Style.TEXT_ALIGMENT) - Method in class com.github.miachm.sods.Style
Set text's aligment of the cell's text.
setTextLineBreak(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether text line breaks are enabled.
setTitle(String) - Method in class com.github.miachm.sods.Chart
Sets the chart title.
setTreatEmptyCells(ChartProperties.TreatEmptyCells) - Method in class com.github.miachm.sods.ChartProperties
Sets how empty cells are treated.
setTryStaggeringFirst(boolean) - Method in class com.github.miachm.sods.ChartProperties
Sets whether to try staggering labels first.
setType(String) - Method in class com.github.miachm.sods.Chart
Sets the chart type identifier.
setUnderline(boolean) - Method in class com.github.miachm.sods.Style
Set a underline font style
setValue(Object) - Method in class com.github.miachm.sods.Range
Set a value to the entire range
setValues(Object...) - Method in class com.github.miachm.sods.Range
Set a set of values to the range.
setValues(Object[][]) - Method in class com.github.miachm.sods.Range
Set a set of values to the range.
setValuesRangeAddress(String) - Method in class com.github.miachm.sods.ChartSeries
Sets the A1 range address for values.
setVerticalTextAligment(Style.VERTICAL_TEXT_ALIGMENT) - Method in class com.github.miachm.sods.Style
Set text's aligment of the cell's text in a vertical axis.
setWallStyle(ChartStyle) - Method in class com.github.miachm.sods.Chart
Sets the wall style.
setWidth(String) - Method in class com.github.miachm.sods.Chart
Sets the chart width.
setWidth(String) - Method in class com.github.miachm.sods.SheetImage
Sets the image width.
setWrap(boolean) - Method in class com.github.miachm.sods.Style
Sets the wrapping nature.
setX(String) - Method in class com.github.miachm.sods.Chart
Sets the X position.
setX(String) - Method in class com.github.miachm.sods.SheetImage
Sets the X position.
setXAxisLabel(String) - Method in class com.github.miachm.sods.Chart
Sets the label for the X axis.
setY(String) - Method in class com.github.miachm.sods.Chart
Sets the Y position.
setY(String) - Method in class com.github.miachm.sods.SheetImage
Sets the Y position.
setYAxisLabel(String) - Method in class com.github.miachm.sods.Chart
Sets the label for the Y axis.
Sheet - Class in com.github.miachm.sods
Represents a sheet in a Spreadsheet.
Sheet(String) - Constructor for class com.github.miachm.sods.Sheet
Create an empty sheet with a given name.
Sheet(String, int, int) - Constructor for class com.github.miachm.sods.Sheet
Create an empty sheet with a given name and dimmensions
SheetImage - Class in com.github.miachm.sods
Represents an image embedded in a Sheet.
SheetImage(byte[], String) - Constructor for class com.github.miachm.sods.SheetImage
Creates an image from raw bytes and MIME type.
showColumn(int) - Method in class com.github.miachm.sods.Sheet
Unhides the columns at the given index.
showRow(int) - Method in class com.github.miachm.sods.Sheet
Unhides the row at the given index.
showSheet() - Method in class com.github.miachm.sods.Sheet
Mark this sheet as visible
SodsException - Exception in com.github.miachm.sods
Base class for all exceptions of the library
SodsException() - Constructor for exception com.github.miachm.sods.SodsException
 
sortSheets() - Method in class com.github.miachm.sods.SpreadSheet
Deprecated.
This operation will be discarded for simplicity. You can easily recreate it with client code
sortSheets(Comparator<Sheet>) - Method in class com.github.miachm.sods.SpreadSheet
Deprecated.
This operation will be discarded for simplicity. You can easily recreate it with client code
split() - Method in class com.github.miachm.sods.Range
Breaks apart any combined cells on the range.
SpreadSheet - Class in com.github.miachm.sods
Spreadsheet is the base class for handle a Spreadsheet.
SpreadSheet() - Constructor for class com.github.miachm.sods.SpreadSheet
Create an empty spreadsheet
SpreadSheet(File) - Constructor for class com.github.miachm.sods.SpreadSheet
Load a Spreadsheet from an ODS file.
SpreadSheet(File, OdsOptionParameters) - Constructor for class com.github.miachm.sods.SpreadSheet
Load a Spreadsheet from an ODS file specifying options.
SpreadSheet(InputStream) - Constructor for class com.github.miachm.sods.SpreadSheet
Load a Spreadsheet from an inputstream.
SpreadSheet(InputStream, OdsOptionParameters) - Constructor for class com.github.miachm.sods.SpreadSheet
 
Style - Class in com.github.miachm.sods
This a class which represents the formatting of a cell (background color, font size, font style, etc...)
Style() - Constructor for class com.github.miachm.sods.Style
Constructs an empty-default Style.
Style(boolean, boolean, boolean, Color, Color, int) - Constructor for class com.github.miachm.sods.Style
Deprecated.
Style(boolean, boolean, boolean, Color, Color, int, Borders, boolean) - Constructor for class com.github.miachm.sods.Style
Deprecated.
Style.TEXT_ALIGMENT - Enum in com.github.miachm.sods
Defines the text position of a Cell
Style.VERTICAL_TEXT_ALIGMENT - Enum in com.github.miachm.sods
Defines the text position of a Cell in a vertical axis

T

toString() - Method in class com.github.miachm.sods.Color
A string representation of the color
toString() - Method in class com.github.miachm.sods.OfficeAnnotation
 
toString() - Method in class com.github.miachm.sods.OfficeCurrency
It prints the money quantity in a standard form (value + currency name) For example: 5EUR 10USD
toString() - Method in class com.github.miachm.sods.OfficePercentage
It prints a representation of the percentage in a '%' format
toString() - Method in class com.github.miachm.sods.Range
 
toString() - Method in class com.github.miachm.sods.Sheet
 
toString() - Method in class com.github.miachm.sods.SpreadSheet
 
toString() - Method in class com.github.miachm.sods.Style
Returns a String of this class in a CSS way.
toString(String) - Method in class com.github.miachm.sods.Style
Overloaded method of toString(), it allows a slight customization in the output.
trim() - Method in class com.github.miachm.sods.Sheet
Deprecated.
This function should not be called since it won't make any visible difference to the user. This is going to be moved to private visibility
trimSheets() - Method in class com.github.miachm.sods.SpreadSheet
Deprecated.
this operation relay in sheet.trim(), which is also deprecated

V

valueOf(String) - Static method in enum com.github.miachm.sods.ChartProperties.TreatEmptyCells
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.miachm.sods.Style.TEXT_ALIGMENT
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.miachm.sods.Style.VERTICAL_TEXT_ALIGMENT
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.miachm.sods.ChartProperties.TreatEmptyCells
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.miachm.sods.Style.TEXT_ALIGMENT
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.miachm.sods.Style.VERTICAL_TEXT_ALIGMENT
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E G H I M N O R S T V 
Skip navigation links

Copyright © 2026. All rights reserved.