2002-01-30 21:22:28 -05:00
|
|
|
|
|
|
|
/* ====================================================================
|
|
|
|
* 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 org.apache.poi.util.LittleEndian;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Title: Sheet Tab Index Array Record<P>
|
|
|
|
* Description: Contains an array of sheet id's. Sheets always keep their ID
|
|
|
|
* regardless of what their name is.<P>
|
|
|
|
* REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
|
|
|
|
* @author Andrew C. Oliver (acoliver at apache dot org)
|
|
|
|
* @version 2.0-pre
|
|
|
|
*/
|
|
|
|
|
|
|
|
public class TabIdRecord
|
|
|
|
extends Record
|
|
|
|
{
|
|
|
|
public final static short sid = 0x13d;
|
|
|
|
public short[] field_1_tabids;
|
|
|
|
|
|
|
|
public TabIdRecord()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructs a TabID record and sets its fields appropriately.
|
|
|
|
*
|
2002-02-10 22:49:39 -05:00
|
|
|
* @param id id must be 0x13d 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)
|
2002-01-30 21:22:28 -05:00
|
|
|
*/
|
|
|
|
|
|
|
|
public TabIdRecord(short id, short size, byte [] data)
|
|
|
|
{
|
|
|
|
super(id, size, data);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructs a TabID record and sets its fields appropriately.
|
|
|
|
*
|
2002-02-10 22:49:39 -05:00
|
|
|
* @param id id must be 0x13d 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)
|
2002-01-30 21:22:28 -05:00
|
|
|
* @param offset of the record
|
|
|
|
*/
|
|
|
|
|
|
|
|
public TabIdRecord(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 TABID RECORD");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
protected void fillFields(byte [] data, short size, int offset)
|
|
|
|
{
|
|
|
|
field_1_tabids = new short[ size / 2 ];
|
|
|
|
for (int k = 0; k < field_1_tabids.length; k++)
|
|
|
|
{
|
|
|
|
field_1_tabids[ k ] = LittleEndian.getShort(data,
|
|
|
|
(k * 2) + offset);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* set the tab array. (0,1,2).
|
|
|
|
* @param array of tab id's {0,1,2}
|
|
|
|
*/
|
|
|
|
|
|
|
|
public void setTabIdArray(short [] array)
|
|
|
|
{
|
|
|
|
field_1_tabids = array;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get the tab array. (0,1,2).
|
|
|
|
* @return array of tab id's {0,1,2}
|
|
|
|
*/
|
|
|
|
|
|
|
|
public short [] getTabIdArray()
|
|
|
|
{
|
|
|
|
return field_1_tabids;
|
|
|
|
}
|
|
|
|
|
|
|
|
public String toString()
|
|
|
|
{
|
|
|
|
StringBuffer buffer = new StringBuffer();
|
|
|
|
|
|
|
|
buffer.append("[TABID]\n");
|
|
|
|
buffer.append(" .elements = ").append(field_1_tabids.length)
|
|
|
|
.append("\n");
|
|
|
|
for (int k = 0; k < field_1_tabids.length; k++)
|
|
|
|
{
|
|
|
|
buffer.append(" .element_" + k + " = ")
|
|
|
|
.append(field_1_tabids[ k ]).append("\n");
|
|
|
|
}
|
|
|
|
buffer.append("[/TABID]\n");
|
|
|
|
return buffer.toString();
|
|
|
|
}
|
|
|
|
|
|
|
|
public int serialize(int offset, byte [] data)
|
|
|
|
{
|
|
|
|
short[] tabids = getTabIdArray();
|
|
|
|
short length = ( short ) (tabids.length * 2);
|
|
|
|
int byteoffset = 4;
|
|
|
|
|
|
|
|
LittleEndian.putShort(data, 0 + offset, sid);
|
|
|
|
LittleEndian.putShort(data, 2 + offset,
|
|
|
|
(( short ) length)); // nubmer tabids *
|
|
|
|
|
|
|
|
// 2 (num bytes in a short)
|
|
|
|
for (int k = 0; k < (length / 2); k++)
|
|
|
|
{
|
|
|
|
LittleEndian.putShort(data, byteoffset + offset, tabids[ k ]);
|
|
|
|
byteoffset += 2;
|
|
|
|
}
|
|
|
|
return getRecordSize();
|
|
|
|
}
|
|
|
|
|
|
|
|
public int getRecordSize()
|
|
|
|
{
|
|
|
|
return 4 + (getTabIdArray().length * 2);
|
|
|
|
}
|
|
|
|
|
|
|
|
public short getSid()
|
|
|
|
{
|
|
|
|
return this.sid;
|
|
|
|
}
|
|
|
|
}
|