|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.usermodel.HSSFDataValidation
public final class HSSFDataValidation
Utility class for creating data validation cells
Nested Class Summary | |
---|---|
static class |
HSSFDataValidation.ErrorStyle
Error style constants for error box |
Constructor Summary | |
---|---|
HSSFDataValidation(CellRangeAddressList regions,
DVConstraint constraint)
Constructor which initializes the cell range on which this object will be applied |
Method Summary | |
---|---|
DVRecord |
createDVRecord(HSSFWorkbook workbook)
|
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 . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HSSFDataValidation(CellRangeAddressList regions, DVConstraint constraint)
constraint
- Method Detail |
---|
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()
show
- 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
public DVRecord createDVRecord(HSSFWorkbook workbook)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |