mirror of https://github.com/apache/poi.git
Javadoc and comment updates for CFs
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1690486 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
28ca2d4f76
commit
2b85de98fd
src
examples/src/org/apache/poi/ss/examples
java/org/apache/poi
|
@ -54,6 +54,8 @@ public class ConditionalFormats {
|
|||
expiry(wb.createSheet("Expiry"));
|
||||
shadeAlt(wb.createSheet("Shade Alt"));
|
||||
shadeBands(wb.createSheet("Shade Bands"));
|
||||
|
||||
// TODO Add Icons, data bars etc, see bug #58130
|
||||
|
||||
// Write the output to a file
|
||||
String file = "cf-poi.xls";
|
||||
|
|
|
@ -32,12 +32,13 @@ import org.apache.poi.util.BitFieldFactory;
|
|||
import org.apache.poi.util.LittleEndianOutput;
|
||||
|
||||
/**
|
||||
* Conditional Formatting Rule Record (0x01B1).<br/>
|
||||
*
|
||||
* @author Dmitriy Kumshayev
|
||||
* Conditional Formatting Rule Record (0x01B1).
|
||||
*
|
||||
* <p>This is for the older-style Excel conditional formattings,
|
||||
* new-style (Excel 2007+) also make use of {@link CF12RuleRecord}
|
||||
* and {@link CFExRuleRecord} for their rules.
|
||||
*/
|
||||
public final class CFRuleRecord extends StandardRecord {
|
||||
|
||||
public static final short sid = 0x01B1;
|
||||
|
||||
public static final class ComparisonOperator {
|
||||
|
|
|
@ -72,9 +72,6 @@ import org.apache.poi.ss.util.CellRangeAddress;
|
|||
* // Apply Conditional Formatting rule defined above to the regions
|
||||
* sheet.addConditionalFormatting(regions, rule);
|
||||
* </PRE>
|
||||
*
|
||||
* @author Dmitriy Kumshayev
|
||||
* @author Yegor Kozlov
|
||||
*/
|
||||
public interface ConditionalFormatting {
|
||||
|
||||
|
@ -85,17 +82,18 @@ public interface ConditionalFormatting {
|
|||
|
||||
/**
|
||||
* Replaces an existing Conditional Formatting rule at position idx.
|
||||
* Excel allows to create up to 3 Conditional Formatting rules.
|
||||
* Excel pre-2007 allows to create up to 3 Conditional Formatting rules,
|
||||
* 2007 and later allow unlimited numbers.
|
||||
* This method can be useful to modify existing Conditional Formatting rules.
|
||||
*
|
||||
* @param idx position of the rule. Should be between 0 and 2.
|
||||
* @param idx position of the rule. Should be between 0 and 2 for Excel before 2007, otherwise 0+.
|
||||
* @param cfRule - Conditional Formatting rule
|
||||
*/
|
||||
void setRule(int idx, ConditionalFormattingRule cfRule);
|
||||
|
||||
/**
|
||||
* Add a Conditional Formatting rule.
|
||||
* Excel allows to create up to 3 Conditional Formatting rules.
|
||||
* Excel pre-2007 allows to create up to 3 Conditional Formatting rules.
|
||||
*
|
||||
* @param cfRule - Conditional Formatting rule
|
||||
*/
|
||||
|
@ -110,6 +108,4 @@ public interface ConditionalFormatting {
|
|||
* @return number of Conditional Formatting rules.
|
||||
*/
|
||||
int getNumberOfRules();
|
||||
|
||||
|
||||
}
|
||||
|
|
|
@ -21,9 +21,6 @@ package org.apache.poi.ss.usermodel;
|
|||
|
||||
/**
|
||||
* Represents a description of a conditional formatting rule
|
||||
*
|
||||
* @author Dmitriy Kumshayev
|
||||
* @author Yegor Kozlov
|
||||
*/
|
||||
public interface ConditionalFormattingRule {
|
||||
/**
|
||||
|
|
|
@ -24,12 +24,9 @@ import org.apache.poi.ss.util.CellRangeAddress;
|
|||
/**
|
||||
* The 'Conditional Formatting' facet of <tt>Sheet</tt>
|
||||
*
|
||||
* @author Dmitriy Kumshayev
|
||||
* @author Yegor Kozlov
|
||||
* @since 3.8
|
||||
*/
|
||||
public interface SheetConditionalFormatting {
|
||||
|
||||
/**
|
||||
* Add a new Conditional Formatting to the sheet.
|
||||
*
|
||||
|
@ -58,7 +55,7 @@ public interface SheetConditionalFormatting {
|
|||
* Add a new Conditional Formatting set to the sheet.
|
||||
*
|
||||
* @param regions - list of rectangular regions to apply conditional formatting rules
|
||||
* @param cfRules - set of up to three conditional formatting rules
|
||||
* @param cfRules - set of up to conditional formatting rules (max 3 for Excel pre-2007)
|
||||
*
|
||||
* @return index of the newly created Conditional Formatting object
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue