FileDocCategorySizeDatePackage
Area3DPtg.javaAPI DocApache Poi 3.0.18878Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record.formula

Area3DPtg

public class Area3DPtg extends Ptg
Title: Area 3D Ptg - 3D referecnce (Sheet + Area)

Description: Defined a area in Extern Sheet.

REFERENCE:

author
Libin Roman (Vista Portal LDT. Developer)
author
avik
author
Jason Height (jheight at chariot dot net dot au)
version
1.0-pre

Fields Summary
public static final byte
sid
private static final int
SIZE
private short
field_1_index_extern_sheet
private short
field_2_first_row
private short
field_3_last_row
private short
field_4_first_column
private short
field_5_last_column
private BitField
rowRelative
private BitField
colRelative
Constructors Summary
public Area3DPtg()
Creates new AreaPtg


	    
	 
	
	
public Area3DPtg(String arearef, short externIdx)

		setArea(arearef);
		setExternSheetIndex( externIdx );

	
public Area3DPtg(RecordInputStream in)

		field_1_index_extern_sheet = in.readShort();
		field_2_first_row = in.readShort();
		field_3_last_row = in.readShort();
		field_4_first_column = in.readShort();
		field_5_last_column = in.readShort();
	
Methods Summary
public java.lang.Objectclone()

		Area3DPtg ptg = new Area3DPtg();
		ptg.field_1_index_extern_sheet = field_1_index_extern_sheet;
		ptg.field_2_first_row = field_2_first_row;
		ptg.field_3_last_row = field_3_last_row;
		ptg.field_4_first_column = field_4_first_column;
		ptg.field_5_last_column = field_5_last_column;
            ptg.setClass(ptgClass);
		return ptg;
	
public booleanequals(java.lang.Object o)

		if ( this == o ) return true;
		if ( !( o instanceof Area3DPtg ) ) return false;

		final Area3DPtg area3DPtg = (Area3DPtg) o;

		if ( field_1_index_extern_sheet != area3DPtg.field_1_index_extern_sheet ) return false;
		if ( field_2_first_row != area3DPtg.field_2_first_row ) return false;
		if ( field_3_last_row != area3DPtg.field_3_last_row ) return false;
		if ( field_4_first_column != area3DPtg.field_4_first_column ) return false;
		if ( field_5_last_column != area3DPtg.field_5_last_column ) return false;

		return true;
	
public bytegetDefaultOperandClass()

		return Ptg.CLASS_REF;
	
public shortgetExternSheetIndex()

		return field_1_index_extern_sheet;
	
public shortgetFirstColumn()

		return (short) ( field_4_first_column & 0xFF );
	
public shortgetFirstColumnRaw()

		return field_4_first_column;
	
public shortgetFirstRow()

		return field_2_first_row;
	
public shortgetLastColumn()

		return (short) ( field_5_last_column & 0xFF );
	
public shortgetLastColumnRaw()

		return field_5_last_column;
	
public shortgetLastRow()

		return field_3_last_row;
	
public intgetSize()

		return SIZE;
	
public inthashCode()

		int result;
		result = (int) field_1_index_extern_sheet;
		result = 29 * result + (int) field_2_first_row;
		result = 29 * result + (int) field_3_last_row;
		result = 29 * result + (int) field_4_first_column;
		result = 29 * result + (int) field_5_last_column;
		return result;
	
public booleanisFirstColRelative()

		return colRelative.isSet( field_4_first_column );
	
public booleanisFirstRowRelative()

		return rowRelative.isSet( field_4_first_column );
	
public booleanisLastColRelative()

		return colRelative.isSet( field_5_last_column );
	
public booleanisLastRowRelative()

		return rowRelative.isSet( field_5_last_column );
	
public voidsetArea(java.lang.String ref)

		AreaReference ar = new AreaReference( ref );

		setFirstRow( (short) ar.getCells()[0].getRow() );
		setFirstColumn( (short) ar.getCells()[0].getCol() );
		setLastRow( (short) ar.getCells()[1].getRow() );
		setLastColumn( (short) ar.getCells()[1].getCol() );
		setFirstColRelative( !ar.getCells()[0].isColAbsolute() );
		setLastColRelative( !ar.getCells()[1].isColAbsolute() );
		setFirstRowRelative( !ar.getCells()[0].isRowAbsolute() );
		setLastRowRelative( !ar.getCells()[1].isRowAbsolute() );

	
public voidsetExternSheetIndex(short index)

		field_1_index_extern_sheet = index;
	
public voidsetFirstColRelative(boolean rel)
set whether the first column is relative

		field_4_first_column = colRelative.setShortBoolean( field_4_first_column, rel );
	
public voidsetFirstColumn(short column)

		field_4_first_column &= 0xFF00;
		field_4_first_column |= column & 0xFF;
	
public voidsetFirstColumnRaw(short column)

		field_4_first_column = column;
	
public voidsetFirstRow(short row)

		field_2_first_row = row;
	
public voidsetFirstRowRelative(boolean rel)
sets the first row to relative or not

param
rel FIXME: Document this!

		field_4_first_column = rowRelative.setShortBoolean( field_4_first_column, rel );
	
public voidsetLastColRelative(boolean rel)
set whether the last column should be relative or not

		field_5_last_column = colRelative.setShortBoolean( field_5_last_column, rel );
	
public voidsetLastColumn(short column)

		field_5_last_column &= 0xFF00;
		field_5_last_column |= column & 0xFF;
	
public voidsetLastColumnRaw(short column)

		field_5_last_column = column;
	
public voidsetLastRow(short row)

		field_3_last_row = row;
	
public voidsetLastRowRelative(boolean rel)
set whether the last row is relative or not

param
rel FIXME: Document this!

		field_5_last_column = rowRelative.setShortBoolean( field_5_last_column, rel );
	
public java.lang.StringtoFormulaString(org.apache.poi.hssf.model.Workbook book)

		SheetReferences refs = book == null ? null : book.getSheetReferences();
		StringBuffer retval = new StringBuffer();
		if ( refs != null )
		{
			retval.append( refs.getSheetName( this.field_1_index_extern_sheet ) );
			retval.append( '!" );
		}
		retval.append( ( new CellReference( getFirstRow(), getFirstColumn(), !isFirstRowRelative(), !isFirstColRelative() ) ).toString() );
		retval.append( ':" );
		retval.append( ( new CellReference( getLastRow(), getLastColumn(), !isLastRowRelative(), !isLastColRelative() ) ).toString() );
		return retval.toString();
	
public java.lang.StringtoString()

		StringBuffer buffer = new StringBuffer();

		buffer.append( "AreaPtg\n" );
		buffer.append( "Index to Extern Sheet = " + getExternSheetIndex() ).append( "\n" );
		buffer.append( "firstRow = " + getFirstRow() ).append( "\n" );
		buffer.append( "lastRow  = " + getLastRow() ).append( "\n" );
		buffer.append( "firstCol = " + getFirstColumn() ).append( "\n" );
		buffer.append( "lastCol  = " + getLastColumn() ).append( "\n" );
		buffer.append( "firstColRel= "
				+ isFirstRowRelative() ).append( "\n" );
		buffer.append( "lastColRowRel = "
				+ isLastRowRelative() ).append( "\n" );
		buffer.append( "firstColRel   = " + isFirstColRelative() ).append( "\n" );
		buffer.append( "lastColRel    = " + isLastColRelative() ).append( "\n" );
		return buffer.toString();
	
public voidwriteBytes(byte[] array, int offset)

		array[0 + offset] = (byte) ( sid + ptgClass );
		LittleEndian.putShort( array, 1 + offset, getExternSheetIndex() );
		LittleEndian.putShort( array, 3 + offset, getFirstRow() );
		LittleEndian.putShort( array, 5 + offset, getLastRow() );
		LittleEndian.putShort( array, 7 + offset, getFirstColumnRaw() );
		LittleEndian.putShort( array, 9 + offset, getLastColumnRaw() );