IconSortField

Class IconSortField

java.lang.Object

com.grapecity.documents.excel.SortFieldBase

com.grapecity.documents.excel.IconSortField

All Implemented Interfaces:

IIconSortField, ISortField

---

public class IconSortField extends SortFieldBase implements IIconSortField

表示按指定条件格式图标对数据排序的排序字段。

使用此类可以向工作表或表排序添加基于图标的排序条件。排序键标识要评估其显示图标的单元格，目标 IIcon 指定根据给定 SortOrder 排序的图标。

 worksheet.getRange("A1:B4").setValue(new Object[][] {
     {"Name", "Score"},
     {"A", 90},
     {"B", 70},
     {"C", 50}
 });
 IIconSetCondition iconSet = worksheet.getRange("B2:B4").getFormatConditions().addIconSetCondition();
 iconSet.setIconSet(workbook.getIconSets().get(IconSetType.Icon3TrafficLights1));
 IconSortField sortField = new IconSortField(
     worksheet.getRange("B2:B4"),
     workbook.getIconSets().get(IconSetType.Icon3TrafficLights1).get(2),
     SortOrder.Ascending);
 worksheet.getSort().getSortFields().add(sortField);
 

• Constructor Summary

  Constructors

  Constructor

  Description

  IconSortField(IRange key, IIcon icon)

  按图标排序。

  IconSortField(IRange key, IIcon icon, SortOrder order)

  创建一个按指定条件格式图标对区域排序的排序字段。

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  final IIcon

  getIcon()

  获取用于排序的 IIcon 对象。

  final SortOrder

  getOrder()

  获取排序顺序。

  Methods inherited from class com.grapecity.documents.excel.SortFieldBase

  getKey, getPriority, getSortOn, setPriority

  Methods inherited from class java.lang.Object

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

  Methods inherited from interface com.grapecity.documents.excel.ISortField

  getKey, getPriority, getSortOn, setPriority

• Constructor Details

  • IconSortField

    public IconSortField(IRange key, IIcon icon)

    按图标排序。

    此构造函数转发到 IconSortField(IRange,IIcon,SortOrder)，并使用 SortOrder.Ascending。

    
     worksheet.getRange("A1:B4").setValue(new Object[][] {
         {"A", 2}, {"B", 1}, {"C", 1}, {"D", 3}
     });
     IIconSetCondition iconSet = worksheet.getRange("B1:B4").getFormatConditions().addIconSetCondition();
     iconSet.setIconSet(workbook.getIconSets().get(IconSetType.Icon3TrafficLights1));
     IconSortField sortField = new IconSortField(
         worksheet.getRange("B1:B4"),
         workbook.getIconSets().get(IconSetType.Icon3TrafficLights1).get(0));
     worksheet.getSort().getSortFields().add(sortField);
     

    Parameters:

    key - 用作排序键的区域。

    icon - 要作为排序依据的图标。不得为 null。

  • IconSortField

    public IconSortField(IRange key, IIcon icon, SortOrder order)

    创建一个按指定条件格式图标对区域排序的排序字段。

    使用此构造函数可以为指定排序键区域定义基于图标的排序条件。key 标识要评估其显示图标的单元格，icon 指定排序所依据的图标，order 确定匹配图标按升序还是降序排序。

    
     worksheet.getRange("A1:B4").setValue(new Object[][] {
         {"Name", "Score"},
         {"A", 90},
         {"B", 70},
         {"C", 50}
     });
     IIconSetCondition iconSet = worksheet.getRange("B2:B4").getFormatConditions().addIconSetCondition();
     iconSet.setIconSet(workbook.getIconSets().get(IconSetType.Icon3TrafficLights1));
     IconSortField sortField = new IconSortField(
         worksheet.getRange("B2:B4"),
         workbook.getIconSets().get(IconSetType.Icon3TrafficLights1).get(2),
         SortOrder.Ascending);
     

    Parameters:

    key - 用作排序键的区域。其显示的条件格式图标用于排序。

    icon - 用作排序条件的图标。

    order - 应用于基于图标的排序字段的排序顺序。

• Method Details

  • getOrder

    public final SortOrder getOrder()

    获取排序顺序。

    返回 SortOrder，该值确定匹配图标按升序还是降序排序。

    
     worksheet.getRange("A1:A4").setValue(new Object[] {3, 1, 4, 2});
     IIcon icon = workbook.getIconSets().get(IconSetType.Icon3TrafficLights1).get(0);
     IconSortField sortField = new IconSortField(worksheet.getRange("A1:A4"), icon, SortOrder.Descending);
     SortOrder order = sortField.getOrder();
     

    Specified by:

    getOrder in interface IIconSortField

    Returns:

    此图标排序字段的排序顺序。

  • getIcon

    public final IIcon getIcon()

    获取用于排序的 IIcon 对象。

    使用此方法可以检索与当前图标排序字段关联的图标条件。

    
     IIcon icon = workbook.getIconSets().get(IconSetType.Icon3Arrows).get(0);
     IconSortField sortField = new IconSortField(worksheet.getRange("A2:A4"), icon);
     IIcon sortIcon = sortField.getIcon();
     

    Specified by:

    getIcon in interface IIconSortField

    Returns:

    用于排序的 IIcon 对象。