IPane

Interface IPane

---

public interface IPane

表示工作表窗格。

IPane 提供对工作表视图中窗格的滚动位置和激活状态的访问。可以通过调用 IWorksheet.getActivePane() 从活动窗格获取 IPane，也可以从 IWorksheet.getPanes() 返回的窗格集合获取。

 worksheet.splitPanes(2, 2);
 IPane pane = worksheet.getActivePane();
 pane.setScrollRow(3);
 pane.setScrollColumn(2);
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  boolean

  activate()

  激活此窗格。

  int

  getIndex()

  获取此窗格在工作表窗格集合中的索引。

  int

  getScrollColumn()

  获取窗格或工作表中最左侧可见列的索引。

  int

  getScrollRow()

  获取显示在窗格或工作表顶部的行号。

  void

  setScrollColumn(int value)

  设置窗格或工作表中最左侧可见列的索引。

  void

  setScrollRow(int value)

  设置显示在窗格或工作表顶部的行号。

• Method Details

  • activate

    boolean activate()

    激活此窗格。

    不能激活冻结窗格。

    
     worksheet.splitPanes(2, 2);
     IPane pane = worksheet.getPanes().get(0);
     boolean activated = pane.activate();
     

    Returns:

    如果窗格已激活，则为 true。

    Throws:

    IllegalStateException - 如果此窗格无法激活。

  • getIndex

    int getIndex()

    获取此窗格在工作表窗格集合中的索引。

    此索引用于标识该窗格在 IWorksheet.getPanes() 集合中的位置。

    
     worksheet.splitPanes(2, 2);
     IPane pane = worksheet.getPanes().get(0);
     int index = pane.getIndex();
     

    Returns:

    此窗格在窗格集合中的从零开始的索引。

  • getScrollColumn

    int getScrollColumn()

    获取窗格或工作表中最左侧可见列的索引。

    使用此方法可以确定拆分窗格的当前水平滚动位置。

    
     worksheet.splitPanes(2, 2);
     IPane pane = worksheet.getPanes().get(0);
     pane.setScrollColumn(3);
     int scrollColumn = pane.getScrollColumn();
     

    Returns:

    窗格或工作表中最左侧可见列的索引。

  • setScrollColumn

    void setScrollColumn(int value)

    设置窗格或工作表中最左侧可见列的索引。

    使用此方法可设置拆分窗格的水平滚动位置。

    
     worksheet.splitPanes(2, 2);
     IPane pane = worksheet.getPanes().get(0);
     pane.setScrollColumn(3);
     

    Parameters:

    value - 窗格或工作表中最左侧可见列的索引。

  • getScrollRow

    int getScrollRow()

    获取显示在窗格或工作表顶部的行号。

    工作表被拆分或滚动后，使用此方法可以确定窗格的当前垂直滚动位置。

    
     worksheet.splitPanes(2, 2);
     IPane pane = worksheet.getPanes().get(0);
     pane.setScrollRow(5);
     int scrollRow = pane.getScrollRow();
     

    Returns:

    当前显示在窗格或工作表顶部的行号。

  • setScrollRow

    void setScrollRow(int value)

    设置显示在窗格或工作表顶部的行号。

    工作表被拆分或滚动后，使用此方法可设置窗格的垂直滚动位置。

    
     worksheet.splitPanes(2, 2);
     IPane pane = worksheet.getPanes().get(0);
     pane.setScrollRow(5);
     

    Parameters:

    value - 当前显示在窗格或工作表顶部的行号。