295 lines
9.2 KiB
Java
295 lines
9.2 KiB
Java
|
|
/* ====================================================================
|
|
* The Apache Software License, Version 1.1
|
|
*
|
|
* Copyright (c) 2002 The Apache Software Foundation. All rights
|
|
* reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* 3. The end-user documentation included with the redistribution,
|
|
* if any, must include the following acknowledgment:
|
|
* "This product includes software developed by the
|
|
* Apache Software Foundation (http://www.apache.org/)."
|
|
* Alternately, this acknowledgment may appear in the software itself,
|
|
* if and wherever such third-party acknowledgments normally appear.
|
|
*
|
|
* 4. The names "Apache" and "Apache Software Foundation" and
|
|
* "Apache POI" must not be used to endorse or promote products
|
|
* derived from this software without prior written permission. For
|
|
* written permission, please contact apache@apache.org.
|
|
*
|
|
* 5. Products derived from this software may not be called "Apache",
|
|
* "Apache POI", nor may "Apache" appear in their name, without
|
|
* prior written permission of the Apache Software Foundation.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
|
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
* ====================================================================
|
|
*
|
|
* This software consists of voluntary contributions made by many
|
|
* individuals on behalf of the Apache Software Foundation. For more
|
|
* information on the Apache Software Foundation, please see
|
|
* <http://www.apache.org/>.
|
|
*/
|
|
|
|
package org.apache.poi.hssf.record;
|
|
|
|
import java.util.*;
|
|
|
|
import org.apache.poi.util.LittleEndian;
|
|
|
|
/**
|
|
* Title: Selection Record<P>
|
|
* Description: shows the user's selection on the sheet
|
|
* for write set num refs to 0<P>
|
|
*
|
|
* TODO : Implement reference subrecords
|
|
* REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
|
|
* @author Andrew C. Oliver (acoliver at apache dot org)
|
|
* @author Jason Height (jheight at chariot dot net dot au)
|
|
* @version 2.0-pre
|
|
*/
|
|
|
|
public class SelectionRecord
|
|
extends Record
|
|
{
|
|
public final static short sid = 0x1d;
|
|
private byte field_1_pane;
|
|
//private short field_2_row_active_cell;
|
|
private int field_2_row_active_cell;
|
|
private short field_3_col_active_cell;
|
|
private short field_4_ref_active_cell;
|
|
private short field_5_num_refs;
|
|
private ArrayList field_6_refs; // not used yet
|
|
|
|
public SelectionRecord()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Constructs a Selection record and sets its fields appropriately.
|
|
*
|
|
* @param id id must be 0x1d or an exception will be throw upon validation
|
|
* @param size the size of the data area of the record
|
|
* @param data data of the record (should not contain sid/len)
|
|
*/
|
|
|
|
public SelectionRecord(short id, short size, byte [] data)
|
|
{
|
|
super(id, size, data);
|
|
}
|
|
|
|
/**
|
|
* Constructs a Selection record and sets its fields appropriately.
|
|
*
|
|
* @param id id must be 0x1d or an exception will be throw upon validation
|
|
* @param size the size of the data area of the record
|
|
* @param data data of the record (should not contain sid/len)
|
|
* @param offset of the record's data
|
|
*/
|
|
|
|
public SelectionRecord(short id, short size, byte [] data, int offset)
|
|
{
|
|
super(id, size, data, offset);
|
|
}
|
|
|
|
protected void validateSid(short id)
|
|
{
|
|
if (id != sid)
|
|
{
|
|
throw new RecordFormatException("NOT A valid Selection RECORD");
|
|
}
|
|
}
|
|
|
|
protected void fillFields(byte [] data, short size, int offset)
|
|
{
|
|
field_1_pane = data[ 0 + offset ];
|
|
//field_2_row_active_cell = LittleEndian.getShort(data, 1 + offset);
|
|
field_2_row_active_cell = LittleEndian.getUShort(data, 1 + offset);
|
|
field_3_col_active_cell = LittleEndian.getShort(data, 3 + offset);
|
|
field_4_ref_active_cell = LittleEndian.getShort(data, 5 + offset);
|
|
field_5_num_refs = LittleEndian.getShort(data, 7 + offset);
|
|
}
|
|
|
|
/**
|
|
* set which window pane this is for
|
|
* @param pane
|
|
*/
|
|
|
|
public void setPane(byte pane)
|
|
{
|
|
field_1_pane = pane;
|
|
}
|
|
|
|
/**
|
|
* set the active cell's row
|
|
* @param row number of active cell
|
|
*/
|
|
|
|
//public void setActiveCellRow(short row)
|
|
public void setActiveCellRow(int row)
|
|
{
|
|
field_2_row_active_cell = row;
|
|
}
|
|
|
|
/**
|
|
* set the active cell's col
|
|
* @param col number of active cell
|
|
*/
|
|
|
|
public void setActiveCellCol(short col)
|
|
{
|
|
field_3_col_active_cell = col;
|
|
}
|
|
|
|
/**
|
|
* set the active cell's reference number
|
|
* @param ref number of active cell
|
|
*/
|
|
|
|
public void setActiveCellRef(short ref)
|
|
{
|
|
field_4_ref_active_cell = ref;
|
|
}
|
|
|
|
/**
|
|
* set the number of cell refs (we don't support selection so set to 0
|
|
* @param refs - number of references
|
|
*/
|
|
|
|
public void setNumRefs(short refs)
|
|
{
|
|
field_5_num_refs = refs;
|
|
}
|
|
|
|
/**
|
|
* get which window pane this is for
|
|
* @return pane
|
|
*/
|
|
|
|
public byte getPane()
|
|
{
|
|
return field_1_pane;
|
|
}
|
|
|
|
/**
|
|
* get the active cell's row
|
|
* @return row number of active cell
|
|
*/
|
|
|
|
//public short getActiveCellRow()
|
|
public int getActiveCellRow()
|
|
{
|
|
return field_2_row_active_cell;
|
|
}
|
|
|
|
/**
|
|
* get the active cell's col
|
|
* @return col number of active cell
|
|
*/
|
|
|
|
public short getActiveCellCol()
|
|
{
|
|
return field_3_col_active_cell;
|
|
}
|
|
|
|
/**
|
|
* get the active cell's reference number
|
|
* @return ref number of active cell
|
|
*/
|
|
|
|
public short getActiveCellRef()
|
|
{
|
|
return field_4_ref_active_cell;
|
|
}
|
|
|
|
/**
|
|
* get the number of cell refs (we don't support selection so set to 0
|
|
* @return refs - number of references
|
|
*/
|
|
|
|
public short getNumRefs()
|
|
{
|
|
return field_5_num_refs;
|
|
}
|
|
|
|
public String toString()
|
|
{
|
|
StringBuffer buffer = new StringBuffer();
|
|
|
|
buffer.append("[SELECTION]\n");
|
|
buffer.append(" .pane = ")
|
|
.append(Integer.toHexString(getPane())).append("\n");
|
|
buffer.append(" .activecellrow = ")
|
|
.append(Integer.toHexString(getActiveCellRow())).append("\n");
|
|
buffer.append(" .activecellcol = ")
|
|
.append(Integer.toHexString(getActiveCellCol())).append("\n");
|
|
buffer.append(" .activecellref = ")
|
|
.append(Integer.toHexString(getActiveCellRef())).append("\n");
|
|
buffer.append(" .numrefs = ")
|
|
.append(Integer.toHexString(getNumRefs())).append("\n");
|
|
buffer.append("[/SELECTION]\n");
|
|
return buffer.toString();
|
|
}
|
|
|
|
//hacked to provide one cell reference to 0,0 - 0,0
|
|
public int serialize(int offset, byte [] data)
|
|
{
|
|
LittleEndian.putShort(data, 0 + offset, sid);
|
|
LittleEndian.putShort(data, 2 + offset, ( short ) 15);
|
|
data[ 4 + offset ] = getPane();
|
|
//LittleEndian.putShort(data, 5 + offset, getActiveCellRow());
|
|
LittleEndian.putShort(data, 5 + offset, ( short ) getActiveCellRow());
|
|
LittleEndian.putShort(data, 7 + offset, getActiveCellCol());
|
|
LittleEndian.putShort(data, 9 + offset, getActiveCellRef());
|
|
LittleEndian.putShort(data, 11 + offset, ( short ) 1);
|
|
LittleEndian.putShort(data, 13 + offset, ( short ) 0);
|
|
LittleEndian.putShort(data, 15 + offset, ( short ) 0);
|
|
data[ 17 + offset ] = 0;
|
|
data[ 18 + offset ] = 0;
|
|
return getRecordSize();
|
|
}
|
|
|
|
public int getRecordSize()
|
|
{
|
|
return 19;
|
|
}
|
|
|
|
public short getSid()
|
|
{
|
|
return this.sid;
|
|
}
|
|
|
|
public Object clone() {
|
|
SelectionRecord rec = new SelectionRecord();
|
|
rec.field_1_pane = field_1_pane;
|
|
rec.field_2_row_active_cell = field_2_row_active_cell;
|
|
rec.field_3_col_active_cell = field_3_col_active_cell;
|
|
rec.field_4_ref_active_cell = field_4_ref_active_cell;
|
|
rec.field_5_num_refs = field_5_num_refs;
|
|
rec.field_6_refs = field_6_refs;
|
|
return rec;
|
|
}
|
|
}
|