XSSFDataValidation (POI API Documentation)

java.lang.Object
- org.apache.poi.xssf.usermodel.XSSFDataValidation

All Implemented Interfaces:: DataValidation

public class XSSFDataValidation
extends java.lang.Object
implements DataValidation

Author:: Radhakrishnan J

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.DataValidation
  DataValidation.ErrorStyle

Constructor Summary

Constructors
Constructor and Description
`XSSFDataValidation(XSSFDataValidationConstraint constraint, CellRangeAddressList regions, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDataValidation ctDataValidation)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 . (设置提示框的标题和文本。)
`boolean`	`getEmptyCellAllowed()` Retrieve the settings for empty cells allowed (检索允许的空单元格的设置)
`java.lang.String`	`getErrorBoxText()`
`java.lang.String`	`getErrorBoxTitle()`
`int`	`getErrorStyle()` o (这)
`java.lang.String`	`getPromptBoxText()`
`java.lang.String`	`getPromptBoxTitle()`
`CellRangeAddressList`	`getRegions()`
`boolean`	`getShowErrorBox()`
`boolean`	`getShowPromptBox()`
`boolean`	`getSuppressDropDownArrow()` Useful only list validation objects . (仅列出验证对象有用。)
`DataValidationConstraint`	`getValidationConstraint()`
`java.lang.String`	`prettyPrint()`
`void`	`setEmptyCellAllowed(boolean allowed)` Sets if this object allows empty as a valid value (设置此对象是否允许空作为有效值)
`void`	`setErrorStyle(int errorStyle)` 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
  - XSSFDataValidation
```
public XSSFDataValidation(XSSFDataValidationConstraint constraint,
                          CellRangeAddressList regions,
                          org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDataValidation ctDataValidation)
```
- Method Detail
  - createErrorBox
```
public void createErrorBox(java.lang.String title,
                           java.lang.String text)
```
    Description copied from interface: DataValidation
    
    Sets the title and text for the error box . Error box is displayed when the user enters an invalid value int o a cell which belongs to this validation object . In order for an error box to be displayed you should also use method setShowErrorBox( boolean show ) (设置错误框的标题和文本。当用户在属于此验证对象的 oa 单元格中输入无效值时，将显示错误框。为了显示错误框，您还应该使用方法 setShowErrorBox( boolean show ))
    
    Specified by:
    
    createErrorBox in interface DataValidation (接口 DataValidation 中的 createErrorBox)
    
    Parameters:
    
    title - The error box's title (title - 错误框的标题)
    
    text - The error box's text (text - 错误框的文本)
  - createPromptBox
```
public void createPromptBox(java.lang.String title,
                            java.lang.String text)
```
    Description copied from interface: DataValidation
    
    Sets the title and text for the prompt box . Prompt box is displayed when the user selects a cell which belongs to this validation object . In order for a prompt box to be displayed you should also use method setShowPromptBox( boolean show ) (设置提示框的标题和文本。当用户选择属于此验证对象的单元格时，会显示提示框。为了显示提示框，您还应该使用方法 setShowPromptBox( boolean show ))
    
    Specified by:
    
    createPromptBox in interface DataValidation (接口 DataValidation 中的 createPromptBox)
    
    Parameters:
    
    title - The prompt box's title (title - 提示框的标题)
    
    text - The prompt box's text (text - 提示框的文本)
  - getEmptyCellAllowed
```
public boolean getEmptyCellAllowed()
```
    Description copied from interface: DataValidation
    
    Retrieve the settings for empty cells allowed (检索允许的空单元格的设置)
    
    Specified by:
    
    getEmptyCellAllowed in interface DataValidation (接口 DataValidation 中的 getEmptyCellAllowed)
    
    Returns:
    
    True if this object should treats empty as valid value , false otherwise (如果此对象应将空视为有效值，则为真，否则为假)
  - getErrorBoxText
```
public java.lang.String getErrorBoxText()
```
    Specified by:
    
    getErrorBoxText in interface DataValidation (DataValidation 接口中的 getErrorBoxText)
    
    Returns:
    
    Error box's text or null (错误框的文本或 null)
  - getErrorBoxTitle
```
public java.lang.String getErrorBoxTitle()
```
    Specified by:
    
    getErrorBoxTitle in interface DataValidation (DataValidation 接口中的 getErrorBoxTitle)
    
    Returns:
    
    Error box's title or null (错误框的标题或 null)
  - getErrorStyle
```
public int getErrorStyle()
```
    Description copied from interface: DataValidation
    
    o (这)
    
    Specified by:
    
    getErrorStyle in interface DataValidation (DataValidation 接口中的 getErrorStyle)
    
    Returns:
    
    the error style of error box (错误框的错误样式)
    
    See Also:
    
    DataValidation.ErrorStyle
  - getPromptBoxText
```
public java.lang.String getPromptBoxText()
```
    Specified by:
    
    getPromptBoxText in interface DataValidation (接口 DataValidation 中的 getPromptBoxText)
    
    Returns:
    
    Prompt box's text or null (提示框的文本或 null)
  - getPromptBoxTitle
```
public java.lang.String getPromptBoxTitle()
```
    Specified by:
    
    getPromptBoxTitle in interface DataValidation (接口 DataValidation 中的 getPromptBoxTitle)
    
    Returns:
    
    Prompt box's title or null (提示框的标题或 null)
  - getShowErrorBox
```
public boolean getShowErrorBox()
```
    Specified by:
    
    getShowErrorBox in interface DataValidation (接口 DataValidation 中的 getShowErrorBox)
    
    Returns:
    
    true if an error box should be displayed , false otherwise (如果应显示错误框，则为 true ，否则为 false)
  - getShowPromptBox
```
public boolean getShowPromptBox()
```
    Specified by:
    
    getShowPromptBox in interface DataValidation (接口 DataValidation 中的 getShowPromptBox)
    
    Returns:
    
    true if an prompt box should be displayed , false otherwise (如果应显示提示框，则为 true ，否则为 false)
  - getSuppressDropDownArrow
```
public boolean getSuppressDropDownArrow()
```
    Description copied from interface: DataValidation
    
    Useful only list validation objects . This method always returns false if the object isn't a list validation object (仅列出验证对象有用。如果对象不是列表验证对象，此方法总是返回 false)
    
    Specified by:
    
    getSuppressDropDownArrow in interface DataValidation (接口 DataValidation 中的 getSuppressDropDownArrow)
    
    Returns:
    
    true if a list should display the values into a drop down list , false otherwise . (如果列表应将值显示到下拉列表中，则为 true，否则为 false。)
  - getValidationConstraint
```
public DataValidationConstraint getValidationConstraint()
```
    Specified by:
    
    getValidationConstraint in interface DataValidation (接口 DataValidation 中的 getValidationConstraint)
  - setEmptyCellAllowed
```
public void setEmptyCellAllowed(boolean allowed)
```
    Description copied from interface: DataValidation
    
    Sets if this object allows empty as a valid value (设置此对象是否允许空作为有效值)
    
    Specified by:
    
    setEmptyCellAllowed in interface DataValidation (接口 DataValidation 中的 setEmptyCellAllowed)
    
    Parameters:
    
    allowed - true if this object should treats empty as valid value , false otherwise (allowed - 如果此对象应将空视为有效值，则为 true，否则为 false)
  - setErrorStyle
```
public void setErrorStyle(int errorStyle)
```
    Description copied from interface: DataValidation
    
    Sets the error style for error box (设置错误框的错误样式)
    
    Specified by:
    
    setErrorStyle in interface DataValidation (接口 DataValidation 中的 setErrorStyle)
    
    See Also:
    
    DataValidation.ErrorStyle
  - setShowErrorBox
```
public void setShowErrorBox(boolean show)
```
    Description copied from interface: DataValidation
    
    Sets the behaviour when an invalid value is entered (设置输入无效值时的行为)
    
    Specified by:
    
    setShowErrorBox in interface DataValidation (接口 DataValidation 中的 setShowErrorBox)
    
    Parameters:
    
    show - true if an error box should be displayed , false otherwise (show - 如果应该显示错误框，则为 true，否则为 false)
  - setShowPromptBox
```
public void setShowPromptBox(boolean show)
```
    Description copied from interface: DataValidation
    
    Sets the behaviour when a cell which belongs to this object is selected (设置选择属于此对象的单元格时的行为)
    
    Specified by:
    
    setShowPromptBox in interface DataValidation (接口 DataValidation 中的 setShowPromptBox)
    
    Parameters:
    
    show - true if an prompt box should be displayed , false otherwise (show - 如果应显示提示框，则为 true，否则为 false)
  - setSuppressDropDownArrow
```
public void setSuppressDropDownArrow(boolean suppress)
```
    Description copied from interface: DataValidation
    
    Useful for list validation objects . (对列表验证对象很有用。)
    
    Specified by:
    
    setSuppressDropDownArrow in interface DataValidation (接口 DataValidation 中的 setSuppressDropDownArrow)
    
    Parameters:
    
    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 side (suppress - 如果列表应将值显示到下拉列表中，则为 True，否则为 false。换句话说，如果列表应该在其右侧显示箭头符号)
  - getRegions
```
public CellRangeAddressList getRegions()
```
    Specified by:
    
    getRegions in interface DataValidation (接口 DataValidation 中的 getRegions)
  - prettyPrint
```
public java.lang.String prettyPrint()
```

Class XSSFDataValidation

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.DataValidation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XSSFDataValidation

Method Detail

createErrorBox

createPromptBox

getEmptyCellAllowed

getErrorBoxText

getErrorBoxTitle

getErrorStyle

getPromptBoxText

getPromptBoxTitle

getShowErrorBox

getShowPromptBox

getSuppressDropDownArrow

getValidationConstraint

setEmptyCellAllowed

setErrorStyle

setShowErrorBox

setShowPromptBox

setSuppressDropDownArrow

getRegions

prettyPrint