505 lines
15 KiB
Java
505 lines
15 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 org.apache.poi.util.BitField;
|
|
import org.apache.poi.util.LittleEndian;
|
|
|
|
/**
|
|
* Title: Window1 Record<P>
|
|
* Description: Stores the attributes of the workbook window. This is basically
|
|
* so the gui knows how big to make the window holding the spreadsheet
|
|
* document.<P>
|
|
* REFERENCE: PG 421 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 WindowOneRecord
|
|
extends Record
|
|
{
|
|
public final static short sid = 0x3d;
|
|
|
|
// our variable names stolen from old TV sets.
|
|
private short field_1_h_hold; // horizontal position
|
|
private short field_2_v_hold; // vertical position
|
|
private short field_3_width;
|
|
private short field_4_height;
|
|
private short field_5_options;
|
|
static final private BitField hidden =
|
|
new BitField(0x01); // is this window is hidden
|
|
static final private BitField iconic =
|
|
new BitField(0x02); // is this window is an icon
|
|
static final private BitField reserved = new BitField(0x04); // reserved
|
|
static final private BitField hscroll =
|
|
new BitField(0x08); // display horizontal scrollbar
|
|
static final private BitField vscroll =
|
|
new BitField(0x10); // display vertical scrollbar
|
|
static final private BitField tabs =
|
|
new BitField(0x20); // display tabs at the bottom
|
|
|
|
// all the rest are "reserved"
|
|
private short field_6_selected_tab;
|
|
private short field_7_displayed_tab;
|
|
private short field_8_num_selected_tabs;
|
|
private short field_9_tab_width_ratio;
|
|
|
|
public WindowOneRecord()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Constructs a WindowOne record and sets its fields appropriately.
|
|
*
|
|
* @param id id must be 0x3d 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 WindowOneRecord(short id, short size, byte [] data)
|
|
{
|
|
super(id, size, data);
|
|
}
|
|
|
|
/**
|
|
* Constructs a WindowOne record and sets its fields appropriately.
|
|
*
|
|
* @param id id must be 0x3d 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 WindowOneRecord(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 WINDOW1 RECORD");
|
|
}
|
|
}
|
|
|
|
protected void fillFields(byte [] data, short size, int offset)
|
|
{
|
|
field_1_h_hold = LittleEndian.getShort(data, 0 + offset);
|
|
field_2_v_hold = LittleEndian.getShort(data, 2 + offset);
|
|
field_3_width = LittleEndian.getShort(data, 4 + offset);
|
|
field_4_height = LittleEndian.getShort(data, 6 + offset);
|
|
field_5_options = LittleEndian.getShort(data, 8 + offset);
|
|
field_6_selected_tab = LittleEndian.getShort(data, 10 + offset);
|
|
field_7_displayed_tab = LittleEndian.getShort(data, 12 + offset);
|
|
field_8_num_selected_tabs = LittleEndian.getShort(data, 14 + offset);
|
|
field_9_tab_width_ratio = LittleEndian.getShort(data, 16 + offset);
|
|
}
|
|
|
|
/**
|
|
* set the horizontal position of the window (in 1/20ths of a point)
|
|
* @param h - horizontal location
|
|
*/
|
|
|
|
public void setHorizontalHold(short h)
|
|
{
|
|
field_1_h_hold = h;
|
|
}
|
|
|
|
/**
|
|
* set the vertical position of the window (in 1/20ths of a point)
|
|
* @param v - vertical location
|
|
*/
|
|
|
|
public void setVerticalHold(short v)
|
|
{
|
|
field_2_v_hold = v;
|
|
}
|
|
|
|
/**
|
|
* set the width of the window
|
|
* @param w width
|
|
*/
|
|
|
|
public void setWidth(short w)
|
|
{
|
|
field_3_width = w;
|
|
}
|
|
|
|
/**
|
|
* set teh height of the window
|
|
* @param h height
|
|
*/
|
|
|
|
public void setHeight(short h)
|
|
{
|
|
field_4_height = h;
|
|
}
|
|
|
|
/**
|
|
* set the options bitmask (see bit setters)
|
|
*
|
|
* @param o - the bitmask
|
|
*/
|
|
|
|
public void setOptions(short o)
|
|
{
|
|
field_5_options = o;
|
|
}
|
|
|
|
// bitfields for options
|
|
|
|
/**
|
|
* set whether the window is hidden or not
|
|
* @param ishidden or not
|
|
*/
|
|
|
|
public void setHidden(boolean ishidden)
|
|
{
|
|
field_5_options = hidden.setShortBoolean(field_5_options, ishidden);
|
|
}
|
|
|
|
/**
|
|
* set whether the window has been iconized or not
|
|
* @param isiconic iconize or not
|
|
*/
|
|
|
|
public void setIconic(boolean isiconic)
|
|
{
|
|
field_5_options = iconic.setShortBoolean(field_5_options, isiconic);
|
|
}
|
|
|
|
/**
|
|
* set whether to display the horizontal scrollbar or not
|
|
* @param scroll display or not
|
|
*/
|
|
|
|
public void setDisplayHorizonalScrollbar(boolean scroll)
|
|
{
|
|
field_5_options = hscroll.setShortBoolean(field_5_options, scroll);
|
|
}
|
|
|
|
/**
|
|
* set whether to display the vertical scrollbar or not
|
|
* @param scroll display or not
|
|
*/
|
|
|
|
public void setDisplayVerticalScrollbar(boolean scroll)
|
|
{
|
|
field_5_options = vscroll.setShortBoolean(field_5_options, scroll);
|
|
}
|
|
|
|
/**
|
|
* set whether to display the tabs or not
|
|
* @param disptabs display or not
|
|
*/
|
|
|
|
public void setDisplayTabs(boolean disptabs)
|
|
{
|
|
field_5_options = tabs.setShortBoolean(field_5_options, disptabs);
|
|
}
|
|
|
|
// end bitfields
|
|
|
|
/**
|
|
* set the selected tab number
|
|
* @param s tab number
|
|
*/
|
|
|
|
public void setSelectedTab(short s)
|
|
{
|
|
field_6_selected_tab = s;
|
|
}
|
|
|
|
/**
|
|
* set the displayed tab number
|
|
* @param t tab number
|
|
*/
|
|
|
|
public void setDisplayedTab(short t)
|
|
{
|
|
field_7_displayed_tab = t;
|
|
}
|
|
|
|
/**
|
|
* set the number of selected tabs
|
|
* @param n number of tabs
|
|
*/
|
|
|
|
public void setNumSelectedTabs(short n)
|
|
{
|
|
field_8_num_selected_tabs = n;
|
|
}
|
|
|
|
/**
|
|
* ratio of the width of the tabs to the horizontal scrollbar
|
|
* @param r ratio
|
|
*/
|
|
|
|
public void setTabWidthRatio(short r)
|
|
{
|
|
field_9_tab_width_ratio = r;
|
|
}
|
|
|
|
/**
|
|
* get the horizontal position of the window (in 1/20ths of a point)
|
|
* @return h - horizontal location
|
|
*/
|
|
|
|
public short getHorizontalHold()
|
|
{
|
|
return field_1_h_hold;
|
|
}
|
|
|
|
/**
|
|
* get the vertical position of the window (in 1/20ths of a point)
|
|
* @return v - vertical location
|
|
*/
|
|
|
|
public short getVerticalHold()
|
|
{
|
|
return field_2_v_hold;
|
|
}
|
|
|
|
/**
|
|
* get the width of the window
|
|
* @return width
|
|
*/
|
|
|
|
public short getWidth()
|
|
{
|
|
return field_3_width;
|
|
}
|
|
|
|
/**
|
|
* get the height of the window
|
|
* @return height
|
|
*/
|
|
|
|
public short getHeight()
|
|
{
|
|
return field_4_height;
|
|
}
|
|
|
|
/**
|
|
* get the options bitmask (see bit setters)
|
|
*
|
|
* @return o - the bitmask
|
|
*/
|
|
|
|
public short getOptions()
|
|
{
|
|
return field_5_options;
|
|
}
|
|
|
|
// bitfields for options
|
|
|
|
/**
|
|
* get whether the window is hidden or not
|
|
* @return ishidden or not
|
|
*/
|
|
|
|
public boolean getHidden()
|
|
{
|
|
return hidden.isSet(field_5_options);
|
|
}
|
|
|
|
/**
|
|
* get whether the window has been iconized or not
|
|
* @return iconize or not
|
|
*/
|
|
|
|
public boolean getIconic()
|
|
{
|
|
return iconic.isSet(field_5_options);
|
|
}
|
|
|
|
/**
|
|
* get whether to display the horizontal scrollbar or not
|
|
* @return display or not
|
|
*/
|
|
|
|
public boolean getDisplayHorizontalScrollbar()
|
|
{
|
|
return hscroll.isSet(field_5_options);
|
|
}
|
|
|
|
/**
|
|
* get whether to display the vertical scrollbar or not
|
|
* @return display or not
|
|
*/
|
|
|
|
public boolean getDisplayVerticalScrollbar()
|
|
{
|
|
return vscroll.isSet(field_5_options);
|
|
}
|
|
|
|
/**
|
|
* get whether to display the tabs or not
|
|
* @return display or not
|
|
*/
|
|
|
|
public boolean getDisplayTabs()
|
|
{
|
|
return tabs.isSet(field_5_options);
|
|
}
|
|
|
|
// end options bitfields
|
|
|
|
/**
|
|
* get the selected tab number
|
|
* @return Tab number
|
|
*/
|
|
|
|
public short getSelectedTab()
|
|
{
|
|
return field_6_selected_tab;
|
|
}
|
|
|
|
/**
|
|
* get the displayed tab number
|
|
* @return Tab number
|
|
*/
|
|
|
|
public short getDisplayedTab()
|
|
{
|
|
return field_7_displayed_tab;
|
|
}
|
|
|
|
/**
|
|
* get the number of selected tabs
|
|
* @return number of tabs
|
|
*/
|
|
|
|
public short getNumSelectedTabs()
|
|
{
|
|
return field_8_num_selected_tabs;
|
|
}
|
|
|
|
/**
|
|
* ratio of the width of the tabs to the horizontal scrollbar
|
|
* @return ratio
|
|
*/
|
|
|
|
public short getTabWidthRatio()
|
|
{
|
|
return field_9_tab_width_ratio;
|
|
}
|
|
|
|
public String toString()
|
|
{
|
|
StringBuffer buffer = new StringBuffer();
|
|
|
|
buffer.append("[WINDOW1]\n");
|
|
buffer.append(" .h_hold = ")
|
|
.append(Integer.toHexString(getHorizontalHold())).append("\n");
|
|
buffer.append(" .v_hold = ")
|
|
.append(Integer.toHexString(getVerticalHold())).append("\n");
|
|
buffer.append(" .width = ")
|
|
.append(Integer.toHexString(getWidth())).append("\n");
|
|
buffer.append(" .height = ")
|
|
.append(Integer.toHexString(getHeight())).append("\n");
|
|
buffer.append(" .options = ")
|
|
.append(Integer.toHexString(getOptions())).append("\n");
|
|
buffer.append(" .hidden = ").append(getHidden())
|
|
.append("\n");
|
|
buffer.append(" .iconic = ").append(getIconic())
|
|
.append("\n");
|
|
buffer.append(" .hscroll = ")
|
|
.append(getDisplayHorizontalScrollbar()).append("\n");
|
|
buffer.append(" .vscroll = ")
|
|
.append(getDisplayVerticalScrollbar()).append("\n");
|
|
buffer.append(" .tabs = ").append(getDisplayTabs())
|
|
.append("\n");
|
|
buffer.append(" .selectedtab = ")
|
|
.append(Integer.toHexString(getSelectedTab())).append("\n");
|
|
buffer.append(" .displayedtab = ")
|
|
.append(Integer.toHexString(getDisplayedTab())).append("\n");
|
|
buffer.append(" .numselectedtabs = ")
|
|
.append(Integer.toHexString(getNumSelectedTabs())).append("\n");
|
|
buffer.append(" .tabwidthratio = ")
|
|
.append(Integer.toHexString(getTabWidthRatio())).append("\n");
|
|
buffer.append("[/WINDOW1]\n");
|
|
return buffer.toString();
|
|
}
|
|
|
|
public int serialize(int offset, byte [] data)
|
|
{
|
|
LittleEndian.putShort(data, 0 + offset, sid);
|
|
LittleEndian.putShort(data, 2 + offset,
|
|
(( short ) 0x12)); // 18 bytes (22 total)
|
|
LittleEndian.putShort(data, 4 + offset, getHorizontalHold());
|
|
LittleEndian.putShort(data, 6 + offset, getVerticalHold());
|
|
LittleEndian.putShort(data, 8 + offset, getWidth());
|
|
LittleEndian.putShort(data, 10 + offset, getHeight());
|
|
LittleEndian.putShort(data, 12 + offset, getOptions());
|
|
LittleEndian.putShort(data, 14 + offset, getSelectedTab());
|
|
LittleEndian.putShort(data, 16 + offset, getDisplayedTab());
|
|
LittleEndian.putShort(data, 18 + offset, getNumSelectedTabs());
|
|
LittleEndian.putShort(data, 20 + offset, getTabWidthRatio());
|
|
return getRecordSize();
|
|
}
|
|
|
|
public int getRecordSize()
|
|
{
|
|
return 22;
|
|
}
|
|
|
|
public short getSid()
|
|
{
|
|
return this.sid;
|
|
}
|
|
}
|