/* | |
* ==================================================================== | |
* Licensed to the Apache Software Foundation (ASF) under one or more | |
* contributor license agreements. See the NOTICE file distributed with | |
* this work for additional information regarding copyright ownership. | |
* The ASF licenses this file to You under the Apache License, Version 2.0 | |
* (the "License"); you may not use this file except in compliance with | |
* the License. You may obtain a copy of the License at | |
* | |
* http://www.apache.org/licenses/LICENSE-2.0 | |
* | |
* Unless required by applicable law or agreed to in writing, software | |
* distributed under the License is distributed on an "AS IS" BASIS, | |
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
* See the License for the specific language governing permissions and | |
* limitations under the License. | |
* ==================================================================== | |
*/ | |
package org.apache.poi.xssf.usermodel; | |
import org.apache.poi.ss.usermodel.ConditionalFormatting; | |
import org.apache.poi.ss.usermodel.ConditionalFormattingRule; | |
import org.apache.poi.ss.util.CellRangeAddress; | |
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTConditionalFormatting; | |
import java.util.ArrayList; | |
import java.util.Collections; | |
/** | |
* @author Yegor Kozlov | |
*/ | |
public class XSSFConditionalFormatting implements ConditionalFormatting { | |
private final CTConditionalFormatting _cf; | |
private final XSSFSheet _sh; | |
/*package*/ XSSFConditionalFormatting(XSSFSheet sh) { | |
_cf = CTConditionalFormatting.Factory.newInstance(); | |
_sh = sh; | |
} | |
/*package*/ XSSFConditionalFormatting( | |
XSSFSheet sh, CTConditionalFormatting cf) { | |
_cf = cf; | |
_sh = sh; | |
} | |
/*package*/ CTConditionalFormatting getCTConditionalFormatting() { | |
return _cf; | |
} | |
/** | |
* @return array of <tt>CellRangeAddress</tt>s. Never <code>null</code> | |
*/ | |
@Override | |
public CellRangeAddress[] getFormattingRanges() { | |
ArrayList<CellRangeAddress> lst = new ArrayList<CellRangeAddress>(); | |
for (Object stRef : _cf.getSqref()) { | |
String[] regions = stRef.toString().split(" "); | |
for (final String region : regions) { | |
lst.add(CellRangeAddress.valueOf(region)); | |
} | |
} | |
return lst.toArray(new CellRangeAddress[lst.size()]); | |
} | |
@Override | |
public void setFormattingRanges(CellRangeAddress[] ranges) { | |
if (ranges == null) { | |
throw new IllegalArgumentException("cellRanges must not be null"); | |
} | |
final StringBuilder sb = new StringBuilder(); | |
boolean first = true; | |
for (CellRangeAddress range : ranges) { | |
if (!first) { | |
sb.append(" "); | |
} else { | |
first = false; | |
} | |
sb.append(range.formatAsString()); | |
} | |
_cf.setSqref(Collections.singletonList(sb.toString())); | |
} | |
/** | |
* 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 | |
*/ | |
@Override | |
public void setRule(int idx, ConditionalFormattingRule cfRule) { | |
XSSFConditionalFormattingRule xRule = (XSSFConditionalFormattingRule) cfRule; | |
_cf.getCfRuleArray(idx).set(xRule.getCTCfRule()); | |
} | |
/** | |
* Add a Conditional Formatting rule. | |
* Excel allows to create up to 3 Conditional Formatting rules. | |
* | |
* @param cfRule - Conditional Formatting rule | |
*/ | |
@Override | |
public void addRule(ConditionalFormattingRule cfRule) { | |
XSSFConditionalFormattingRule xRule = (XSSFConditionalFormattingRule) cfRule; | |
_cf.addNewCfRule().set(xRule.getCTCfRule()); | |
} | |
/** | |
* @return the Conditional Formatting rule at position idx. | |
*/ | |
@Override | |
public XSSFConditionalFormattingRule getRule(int idx) { | |
return new XSSFConditionalFormattingRule(_sh, _cf.getCfRuleArray(idx)); | |
} | |
/** | |
* @return number of Conditional Formatting rules. | |
*/ | |
@Override | |
public int getNumberOfRules() { | |
return _cf.sizeOfCfRuleArray(); | |
} | |
@Override | |
public String toString() { | |
return _cf.toString(); | |
} | |
} |