org.apache.poi.ss.util

Class PaneInformation

java.lang.Object

org.apache.poi.ss.util.PaneInformation

public class PaneInformation
extends java.lang.Object

Holds information regarding a split plane or freeze plane for a sheet. (保存有关图纸的分割平面或冻结平面的信息。)

Field Summary

Fields

Modifier and Type	Field and Description
static byte	PANE_LOWER_LEFT Constant for active pane being the lower left (活动窗格的常量位于左下方)
static byte	PANE_LOWER_RIGHT Constant for active pane being the lower right (活动窗格的常量位于右下角)
static byte	PANE_UPPER_LEFT Constant for active pane being the upper left (活动窗格的常量为左上角)
static byte	PANE_UPPER_RIGHT Constant for active pane being the upper right (活动窗格的常量为右上角)

Constructor Summary

Constructors

Constructor and Description
PaneInformation(short x, short y, short top, short left, byte active, boolean frozen)

Method Summary

Modifier and Type	Method and Description
byte	getActivePane() Returns the active pane (返回活动窗格)
short	getHorizontalSplitPosition() Returns the horizontal position of the split. (返回拆分的水平位置。)
short	getHorizontalSplitTopRow() For a horizontal split returns the top row in the BOTTOM pane. (对于水平拆分，返回底部窗格中的第一行。)
short	getVerticalSplitLeftColumn() For a vertical split returns the left column in the RIGHT pane. (对于垂直拆分，返回右窗格中的左列。)
short	getVerticalSplitPosition() Returns the vertical position of the split. (返回拆分的垂直位置。)
boolean	isFreezePane() Returns true if this is a Freeze pane, false if it is a split pane. (如果这是冻结窗格，则返回 true，如果是拆分窗格，则返回 false。)

Methods inherited from class java.lang.Object

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

Field Detail

PANE_LOWER_RIGHT

public static final byte PANE_LOWER_RIGHT

Constant for active pane being the lower right (活动窗格的常量位于右下角)

See Also:

Constant Field Values

PANE_UPPER_RIGHT

public static final byte PANE_UPPER_RIGHT

Constant for active pane being the upper right (活动窗格的常量为右上角)

See Also:

Constant Field Values

PANE_LOWER_LEFT

public static final byte PANE_LOWER_LEFT

Constant for active pane being the lower left (活动窗格的常量位于左下方)

See Also:

Constant Field Values

PANE_UPPER_LEFT

public static final byte PANE_UPPER_LEFT

Constant for active pane being the upper left (活动窗格的常量为左上角)

See Also:

Constant Field Values

Constructor Detail

PaneInformation

public PaneInformation(short x,
                       short y,
                       short top,
                       short left,
                       byte active,
                       boolean frozen)

Method Detail

getVerticalSplitPosition

public short getVerticalSplitPosition()

Returns the vertical position of the split. (返回拆分的垂直位置。)

Returns:

0 if there is no vertical spilt, or for a freeze pane the number of columns in the TOP pane, or for a split plane the position of the split in 1/20th of a point. (如果没有垂直拆分，则为 0，或者对于冻结窗格，TOP 窗格中的列数，或者对于拆分平面，拆分的位置为点的 1/20。)

getHorizontalSplitPosition

public short getHorizontalSplitPosition()

Returns the horizontal position of the split. (返回拆分的水平位置。)

Returns:

0 if there is no horizontal spilt, or for a freeze pane the number of rows in the LEFT pane, or for a split plane the position of the split in 1/20th of a point. (如果没有水平分割，则为 0，或者对于冻结窗格，左窗格中的行数，或者对于分割平面，分割的位置在点的 1/20 处。)

getHorizontalSplitTopRow

public short getHorizontalSplitTopRow()

For a horizontal split returns the top row in the BOTTOM pane. (对于水平拆分，返回底部窗格中的第一行。)

Returns:

0 if there is no horizontal split, or the top row of the bottom pane. (0 如果没有水平分割，或者底部窗格的顶行。)

getVerticalSplitLeftColumn

public short getVerticalSplitLeftColumn()

For a vertical split returns the left column in the RIGHT pane. (对于垂直拆分，返回右窗格中的左列。)

Returns:

0 if there is no vertical split, or the left column in the RIGHT pane. (0 如果没有垂直拆分，或者 RIGHT 窗格中的左列。)

getActivePane

public byte getActivePane()

Returns the active pane (返回活动窗格)

Returns:

the active pane. (活动窗格。)

See Also:

PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT

isFreezePane

public boolean isFreezePane()

Returns true if this is a Freeze pane, false if it is a split pane. (如果这是冻结窗格，则返回 true，如果是拆分窗格，则返回 false。)