File	Doc	Category	Size	Date	Package
AreaRecord.java	API Doc	Apache Poi 3.0.1	5735	Mon Jan 01 12:39:40 GMT 2007	org.apache.poi.hssf.record

AreaRecord

• java.lang.Object
  • org.apache.poi.hssf.record.RecordBase
    • org.apache.poi.hssf.record.Record

Fields Summary
public static final short	sid
private short	field_1_formatFlags
private BitField	stacked
private BitField	displayAsPercentage
private BitField	shadow

Constructors Summary
public AreaRecord()
public AreaRecord(RecordInputStream in) Constructs a Area record and sets its fields appropriately. param id id must be 0x101A or an exception will be throw upon validation param size size the size of the data area of the record param data data of the record (should not contain sid/len) super(in);

Methods Summary
public java.lang.Object	clone() AreaRecord rec = new AreaRecord(); rec.field_1_formatFlags = field_1_formatFlags; return rec;
protected void	fillFields(org.apache.poi.hssf.record.RecordInputStream in) field_1_formatFlags = in.readShort();
public short	getFormatFlags() Get the format flags field for the Area record. return field_1_formatFlags;
public int	getRecordSize() Size of record (exluding 4 byte header) return 4 + 2;
public short	getSid() return sid;
public boolean	isDisplayAsPercentage() results displayed as percentages return the display as percentage field value. return displayAsPercentage.isSet(field_1_formatFlags);
public boolean	isShadow() display a shadow for the chart return the shadow field value. return shadow.isSet(field_1_formatFlags);
public boolean	isStacked() series is stacked return the stacked field value. return stacked.isSet(field_1_formatFlags);
public int	serialize(int offset, byte[] data) int pos = 0; LittleEndian.putShort(data, 0 + offset, sid); LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); LittleEndian.putShort(data, 4 + offset + pos, field_1_formatFlags); return getRecordSize();
public void	setDisplayAsPercentage(boolean value) Sets the display as percentage field value. results displayed as percentages field_1_formatFlags = displayAsPercentage.setShortBoolean(field_1_formatFlags, value);
public void	setFormatFlags(short field_1_formatFlags) Set the format flags field for the Area record. this.field_1_formatFlags = field_1_formatFlags;
public void	setShadow(boolean value) Sets the shadow field value. display a shadow for the chart field_1_formatFlags = shadow.setShortBoolean(field_1_formatFlags, value);
public void	setStacked(boolean value) Sets the stacked field value. series is stacked field_1_formatFlags = stacked.setShortBoolean(field_1_formatFlags, value);
public java.lang.String	toString() StringBuffer buffer = new StringBuffer(); buffer.append("[AREA]\n"); buffer.append(" .formatFlags = ") .append("0x").append(HexDump.toHex( getFormatFlags ())) .append(" (").append( getFormatFlags() ).append(" )"); buffer.append(System.getProperty("line.separator")); buffer.append(" .stacked = ").append(isStacked()).append('\n"); buffer.append(" .displayAsPercentage = ").append(isDisplayAsPercentage()).append('\n"); buffer.append(" .shadow = ").append(isShadow()).append('\n"); buffer.append("[/AREA]\n"); return buffer.toString();
protected void	validateSid(short id) Checks the sid matches the expected side for this record param id the expected sid. if (id != sid) { throw new RecordFormatException("Not a Area record"); }