Package io.keikai.model

Interface SDataValidation

All Superinterfaces:

FormulaContent

All Known Implementing Classes:

AbstractDataValidationAdv, DataValidationImpl

public interface SDataValidation
extends FormulaContent

This class stores the restrictions on what data can or should be entered in a cell.

Since:

3.5.0

Author:

dennis

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SDataValidation.AlertStyle
static class	SDataValidation.OperatorType
static class	SDataValidation.ValidationType

Method Summary

Modifier and Type	Method	Description
void	addRegion(CellRegion region)
SDataValidation.AlertStyle	getAlertStyle()
String	getErrorMessage()
String	getErrorTitle()
String	getFormula1()
String	getFormula2()
Object	getId()
String	getInputMessage()
String	getInputTitle()
int	getNumOfValue()
int	getNumOfValue1()
int	getNumOfValue2()
SDataValidation.OperatorType	getOperatorType()
List<SCell>	getReferToCellList()
List<SCell>	getReferToCellList(int row, int col)	Return the referred list relative to the specified row and column.
Set<CellRegion>	getRegions()
SSheet	getSheet()
SDataValidation.ValidationType	getValidationType()
Object	getValue(int i)
Object	getValue1(int i)
Object	getValue2(int i)
boolean	hasReferToCellList()
boolean	hasReferToRelativeCol()	Returns whether the referred list formula contains a relative column.
boolean	hasReferToRelativeRow()	Returns whether the referred list formula contains a relative row.
boolean	isFormulaParsingError()	Return formula parsing state.
boolean	isIgnoreBlank()
boolean	isInCellDropdown()
boolean	isShowError()
boolean	isShowInput()
void	removeRegion(CellRegion region)
void	setAlertStyle(SDataValidation.AlertStyle alertStyle)
void	setErrorMessage(String message)
void	setErrorTitle(String title)
void	setFormula1(String formula)
void	setFormula2(String formula)
void	setIgnoreBlank(boolean ignore)
void	setInCellDropdown(boolean show)
void	setInputMessage(String message)
void	setInputTitle(String title)
void	setOperatorType(SDataValidation.OperatorType type)
void	setRegions(Set<CellRegion> regions)
void	setShowError(boolean show)
void	setShowInput(boolean show)
void	setValidationType(SDataValidation.ValidationType type)

Methods inherited from interface io.keikai.model.FormulaContent

clearFormulaResultCache

Method Detail

getSheet

SSheet getSheet()

getAlertStyle

SDataValidation.AlertStyle getAlertStyle()

setAlertStyle

void setAlertStyle(SDataValidation.AlertStyle alertStyle)

setIgnoreBlank

void setIgnoreBlank(boolean ignore)

isIgnoreBlank

boolean isIgnoreBlank()

setInCellDropdown

void setInCellDropdown(boolean show)

isInCellDropdown

boolean isInCellDropdown()

setShowInput

void setShowInput(boolean show)

isShowInput

boolean isShowInput()

setShowError

void setShowError(boolean show)

isShowError

boolean isShowError()

setInputTitle

void setInputTitle(String title)

setInputMessage

void setInputMessage(String message)

getInputTitle

String getInputTitle()

getInputMessage

String getInputMessage()

setErrorTitle

void setErrorTitle(String title)

setErrorMessage

void setErrorMessage(String message)

getErrorTitle

String getErrorTitle()

getErrorMessage

String getErrorMessage()

getRegions

Set<CellRegion> getRegions()

setRegions

void setRegions(Set<CellRegion> regions)

addRegion

void addRegion(CellRegion region)

removeRegion

void removeRegion(CellRegion region)

getValidationType

SDataValidation.ValidationType getValidationType()

setValidationType

void setValidationType(SDataValidation.ValidationType type)

getOperatorType

SDataValidation.OperatorType getOperatorType()

setOperatorType

void setOperatorType(SDataValidation.OperatorType type)

isFormulaParsingError

boolean isFormulaParsingError()

Return formula parsing state.

Specified by:

isFormulaParsingError in interface FormulaContent

Returns:

true if has error, false if no error or no formula

hasReferToCellList

boolean hasReferToCellList()

getReferToCellList

List<SCell> getReferToCellList()

getNumOfValue

int getNumOfValue()

getValue

Object getValue(int i)

getNumOfValue1

int getNumOfValue1()

getValue1

Object getValue1(int i)

getNumOfValue2

int getNumOfValue2()

getValue2

Object getValue2(int i)

getFormula1

String getFormula1()

getFormula2

String getFormula2()

setFormula1

void setFormula1(String formula)

setFormula2

void setFormula2(String formula)

getId

Object getId()

hasReferToRelativeCol

boolean hasReferToRelativeCol()

Returns whether the referred list formula contains a relative column.

Returns:

Since:

3.7.0

hasReferToRelativeRow

boolean hasReferToRelativeRow()

Returns whether the referred list formula contains a relative row.

Returns:

Since:

3.7.0

getReferToCellList

List<SCell> getReferToCellList(int row,
                               int col)

Return the referred list relative to the specified row and column.

Parameters:

row -

col -

Returns:

Since:

3.7.0