* sheet.addConditionalFormatting(regions, rule);
* </PRE>
*/
-public final class HSSFConditionalFormatting implements ConditionalFormatting
-{
- private final HSSFWorkbook _workbook;
- private final CFRecordsAggregate cfAggregate;
+public final class HSSFConditionalFormatting implements ConditionalFormatting {
+ private final HSSFWorkbook _workbook;
+ private final CFRecordsAggregate cfAggregate;
+
+ // TODO Should this be assigning unique IDs to the rules
+ // as they get added to the file?
- // TODO Should this be assigning unique IDs to the rules
- // as they get added to the file?
-
// TODO Support types beyond CELL_VALUE_IS and FORMULA
- HSSFConditionalFormatting(HSSFWorkbook workbook, CFRecordsAggregate cfAggregate)
- {
- if(workbook == null) {
- throw new IllegalArgumentException("workbook must not be null");
- }
- if(cfAggregate == null) {
- throw new IllegalArgumentException("cfAggregate must not be null");
- }
- _workbook = workbook;
- this.cfAggregate = cfAggregate;
- }
- CFRecordsAggregate getCFRecordsAggregate() {
- return cfAggregate;
- }
+ HSSFConditionalFormatting(HSSFWorkbook workbook, CFRecordsAggregate cfAggregate) {
+ if(workbook == null) {
+ throw new IllegalArgumentException("workbook must not be null");
+ }
+ if(cfAggregate == null) {
+ throw new IllegalArgumentException("cfAggregate must not be null");
+ }
+ _workbook = workbook;
+ this.cfAggregate = cfAggregate;
+ }
+ CFRecordsAggregate getCFRecordsAggregate() {
+ return cfAggregate;
+ }
- /**
- * @deprecated (Aug-2008) use {@link HSSFConditionalFormatting#getFormattingRanges()}
- */
- public org.apache.poi.ss.util.Region[] getFormattingRegions()
- {
- CellRangeAddress[] cellRanges = getFormattingRanges();
- return org.apache.poi.ss.util.Region.convertCellRangesToRegions(cellRanges);
- }
- /**
- * @return array of <tt>CellRangeAddress</tt>s. never <code>null</code>
- */
- public CellRangeAddress[] getFormattingRanges() {
- return cfAggregate.getHeader().getCellRanges();
- }
+ /**
+ * @deprecated (Aug-2008) use {@link HSSFConditionalFormatting#getFormattingRanges()}
+ */
+ public org.apache.poi.ss.util.Region[] getFormattingRegions() {
+ CellRangeAddress[] cellRanges = getFormattingRanges();
+ return org.apache.poi.ss.util.Region.convertCellRangesToRegions(cellRanges);
+ }
+ /**
+ * @return array of <tt>CellRangeAddress</tt>s. never <code>null</code>
+ */
+ public CellRangeAddress[] getFormattingRanges() {
+ return cfAggregate.getHeader().getCellRanges();
+ }
- /**
- * Replaces an existing Conditional Formatting rule at position idx.
- * Excel allows to create up to 3 Conditional Formatting rules.
- * This method can be useful to modify existing Conditional Formatting rules.
- *
- * @param idx position of the rule. Should be between 0 and 2.
- * @param cfRule - Conditional Formatting rule
- */
- public void setRule(int idx, HSSFConditionalFormattingRule cfRule)
- {
- cfAggregate.setRule(idx, cfRule.getCfRuleRecord());
- }
+ /**
+ * Replaces an existing Conditional Formatting rule at position idx.
+ * Excel allows to create up to 3 Conditional Formatting rules.
+ * This method can be useful to modify existing Conditional Formatting rules.
+ *
+ * @param idx position of the rule. Should be between 0 and 2.
+ * @param cfRule - Conditional Formatting rule
+ */
+ public void setRule(int idx, HSSFConditionalFormattingRule cfRule) {
+ cfAggregate.setRule(idx, cfRule.getCfRuleRecord());
+ }
public void setRule(int idx, ConditionalFormattingRule cfRule){
setRule(idx, (HSSFConditionalFormattingRule)cfRule);
}
- /**
- * add a Conditional Formatting rule.
- * Excel allows to create up to 3 Conditional Formatting rules.
- * @param cfRule - Conditional Formatting rule
- */
- public void addRule(HSSFConditionalFormattingRule cfRule)
- {
- cfAggregate.addRule(cfRule.getCfRuleRecord());
- }
+ /**
+ * add a Conditional Formatting rule.
+ * Excel allows to create up to 3 Conditional Formatting rules.
+ * @param cfRule - Conditional Formatting rule
+ */
+ public void addRule(HSSFConditionalFormattingRule cfRule) {
+ cfAggregate.addRule(cfRule.getCfRuleRecord());
+ }
public void addRule(ConditionalFormattingRule cfRule){
addRule((HSSFConditionalFormattingRule)cfRule);
}
- /**
- * @return the Conditional Formatting rule at position idx.
- */
- public HSSFConditionalFormattingRule getRule(int idx)
- {
- CFRuleBase ruleRecord = cfAggregate.getRule(idx);
- return new HSSFConditionalFormattingRule(_workbook, ruleRecord);
- }
+ /**
+ * @return the Conditional Formatting rule at position idx.
+ */
+ public HSSFConditionalFormattingRule getRule(int idx) {
+ CFRuleBase ruleRecord = cfAggregate.getRule(idx);
+ return new HSSFConditionalFormattingRule(_workbook, ruleRecord);
+ }
- /**
- * @return number of Conditional Formatting rules.
- */
- public int getNumberOfRules()
- {
- return cfAggregate.getNumberOfRules();
- }
+ /**
+ * @return number of Conditional Formatting rules.
+ */
+ public int getNumberOfRules() {
+ return cfAggregate.getNumberOfRules();
+ }
- public String toString()
- {
- return cfAggregate.toString();
- }
+ public String toString() {
+ return cfAggregate.toString();
+ }
}