IOutline

Interface IOutline

---

public interface IOutline

表示工作表上的大纲。

IOutline 对象提供对工作表大纲设置的访问，例如汇总行和汇总列的位置、可见的大纲级别，以及已分组的行或列信息。

 worksheet.getRange("2:5").group();
 IOutline outline = worksheet.getOutline();
 outline.setSummaryRow(SummaryRow.Above);
 outline.showLevels(1, 0);
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  List<IGroupInfo>

  getColumnGroupInfo()

  获取列方向上所有组的信息。

  List<IGroupInfo>

  getRowGroupInfo()

  获取行方向上所有组的信息。

  SummaryColumn

  getSummaryColumn()

  获取大纲中汇总列的位置。

  SummaryRow

  getSummaryRow()

  获取大纲中汇总行的位置。

  void

  setSummaryColumn(SummaryColumn value)

  设置大纲中汇总列的位置。

  void

  setSummaryRow(SummaryRow value)

  设置大纲中汇总行的位置。

  void

  showLevels()

  显示大纲的默认行级别和列级别。

  void

  showLevels(int rowLevels, int columnLevels)

  在工作表大纲中显示指定数量的行级别和列级别。

• Method Details

  • getSummaryColumn

    SummaryColumn getSummaryColumn()

    获取大纲中汇总列的位置。

    使用此方法可以确定在列大纲中，汇总列显示在明细列左侧还是右侧。

    
     worksheet.getRange("A:C").group();
     IOutline outline = worksheet.getOutline();
     outline.setSummaryColumn(SummaryColumn.Left);
     SummaryColumn summaryColumn = outline.getSummaryColumn();
     

    Returns:

    大纲中汇总列的位置。 使用此方法可以确定在列大纲中，汇总列显示在明细列左侧还是右侧。

  • setSummaryColumn

    void setSummaryColumn(SummaryColumn value)

    设置大纲中汇总列的位置。

    使用此方法可以控制在列大纲中，汇总列显示在明细列左侧还是右侧。

    
     worksheet.getRange("A:C").group();
     IOutline outline = worksheet.getOutline();
     outline.setSummaryColumn(SummaryColumn.Left);
     

    Parameters:

    value - 汇总列位置。不得为 null。

  • getSummaryRow

    SummaryRow getSummaryRow()

    获取大纲中汇总行的位置。

    使用此方法可以确定工作表大纲中分组数据的汇总行显示在明细行上方还是下方。

    
     worksheet.getRange("2:5").group();
     IOutline outline = worksheet.getOutline();
     outline.setSummaryRow(SummaryRow.Above);
     SummaryRow summaryRow = outline.getSummaryRow();
     

    Returns:

    大纲中汇总行的位置。 使用此方法可以确定工作表大纲中分组数据的汇总行显示在明细行上方还是下方。

  • setSummaryRow

    void setSummaryRow(SummaryRow value)

    设置大纲中汇总行的位置。

    使用此方法可以控制分组数据的汇总行显示在明细行上方还是下方。将此属性设置为 SummaryRow.Above可将汇总行置于分组行上方，设置为 SummaryRow.Below 可将其置于分组行下方。

    
     worksheet.getRange("2:5").group();
     IOutline outline = worksheet.getOutline();
     outline.setSummaryRow(SummaryRow.Above);
     

    Parameters:

    value - 汇总行位置。

  • showLevels

    void showLevels()

    显示大纲的默认行级别和列级别。

    此重载使用默认行级别和列级别值调用 showLevels(int,int)。当希望使用实现的默认大纲级别行为时，可将其作为便捷重载；也可以调用 showLevels(int,int) 来指定明确的行级别和列级别。

    
     worksheet.getRange("2:5").group();
     worksheet.getRange("A:C").group();
     IOutline outline = worksheet.getOutline();
     outline.showLevels();
     

  • showLevels

    void showLevels(int rowLevels, int columnLevels)

    在工作表大纲中显示指定数量的行级别和列级别。

    使用此方法可以控制行和列可见的分组级别数量。如果大纲包含的级别少于指定值，则显示所有可用级别。0 值会使对应方向保持不变。

    
     worksheet.getRange("2:5").group();
     worksheet.getRange("B:D").group();
     IOutline outline = worksheet.getOutline();
     outline.showLevels(1, 1);
     

    Parameters:

    rowLevels - 要显示的行大纲级别数。如果此值大于可用行级别数，则显示所有行级别。如果此值为 0，则不更改行大纲级别。

    columnLevels - 要显示的列大纲级别数。如果此值大于可用列级别数，则显示所有列级别。如果此值为 0，则不更改列大纲级别。

  • getRowGroupInfo

    List<IGroupInfo> getRowGroupInfo()

    获取行方向上所有组的信息。

    返回工作表大纲中的顶级行组。可以从每个返回的 IGroupInfo 的子组访问嵌套行组。

    
     worksheet.getRange("1:4").group();
     worksheet.getRange("2:3").group();
     List<IGroupInfo> groups = worksheet.getOutline().getRowGroupInfo();
     IGroupInfo group = groups.get(0);
     int level = group.getLevel();
     

    Returns:

    行方向上所有组的信息。 返回工作表大纲中的顶级行组。可以从每个返回的 的子组访问嵌套行组。

  • getColumnGroupInfo

    List<IGroupInfo> getColumnGroupInfo()

    获取列方向上所有组的信息。

    使用此方法可以检索工作表大纲中的列分组结构。返回的每个 IGroupInfo 都描述一个已分组的列区域，并可用于检查组层次结构或展开和折叠组。

    
     worksheet.getRange("A:D").group();
     worksheet.getRange("A:B").group();
     IOutline outline = worksheet.getOutline();
     java.util.List<IGroupInfo> groups = outline.getColumnGroupInfo();
     IGroupInfo firstGroup = groups.get(0);
     

    Returns:

    列方向上所有组的信息。 使用此方法可以检索工作表大纲中的列分组结构。返回的每个 都描述一个已分组的列区域，并可用于检查组层次结构或展开和折叠组。