com.aspose.cells

Class IconSet

java.lang.Object

com.aspose.cells.IconSet

public class IconSet
extends java.lang.Object

Describe the IconSet conditional formatting rule. This conditional formatting rule applies icons to cells according to their values.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         Worksheet sheet = workbook.getWorksheets().get(0);
 
         //Adds an empty conditional formatting
         int index = sheet.getConditionalFormattings().add();
 
         FormatConditionCollection fcs = sheet.getConditionalFormattings().get(index);
 
         //Sets the conditional format range.
         CellArea ca = new CellArea();
 
         ca.StartRow = 0;
 
         ca.EndRow = 2;
 
         ca.StartColumn = 0;
 
         ca.EndColumn = 0;
 
         fcs.addArea(ca);
 
         //Adds condition.
         int idx = fcs.addCondition(FormatConditionType.ICON_SET);
 
         fcs.addArea(ca);
 
         FormatCondition cond = fcs.get(idx);
 
         //Get Icon Set
         IconSet iconSet = cond.getIconSet();
 
         //Set Icon Type
         iconSet.setType(IconSetType.ARROWS_3);
 
         //Put Cell Values
         Cell cell1 = sheet.getCells().get("A1");
 
         cell1.putValue(10);
 
         Cell cell2 = sheet.getCells().get("A2");
 
         cell2.putValue(120);
 
         Cell cell3 = sheet.getCells().get("A3");
 
         cell3.putValue(260);
 
         //Saving the Excel file
         workbook.save("book1.xlsx");
 

Method Summary

Methods

Modifier and Type	Method and Description
ConditionalFormattingIconCollection	getCfIcons() Get theConditionalFormattingIcon from the collection
ConditionalFormattingValueCollection	getCfvos() Get the CFValueObjects instance.
boolean	getReverse() Gets the flag indicating whether to reverses the default order of the icons in this icon set.
boolean	getShowValue() Gets the flag indicating whether to show the values of the cells on which this icon set is applied.
int	getType() Gets the icon set type to display.
boolean	isCustom() Indicates whether the icon set is custom.
void	setReverse(boolean value) Sets the flag indicating whether to reverses the default order of the icons in this icon set.
void	setShowValue(boolean value) Sets the flag indicating whether to show the values of the cells on which this icon set is applied.
void	setType(int value) Sets the icon set type to display.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCfIcons

public ConditionalFormattingIconCollection getCfIcons()

Get theConditionalFormattingIcon from the collection

getCfvos

public ConditionalFormattingValueCollection getCfvos()

Get the CFValueObjects instance.

getType

public int getType()

Gets the icon set type to display. Setting the type will auto check if the current Cfvos's count is accord with the new type. If not accord, old Cfvos will be cleaned and default Cfvos will be added.

See IconSetType.

setType

public void setType(int value)

Sets the icon set type to display. Setting the type will auto check if the current Cfvos's count is accord with the new type. If not accord, old Cfvos will be cleaned and default Cfvos will be added.

See IconSetType.

isCustom

public boolean isCustom()

Indicates whether the icon set is custom. Default value is false.

getShowValue

public boolean getShowValue()

Gets the flag indicating whether to show the values of the cells on which this icon set is applied. Default value is true.

setShowValue

public void setShowValue(boolean value)

Sets the flag indicating whether to show the values of the cells on which this icon set is applied. Default value is true.

getReverse

public boolean getReverse()

Gets the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false.

setReverse

public void setReverse(boolean value)

Sets the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false.