com.aspose.cells

Class ConditionalFormattingIconCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.ConditionalFormattingIconCollection

All Implemented Interfaces:

java.lang.Iterable

public class ConditionalFormattingIconCollection
extends CollectionBase

Represents a collection of ConditionalFormattingIcon objects.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         Worksheet sheet = workbook.getWorksheets().get(0);
 
         //Get Conditional Formatting
         ConditionalFormattingCollection cformattings = sheet.getConditionalFormattings();
 
         //Adds an empty conditional formatting
         int index = cformattings.add();
 
         //Get newly added Conditional formatting
         FormatConditionCollection fcs = cformattings.get(index);
 
         //Sets the conditional format range.
         CellArea ca = new CellArea();
 
         ca.StartRow = 0;
 
         ca.EndRow = 0;
 
         ca.StartColumn = 0;
 
         ca.EndColumn = 0;
 
         fcs.addArea(ca);
 
         ca = new CellArea();
 
         ca.StartRow = 1;
 
         ca.EndRow = 1;
 
         ca.StartColumn = 1;
 
         ca.EndColumn = 1;
 
         fcs.addArea(ca);
 
         //Sets condition
          int idx = fcs.addCondition(FormatConditionType.ICON_SET);
 
          FormatCondition cond = fcs.get(idx);
 
          //Sets condition's type
          cond.getIconSet().setType(IconSetType.ARROWS_GRAY_3);
 
         //Add custom iconset condition.
          ConditionalFormattingIcon cfIcon = cond.getIconSet().getCfIcons().get(0);
 
          cfIcon.setType(IconSetType.ARROWS_3);
 
          cfIcon.setIndex(0);
 
          ConditionalFormattingIcon cfIcon1 = cond.getIconSet().getCfIcons().get(1);
 
           cfIcon1.setType(IconSetType.ARROWS_GRAY_3);
 
           cfIcon1.setIndex(1);
 
           ConditionalFormattingIcon cfIcon2 = cond.getIconSet().getCfIcons().get(2);
 
           cfIcon2.setType(IconSetType.BOXES_5);
 
           cfIcon2.setIndex(2);
 
         //Saving the Excel file
         workbook.save("output.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(ConditionalFormattingIcon cficon) Adds ConditionalFormattingIcon object.
int	add(int type, int index) Adds ConditionalFormattingIcon object.
ConditionalFormattingIcon	get(int index) Gets the ConditionalFormattingIcon element at the specified index.

Methods inherited from class com.aspose.cells.CollectionBase

add, clear, contains, getCount, indexOf, iterator, removeAt

Methods inherited from class java.lang.Object

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

Method Detail

get

public ConditionalFormattingIcon get(int index)

Gets the ConditionalFormattingIcon element at the specified index.

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

add

public int add(int type,
      int index)

Adds ConditionalFormattingIcon object.

Parameters:

type - IconSetType. The value type.

index - The Index.

Returns:

Returns the index of new object in the list.

add

public int add(ConditionalFormattingIcon cficon)

Adds ConditionalFormattingIcon object.

Parameters:

cficon - Returns the index of new object in the list.