Package io.keikai.model.impl

Class AbstractSheetAdv

java.lang.Object

io.keikai.model.impl.AbstractSheetAdv

All Implemented Interfaces:

LinkedModelObject, SSheet, Serializable

public abstract class AbstractSheetAdv
extends Object
implements SSheet, LinkedModelObject, Serializable

Since:

3.5.0

Author:

dennis

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.keikai.model.SSheet

SSheet.SheetVisible, SSheet.SpillRangeInfo

Constructor Summary

Constructors

Constructor	Description
AbstractSheetAdv()

Method Summary

Modifier and Type	Method	Description
abstract SConditionalFormatting	addConditionalFormatting(CellRegion srcrgn, CellRegion dstrgn, SConditionalFormatting src, int rowOff, int colOff)	Paste from src a new ConditionalFormatting at the specified region.
abstract void	addConditionalFormatting(SConditionalFormatting scf)
abstract void	clearTables()
abstract void	deleteConditionalFormatting(SConditionalFormatting cfmt)	Delete a conditional formatting from this sheet.
abstract List<SConditionalFormatting>	deleteConditionalFormattingRegion(CellRegion region)	Delete a region from conditional formatting and return the deleted conditional formatting.
abstract List<CellRegion>	getAllArrayFormulas()	Deprecated.
abstract SConditionalFormatting	getConditionalFormatting(int id)
abstract SConditionalFormatting	getConditionalFormatting(int row, int column)
abstract ConditionalStyleImpl	getConditionalFormattingStyle(int row, int col)
DataValidationIndex	getDataValidationIndex()
abstract int	getMergeOutOfSync()
OutlineLevelTree	getOutlineLevelColTree()
OutlineLevelTree	getOutlineLevelRowTree()
abstract Iterator<AbstractRowAdv>	getRowIterator(boolean reverse, int start, int end)
abstract List<SConditionalFormatting>	getSheetConditionalFormattings()
abstract STable	getTableByRowCol(int rowIdx, int colIdx)
abstract boolean	isFiltered()
abstract boolean	isHidden(int rowIdx, int colIdx)
abstract boolean	isRowHidden(int rowIdx)
abstract int	nextConditionalId()
abstract void	removeConditionalFormatting(SConditionalFormatting scf)
abstract void	removeConditionalFormattingRegion(CellRegion region)	Remove a region from conditional formatting.
abstract void	removeTable(STable table)
abstract void	removeTables(Set<String> tableNames)
abstract void	setMergeOutOfSync(int state)
void	syncOutlineLevelColTree()
void	syncOutlineLevelRowTree()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.keikai.model.impl.LinkedModelObject

checkOrphan, destroy

Methods inherited from interface io.keikai.model.SSheet

addCellRegionValueChangeListener, addCellWatch, addChart, addChart, addDataValidation, addDataValidation, addIgnoredError, addMergedRegion, addPicture, addPicture, addPivotTable, addProtectedRange, addScenario, addSlicer, addTable, addThreadedComment, addTimeline, canBulkSetRangeValues, clearAutoFilter, clearCell, clearCell, createAutoFilter, deleteAutoFilter, deleteCell, deleteCell, deleteChart, deleteColumn, deleteDataValidation, deleteDataValidationRegion, deletePicture, deleteRow, getAllCseRegions, getAttribute, getAttributes, getAutoFilter, getBook, getCell, getCell, getCellIterator, getCellRegionInArrayFormula, getCellWatches, getChart, getChart, getChartByName, getCharts, getChartsByName, getColumn, getColumnArray, getColumnArrayIterator, getColumnIterator, getConditionalFormattings, getContainsMergedRegions, getCseRegion, getCseRegionsInViewport, getDataRegion, getDataValidation, getDataValidation, getDataValidation, getDataValidations, getDefaultColumnWidth, getDefaultRowHeight, getEndCellIndex, getEndColumnIndex, getEndRowIndex, getFormControls, getHashedPassword, getId, getIgnoredErrors, getMergedRegion, getMergedRegion, getMergedRegion, getMergedRegions, getNumOfChart, getNumOfDataValidation, getNumOfMergedRegion, getNumOfPicture, getOleObjects, getOutlineLevelCol, getOutlineLevelRow, getOverlapsMergedRegions, getPicture, getPicture, getPictures, getPivotTables, getPrintSetup, getProtectedRanges, getRangeValues, getRow, getRowIterator, getRowIterator, getScenarios, getSheetName, getSheetProtection, getSheetVisible, getSlicers, getSmartArt, getSpillRangesInViewport, getStartCellIndex, getStartColumnIndex, getStartRowIndex, getTabColor, getTables, getThreadedComments, getTimelines, getViewInfo, getWordArt, hasCellRegionValueChangeListeners, insertCell, insertCell, insertColumn, insertRow, isApplyStyles, isProtected, isShowOutlineSymbols, isSummaryBelow, isSummaryRight, moveCell, moveCell, pasteCell, removeArrayFormula, removeCellRegionValueChangeListener, removeCellRegionValueChangeListener, removeCellWatch, removeCseArrayFormula, removeMergedRegion, removePivotTable, removeProtectedRange, removeScenario, removeSlicer, removeTable, removeThreadedComment, removeTimeline, replyToComment, setAlgName, setApplyStyles, setArrayFormula, setAttribute, setCseArrayFormula, setDefaultColumnWidth, setDefaultRowHeight, setHashedPassword, setHashValue, setOutlineLevelCol, setOutlineLevelRow, setPassword, setRangeValues, setSaltValue, setSheetVisible, setShowOutlineSymbols, setSpinCount, setSummaryBelow, setSummaryRight, setTabColor, setupColumnArray, showScenario

Constructor Details

AbstractSheetAdv

public AbstractSheetAdv()

Method Details

getRowIterator

public abstract Iterator<AbstractRowAdv> getRowIterator(boolean reverse,
 int start,
 int end)

getTableByRowCol

public abstract STable getTableByRowCol(int rowIdx,
 int colIdx)

isHidden

public abstract boolean isHidden(int rowIdx,
 int colIdx)

isRowHidden

public abstract boolean isRowHidden(int rowIdx)

isFiltered

public abstract boolean isFiltered()

removeTables

public abstract void removeTables(Set<String> tableNames)

removeTable

public abstract void removeTable(STable table)

clearTables

public abstract void clearTables()

addConditionalFormatting

public abstract void addConditionalFormatting(SConditionalFormatting scf)

setMergeOutOfSync

public abstract void setMergeOutOfSync(int state)

getMergeOutOfSync

public abstract int getMergeOutOfSync()

getConditionalFormattingStyle

public abstract ConditionalStyleImpl getConditionalFormattingStyle(int row,
 int col)

getConditionalFormatting

public abstract SConditionalFormatting getConditionalFormatting(int row,
 int column)

Parameters:

row -

column -

Returns:

the associated conditionalFormattingRule

Since:

3.9.0

removeConditionalFormatting

public abstract void removeConditionalFormatting(SConditionalFormatting scf)

nextConditionalId

public abstract int nextConditionalId()

getConditionalFormatting

public abstract SConditionalFormatting getConditionalFormatting(int id)

deleteConditionalFormatting

public abstract void deleteConditionalFormatting(SConditionalFormatting cfmt)

Delete a conditional formatting from this sheet.

Parameters:

cfmt -

Since:

3.9.0

removeConditionalFormattingRegion

public abstract void removeConditionalFormattingRegion(CellRegion region)

Remove a region from conditional formatting.

Parameters:

region -

Since:

3.9.0

deleteConditionalFormattingRegion

public abstract List<SConditionalFormatting> deleteConditionalFormattingRegion(CellRegion region)

Delete a region from conditional formatting and return the deleted conditional formatting.

Parameters:

region -

Returns:

Since:

3.9.0

addConditionalFormatting

public abstract SConditionalFormatting addConditionalFormatting(CellRegion srcrgn,
 CellRegion dstrgn,
 SConditionalFormatting src,
 int rowOff,
 int colOff)

Paste from src a new ConditionalFormatting at the specified region.

Parameters:

srcrgn -

src -

Returns:

Since:

3.9.0

getSheetConditionalFormattings

public abstract List<SConditionalFormatting> getSheetConditionalFormattings()

getAllArrayFormulas

@Deprecated
public abstract List<CellRegion> getAllArrayFormulas()

Deprecated.

Description copied from interface: SSheet

Returns the list of legacy CSE array regions registered on this sheet via SSheet.setArrayFormula(String, CellRegion). May miss XLSX-imported CSE regions that live only in the engine core; for a complete viewport-bounded list use SSheet.getCseRegionsInViewport(int, int, int, int).

Specified by:

getAllArrayFormulas in interface SSheet

getDataValidationIndex

public DataValidationIndex getDataValidationIndex()

getOutlineLevelRowTree

public OutlineLevelTree getOutlineLevelRowTree()

getOutlineLevelColTree

public OutlineLevelTree getOutlineLevelColTree()

syncOutlineLevelRowTree

public void syncOutlineLevelRowTree()

syncOutlineLevelColTree

public void syncOutlineLevelColTree()