FileDocCategorySizeDatePackage
PaneInformation.javaAPI DocApache Poi 3.0.13372Mon Jan 01 12:39:36 GMT 2007org.apache.poi.hssf.util

PaneInformation

public class PaneInformation extends Object
Holds information regarding a split plane or freeze plane for a sheet.

Fields Summary
public static final byte
PANE_LOWER_RIGHT
Constant for active pane being the lower right
public static final byte
PANE_UPPER_RIGHT
Constant for active pane being the upper right
public static final byte
PANE_LOWER_LEFT
Constant for active pane being the lower left
public static final byte
PANE_UPPER_LEFT
Constant for active pane being the upper left
private short
x
private short
y
private short
topRow
private short
leftColumn
private byte
activePane
private boolean
frozen
Constructors Summary
public PaneInformation(short x, short y, short top, short left, byte active, boolean frozen)

	
	             
		this.x = x;
		this.y = y;
		this.topRow = top;
		this.leftColumn = left;
		this.activePane = active;
		this.frozen = frozen;
	
Methods Summary
public bytegetActivePane()
Returns the active pane

see
PANE_LOWER_RIGHT
see
PANE_UPPER_RIGHT
see
PANE_LOWER_LEFT
see
PANE_UPPER_LEFT
return
the active pane.

	  return activePane;
	
public shortgetHorizontalSplitPosition()
Returns the horizontal position of the split.

return
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.

	  return y;
	
public shortgetHorizontalSplitTopRow()
For a horizontal split returns the top row in the BOTTOM pane.

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

	  return topRow;
	
public shortgetVerticalSplitLeftColumn()
For a vertical split returns the left column in the RIGHT pane.

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

	  return leftColumn;
	
public shortgetVerticalSplitPosition()
Returns the vertical position of the split.

return
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.

	  return x;
	
public booleanisFreezePane()
Returns true if this is a Freeze pane, false if it is a split pane.

		return frozen;