238 lines
7.3 KiB
Java
238 lines
7.3 KiB
Java
/* ====================================================================
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
==================================================================== */
|
|
|
|
package org.apache.poi.hssf.record;
|
|
|
|
import org.apache.poi.util.BitField;
|
|
import org.apache.poi.util.BitFieldFactory;
|
|
import org.apache.poi.util.HexDump;
|
|
import org.apache.poi.util.LittleEndianOutput;
|
|
|
|
/**
|
|
* Describes a chart sheet properties record.<p/>
|
|
*
|
|
* @author Glen Stampoultzis (glens at apache.org)
|
|
*/
|
|
public final class SheetPropertiesRecord extends StandardRecord {
|
|
public final static short sid = 0x1044;
|
|
|
|
private static final BitField chartTypeManuallyFormatted = BitFieldFactory.getInstance(0x01);
|
|
private static final BitField plotVisibleOnly = BitFieldFactory.getInstance(0x02);
|
|
private static final BitField doNotSizeWithWindow = BitFieldFactory.getInstance(0x04);
|
|
private static final BitField defaultPlotDimensions = BitFieldFactory.getInstance(0x08);
|
|
private static final BitField autoPlotArea = BitFieldFactory.getInstance(0x10);
|
|
|
|
private short field_1_flags;
|
|
private byte field_2_empty;
|
|
public final static byte EMPTY_NOT_PLOTTED = 0;
|
|
public final static byte EMPTY_ZERO = 1;
|
|
public final static byte EMPTY_INTERPOLATED = 2;
|
|
|
|
|
|
public SheetPropertiesRecord()
|
|
{
|
|
|
|
}
|
|
|
|
public SheetPropertiesRecord(RecordInputStream in)
|
|
{
|
|
field_1_flags = in.readShort();
|
|
field_2_empty = in.readByte();
|
|
}
|
|
|
|
public String toString()
|
|
{
|
|
StringBuffer buffer = new StringBuffer();
|
|
|
|
buffer.append("[SHTPROPS]\n");
|
|
buffer.append(" .flags = ")
|
|
.append("0x").append(HexDump.toHex( getFlags ()))
|
|
.append(" (").append( getFlags() ).append(" )");
|
|
buffer.append(System.getProperty("line.separator"));
|
|
buffer.append(" .chartTypeManuallyFormatted = ").append(isChartTypeManuallyFormatted()).append('\n');
|
|
buffer.append(" .plotVisibleOnly = ").append(isPlotVisibleOnly()).append('\n');
|
|
buffer.append(" .doNotSizeWithWindow = ").append(isDoNotSizeWithWindow()).append('\n');
|
|
buffer.append(" .defaultPlotDimensions = ").append(isDefaultPlotDimensions()).append('\n');
|
|
buffer.append(" .autoPlotArea = ").append(isAutoPlotArea()).append('\n');
|
|
buffer.append(" .empty = ")
|
|
.append("0x").append(HexDump.toHex( getEmpty ()))
|
|
.append(" (").append( getEmpty() ).append(" )");
|
|
buffer.append(System.getProperty("line.separator"));
|
|
|
|
buffer.append("[/SHTPROPS]\n");
|
|
return buffer.toString();
|
|
}
|
|
|
|
public void serialize(LittleEndianOutput out) {
|
|
out.writeShort(field_1_flags);
|
|
out.writeByte(field_2_empty);
|
|
}
|
|
|
|
protected int getDataSize() {
|
|
return 2 + 1;
|
|
}
|
|
|
|
public short getSid()
|
|
{
|
|
return sid;
|
|
}
|
|
|
|
public Object clone() {
|
|
SheetPropertiesRecord rec = new SheetPropertiesRecord();
|
|
|
|
rec.field_1_flags = field_1_flags;
|
|
rec.field_2_empty = field_2_empty;
|
|
return rec;
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
* Get the flags field for the SheetProperties record.
|
|
*/
|
|
public short getFlags()
|
|
{
|
|
return field_1_flags;
|
|
}
|
|
|
|
/**
|
|
* Set the flags field for the SheetProperties record.
|
|
*/
|
|
public void setFlags(short field_1_flags)
|
|
{
|
|
this.field_1_flags = field_1_flags;
|
|
}
|
|
|
|
/**
|
|
* Get the empty field for the SheetProperties record.
|
|
*
|
|
* @return One of
|
|
* EMPTY_NOT_PLOTTED
|
|
* EMPTY_ZERO
|
|
* EMPTY_INTERPOLATED
|
|
*/
|
|
public byte getEmpty()
|
|
{
|
|
return field_2_empty;
|
|
}
|
|
|
|
/**
|
|
* Set the empty field for the SheetProperties record.
|
|
*
|
|
* @param field_2_empty
|
|
* One of
|
|
* EMPTY_NOT_PLOTTED
|
|
* EMPTY_ZERO
|
|
* EMPTY_INTERPOLATED
|
|
*/
|
|
public void setEmpty(byte field_2_empty)
|
|
{
|
|
this.field_2_empty = field_2_empty;
|
|
}
|
|
|
|
/**
|
|
* Sets the chart type manually formatted field value.
|
|
* Has the chart type been manually formatted?
|
|
*/
|
|
public void setChartTypeManuallyFormatted(boolean value)
|
|
{
|
|
field_1_flags = chartTypeManuallyFormatted.setShortBoolean(field_1_flags, value);
|
|
}
|
|
|
|
/**
|
|
* Has the chart type been manually formatted?
|
|
* @return the chart type manually formatted field value.
|
|
*/
|
|
public boolean isChartTypeManuallyFormatted()
|
|
{
|
|
return chartTypeManuallyFormatted.isSet(field_1_flags);
|
|
}
|
|
|
|
/**
|
|
* Sets the plot visible only field value.
|
|
* Only show visible cells on the chart.
|
|
*/
|
|
public void setPlotVisibleOnly(boolean value)
|
|
{
|
|
field_1_flags = plotVisibleOnly.setShortBoolean(field_1_flags, value);
|
|
}
|
|
|
|
/**
|
|
* Only show visible cells on the chart.
|
|
* @return the plot visible only field value.
|
|
*/
|
|
public boolean isPlotVisibleOnly()
|
|
{
|
|
return plotVisibleOnly.isSet(field_1_flags);
|
|
}
|
|
|
|
/**
|
|
* Sets the do not size with window field value.
|
|
* Do not size the chart when the window changes size
|
|
*/
|
|
public void setDoNotSizeWithWindow(boolean value)
|
|
{
|
|
field_1_flags = doNotSizeWithWindow.setShortBoolean(field_1_flags, value);
|
|
}
|
|
|
|
/**
|
|
* Do not size the chart when the window changes size
|
|
* @return the do not size with window field value.
|
|
*/
|
|
public boolean isDoNotSizeWithWindow()
|
|
{
|
|
return doNotSizeWithWindow.isSet(field_1_flags);
|
|
}
|
|
|
|
/**
|
|
* Sets the default plot dimensions field value.
|
|
* Indicates that the default area dimensions should be used.
|
|
*/
|
|
public void setDefaultPlotDimensions(boolean value)
|
|
{
|
|
field_1_flags = defaultPlotDimensions.setShortBoolean(field_1_flags, value);
|
|
}
|
|
|
|
/**
|
|
* Indicates that the default area dimensions should be used.
|
|
* @return the default plot dimensions field value.
|
|
*/
|
|
public boolean isDefaultPlotDimensions()
|
|
{
|
|
return defaultPlotDimensions.isSet(field_1_flags);
|
|
}
|
|
|
|
/**
|
|
* Sets the auto plot area field value.
|
|
* ??
|
|
*/
|
|
public void setAutoPlotArea(boolean value)
|
|
{
|
|
field_1_flags = autoPlotArea.setShortBoolean(field_1_flags, value);
|
|
}
|
|
|
|
/**
|
|
* ??
|
|
* @return the auto plot area field value.
|
|
*/
|
|
public boolean isAutoPlotArea()
|
|
{
|
|
return autoPlotArea.isSet(field_1_flags);
|
|
}
|
|
}
|