Package io.keikai.model

Interface SConditionalFormatting

All Known Implementing Classes:

ConditionalFormattingImpl

public interface SConditionalFormatting

Conditional Formatting

Author:

henri

Method Summary

Modifier and Type	Method	Description
void	addRegion(CellRegion region)
void	clearFormulaResultCache()
void	copyFrom(SConditionalFormatting src, int rowOff, int colOff)	Used to copy the contents from another src ConditionalFormatting.
void	destroy()	Call this destory() when this formatting is about to be destroied.
int	getId()
Set<CellRegion>	getRegions()	Regions that this conditional formatting covered
List<SConditionalFormattingRule>	getRules()	Rules applied to the covered region
SSheet	getSheet()	The sheet on which this conditional formatting covered
boolean	isUnderExt()
void	removeRegion(CellRegion region)	Remove partial region in the ConditionalFormatting
void	renameSheet(String oldName, String newName)	When sheet name changed; must call this to update region and rule formula
void	setRegions(Set<CellRegion> regions)

Method Details

getSheet

SSheet getSheet()

The sheet on which this conditional formatting covered

Returns:

getRegions

Set<CellRegion> getRegions()

Regions that this conditional formatting covered

Returns:

getRules

List<SConditionalFormattingRule> getRules()

Rules applied to the covered region

Returns:

removeRegion

void removeRegion(CellRegion region)

Remove partial region in the ConditionalFormatting

Parameters:

region -

Since:

3.9.0

renameSheet

void renameSheet(String oldName,
 String newName)

When sheet name changed; must call this to update region and rule formula

Parameters:

oldName -

newName -

Since:

3.9.0

destroy

void destroy()

Call this destory() when this formatting is about to be destroied.

Since:

3.9.0

copyFrom

void copyFrom(SConditionalFormatting src,
 int rowOff,
 int colOff)

Used to copy the contents from another src ConditionalFormatting.

Parameters:

src -

Since:

3.9.0

setRegions

void setRegions(Set<CellRegion> regions)

Parameters:

regions -

Since:

3.9.0

addRegion

void addRegion(CellRegion region)

Parameters:

region -

Since:

3.9.0

getId

int getId()

Returns:

Since:

3.9.0

clearFormulaResultCache

void clearFormulaResultCache()

Since:

3.9.0

isUnderExt

boolean isUnderExt()

Since:

5.7.0