Top Description Fields Constructors Methods
org.apache.poi.ss.util

public Class PaneInformation

extends Object
Class Inheritance
Imports
org.apache.poi.ss.usermodel.PaneType, java.util.Objects
Holds information regarding a split plane or freeze plane for a sheet.

Field Summary

Modifier and TypeField and Description
private final byte
activePane

private final boolean
frozen

private final short
leftColumn

public static final byte
PANE_LOWER_LEFT

Constant for active pane being the lower left

public static final byte
PANE_LOWER_RIGHT

Constant for active pane being the lower right

public static final byte
PANE_UPPER_LEFT

Constant for active pane being the upper left

public static final byte
PANE_UPPER_RIGHT

Constant for active pane being the upper right

private final short
topRow

private final short
x

private final short
y

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public byte

Returns:

the active pane.
getActivePane()

Returns the active pane.

public PaneType

Returns:

the active pane type - can return null if no active pane type is set
getActivePaneType()

public short

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.
getHorizontalSplitPosition()

Returns the horizontal position of the split.

public short

Returns:

0 if there is no horizontal split, or the top row of the bottom pane.
getHorizontalSplitTopRow()

For a horizontal split returns the top row in the BOTTOM pane.

public short

Returns:

0 if there is no vertical split, or the left column in the RIGHT pane.
getVerticalSplitLeftColumn()

For a vertical split returns the left column in the RIGHT pane.

public short

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.
getVerticalSplitPosition()

Returns the vertical position of the split.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isFreezePane()

Returns true if this is a Freeze pane, false if it is a split pane.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

activePaneback to summary
private final byte activePane
frozenback to summary
private final boolean frozen
leftColumnback to summary
private final short leftColumn
PANE_LOWER_LEFTback to summary
public static final byte PANE_LOWER_LEFT

Constant for active pane being the lower left

PANE_LOWER_RIGHTback to summary
public static final byte PANE_LOWER_RIGHT

Constant for active pane being the lower right

PANE_UPPER_LEFTback to summary
public static final byte PANE_UPPER_LEFT

Constant for active pane being the upper left

PANE_UPPER_RIGHTback to summary
public static final byte PANE_UPPER_RIGHT

Constant for active pane being the upper right

topRowback to summary
private final short topRow
xback to summary
private final short x
yback to summary
private final short y

Constructor Detail

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

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getActivePaneback to summary
public byte getActivePane()

Returns the active pane.

Returns:byte

the active pane.

See Also
PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
getActivePaneTypeback to summary
public PaneType getActivePaneType()
Returns:PaneType

the active pane type - can return null if no active pane type is set

Since
POI 5.2.3
getHorizontalSplitPositionback to summary
public short getHorizontalSplitPosition()

Returns the horizontal position of the split.

Returns:short

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.

getHorizontalSplitTopRowback to summary
public short getHorizontalSplitTopRow()

For a horizontal split returns the top row in the BOTTOM pane.

Returns:short

0 if there is no horizontal split, or the top row of the bottom pane.

getVerticalSplitLeftColumnback to summary
public short getVerticalSplitLeftColumn()

For a vertical split returns the left column in the RIGHT pane.

Returns:short

0 if there is no vertical split, or the left column in the RIGHT pane.

getVerticalSplitPositionback to summary
public short getVerticalSplitPosition()

Returns the vertical position of the split.

Returns:short

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.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isFreezePaneback to summary
public boolean isFreezePane()

Returns true if this is a Freeze pane, false if it is a split pane.