IGroupInfo

Interface IGroupInfo

---

public interface IGroupInfo

表示工作表大纲组的信息。

IGroupInfo 对象描述工作表大纲中的分组行或列区域。从 IOutline.getRowGroupInfo() 或 IOutline.getColumnGroupInfo() 获取组后，可以使用它检查组的边界和层次结构，或者展开和折叠该组。

 worksheet.getRange("1:4").group();
 IGroupInfo group = worksheet.getOutline().getRowGroupInfo().get(0);
 int startIndex = group.getStartIndex();
 int endIndex = group.getEndIndex();
 group.collapse();
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  void

  collapse()

  折叠当前组。

  void

  expand()

  展开当前组。

  List<IGroupInfo>

  getChildren()

  获取当前组的子组。

  int

  getEndIndex()

  获取当前组的结束索引。

  boolean

  getIsCollapsed()

  获取当前组是否已折叠。

  int

  getLevel()

  获取当前组的大纲级别。

  IGroupInfo

  getParent()

  获取当前组的父组。

  int

  getStartIndex()

  获取当前组的起始索引。

• Method Details

  • expand

    void expand()

    展开当前组。

    当前大纲组折叠后，此方法会重新显示其中的行或列。如果该组有已折叠的父组，则此方法会清除当前组的折叠状态，但分组的行或列会保持隐藏，直到父组展开。

    
     worksheet.getRange("2:5").group();
     IGroupInfo group = worksheet.getOutline().getRowGroupInfo().get(0);
     group.collapse();
     group.expand();
     

  • collapse

    void collapse()

    折叠当前组。

    此方法会隐藏当前大纲组中的行或列，并将该组标记为已折叠。如果该组已折叠，则此方法不执行任何操作。使用 getIsCollapsed() 可确定当前折叠状态，或使用 expand() 重新显示分组的行或列。

    
     worksheet.getRange("2:5").group();
     IGroupInfo group = worksheet.getOutline().getRowGroupInfo().get(0);
     group.collapse();
     

  • getStartIndex

    int getStartIndex()

    获取当前组的起始索引。

    将此方法与 getEndIndex() 一起使用，可确定该组覆盖的行或列区域。

    
     worksheet.getRange("2:5").group();
     IGroupInfo group = worksheet.getOutline().getRowGroupInfo().get(0);
     int startIndex = group.getStartIndex();
     

    Returns:

    当前组的起始索引。

  • getEndIndex

    int getEndIndex()

    获取当前组的结束索引。

    返回值标识此组包含的最后一个行索引或列索引，具体取决于该组属于行大纲信息还是列大纲信息。

    
     worksheet.getRange("2:5").group();
     IGroupInfo group = worksheet.getOutline().getRowGroupInfo().get(0);
     int endIndex = group.getEndIndex();
     

    Returns:

    当前组的结束索引。

  • getLevel

    int getLevel()

    获取当前组的大纲级别。

    返回值指示该组在工作表大纲中的嵌套深度。较大的值表示组嵌套在父组内部更深的位置。

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

    Returns:

    当前组的大纲级别。

  • getIsCollapsed

    boolean getIsCollapsed()

    获取当前组是否已折叠。

    使用此属性可确定组中的行或列当前是否因组已折叠而隐藏。

    
     worksheet.getRange("2:5").group();
     IGroupInfo group = worksheet.getOutline().getRowGroupInfo().get(0);
     group.collapse();
     boolean isCollapsed = group.getIsCollapsed();
     

    Returns:

    如果当前组已折叠，则为 true；否则为 false。

  • getParent

    IGroupInfo getParent()

    获取当前组的父组。

    使用此方法可从嵌套组导航到包含它的父组。

    
     worksheet.getRange("2:8").group();
     worksheet.getRange("3:5").group();
     IGroupInfo parentGroup = worksheet.getOutline().getRowGroupInfo().get(0);
     IGroupInfo childGroup = parentGroup.getChildren().get(0);
     IGroupInfo group = childGroup.getParent();
     

    Returns:

    父组。

  • getChildren

    List<IGroupInfo> getChildren()

    获取当前组的子组。

    子组是区域包含在当前组内的嵌套大纲组。从 IOutline.getRowGroupInfo() 或 IOutline.getColumnGroupInfo() 获取组后，使用此方法可遍历大纲层次结构。

    
     worksheet.getRange("1:4").group();
     worksheet.getRange("2:3").group();
     IGroupInfo group = worksheet.getOutline().getRowGroupInfo().get(0);
     List<IGroupInfo> children = group.getChildren();
     

    Returns:

    包含当前组子组的列表。如果当前组没有子组，则返回 null。