org.apache.poi.hssf.usermodel
public final class HSSFDataValidation extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
HSSFDataValidation.ErrorStyle
Error style constants for error box
|
Constructor and Description |
---|
HSSFDataValidation(CellRangeAddressList regions,
DVConstraint constraint)
Constructor which initializes the cell range on which this object will be
applied
|
Modifier and Type | Method and Description |
---|---|
DVRecord |
createDVRecord(HSSFSheet sheet) |
void |
createErrorBox(java.lang.String title,
java.lang.String text)
Sets the title and text for the error box .
|
void |
createPromptBox(java.lang.String title,
java.lang.String text)
Sets the title and text for the prompt box .
|
DVConstraint |
getConstraint() |
boolean |
getEmptyCellAllowed()
Retrieve the settings for empty cells allowed
|
java.lang.String |
getErrorBoxText() |
java.lang.String |
getErrorBoxTitle() |
int |
getErrorStyle() |
java.lang.String |
getPromptBoxText() |
java.lang.String |
getPromptBoxTitle() |
boolean |
getShowErrorBox() |
boolean |
getShowPromptBox() |
boolean |
getSuppressDropDownArrow()
Useful only list validation objects .
|
void |
setEmptyCellAllowed(boolean allowed)
Sets if this object allows empty as a valid value
|
void |
setErrorStyle(int error_style)
Sets the error style for error box
|
void |
setShowErrorBox(boolean show)
Sets the behaviour when an invalid value is entered
|
void |
setShowPromptBox(boolean show)
Sets the behaviour when a cell which belongs to this object is selected
|
void |
setSuppressDropDownArrow(boolean suppress)
Useful for list validation objects .
|
public HSSFDataValidation(CellRangeAddressList regions, DVConstraint constraint)
constraint
- public DVConstraint getConstraint()
public void setErrorStyle(int error_style)
HSSFDataValidation.ErrorStyle
public int getErrorStyle()
HSSFDataValidation.ErrorStyle
public void setEmptyCellAllowed(boolean allowed)
allowed
- true
if this object should treats empty as valid value , false
otherwisepublic boolean getEmptyCellAllowed()
public void setSuppressDropDownArrow(boolean suppress)
suppress
- True if a list should display the values into a drop down list ,
false otherwise . In other words , if a list should display
the arrow sign on its right sidepublic boolean getSuppressDropDownArrow()
true
if a list should display the values into a drop down list ,
false
otherwise .public void setShowPromptBox(boolean show)
show
- true
if an prompt box should be displayed , false
otherwisepublic boolean getShowPromptBox()
true
if an prompt box should be displayed , false
otherwisepublic void setShowErrorBox(boolean show)
show
- true
if an error box should be displayed , false
otherwisepublic boolean getShowErrorBox()
true
if an error box should be displayed , false
otherwisepublic void createPromptBox(java.lang.String title, java.lang.String text)
title
- The prompt box's titletext
- The prompt box's textpublic java.lang.String getPromptBoxTitle()
null
public java.lang.String getPromptBoxText()
null
public void createErrorBox(java.lang.String title, java.lang.String text)
title
- The error box's titletext
- The error box's textpublic java.lang.String getErrorBoxTitle()
null
public java.lang.String getErrorBoxText()
null
Copyright 2014 The Apache Software Foundation or its licensors, as applicable.