-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #454 from civgio/hotfix/issue_453
#453: Add new data validation: ListFormulaDataValidation.
- Loading branch information
Showing
4 changed files
with
283 additions
and
31 deletions.
There are no files selected for viewing
127 changes: 127 additions & 0 deletions
127
fastexcel-writer/src/main/java/org/dhatim/fastexcel/ListFormulaDataValidation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| package org.dhatim.fastexcel; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * A ListDataValidation defines a DataValidation for a worksheet of type = "list" | ||
| */ | ||
| public class ListFormulaDataValidation implements DataValidation { | ||
| private final static String TYPE = "list"; | ||
| private final Range range; | ||
| private final Formula formula; | ||
|
|
||
| private boolean allowBlank = true; | ||
| private boolean showDropdown = true; | ||
| private DataValidationErrorStyle errorStyle = DataValidationErrorStyle.INFORMATION; | ||
| private boolean showErrorMessage = false; | ||
| private String errorTitle; | ||
| private String error; | ||
|
|
||
| /** | ||
| * Constructor | ||
| * | ||
| * @param range The Range this validation is applied to | ||
| * @param formula The Formula of this validation to retrieve the list | ||
| */ | ||
| ListFormulaDataValidation(Range range, Formula formula) { | ||
| this.range = range; | ||
| this.formula = formula; | ||
| } | ||
|
|
||
| /** | ||
| * whether blank cells should pass the validation | ||
| * | ||
| * @param allowBlank whether or not to allow blank values | ||
| * @return this ListDataValidation | ||
| */ | ||
| public ListFormulaDataValidation allowBlank(boolean allowBlank) { | ||
| this.allowBlank = allowBlank; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Whether Excel will show an in-cell dropdown list | ||
| * containing the validation list | ||
| * | ||
| * @param showDropdown whether or not to show the dropdown | ||
| * @return this ListDataValidation | ||
| */ | ||
| public ListFormulaDataValidation showDropdown(boolean showDropdown) { | ||
| this.showDropdown = showDropdown; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * The style of error alert used for this data validation. | ||
| * | ||
| * @param errorStyle The DataValidationErrorStyle for this DataValidation | ||
| * @return this ListDataValidation | ||
| */ | ||
| public ListFormulaDataValidation errorStyle(DataValidationErrorStyle errorStyle) { | ||
| this.errorStyle = errorStyle; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Whether to display the error alert message when an invalid value has been entered. | ||
| * | ||
| * @param showErrorMessage whether to display the error message | ||
| * @return this ListDataValidation | ||
| */ | ||
| public ListFormulaDataValidation showErrorMessage(boolean showErrorMessage) { | ||
| this.showErrorMessage = showErrorMessage; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Title bar text of error alert. | ||
| * | ||
| * @param errorTitle The error title | ||
| * @return this ListDataValidation | ||
| */ | ||
| public ListFormulaDataValidation errorTitle(String errorTitle) { | ||
| this.errorTitle = errorTitle; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Message text of error alert. | ||
| * | ||
| * @param error The error message | ||
| * @return this ListDataValidation | ||
| */ | ||
| public ListFormulaDataValidation error(String error) { | ||
| this.error = error; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Write this dataValidation as an XML element. | ||
| * | ||
| * @param w Output writer. | ||
| * @throws IOException If an I/O error occurs. | ||
| */ | ||
| @Override | ||
| public void write(Writer w) throws IOException { | ||
| w | ||
| .append("<dataValidation sqref=\"") | ||
| .append(range.toString()) | ||
| .append("\" type=\"") | ||
| .append(TYPE) | ||
| .append("\" allowBlank=\"") | ||
| .append(String.valueOf(allowBlank)) | ||
| .append("\" showDropDown=\"") | ||
| .append(String.valueOf(!showDropdown)) // for some reason, this is the inverse of what you'd expect | ||
| .append("\" errorStyle=\"") | ||
| .append(errorStyle.toString()) | ||
| .append("\" showErrorMessage=\"") | ||
| .append(String.valueOf(showErrorMessage)) | ||
| .append("\" errorTitle=\"") | ||
| .append(errorTitle) | ||
| .append("\" error=\"") | ||
| .append(error) | ||
| .append("\"><formula1>") | ||
| .append(formula.getExpression()) | ||
| .append("</formula1></dataValidation>"); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters