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

FrameRecord

• 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_borderType
public static final short	BORDER_TYPE_REGULAR
public static final short	BORDER_TYPE_SHADOW
private short	field_2_options
private BitField	autoSize
private BitField	autoPosition

Constructors Summary
public FrameRecord()
public FrameRecord(RecordInputStream in) Constructs a Frame record and sets its fields appropriately. param id id must be 0x1032 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() FrameRecord rec = new FrameRecord(); rec.field_1_borderType = field_1_borderType; rec.field_2_options = field_2_options; return rec;
protected void	fillFields(org.apache.poi.hssf.record.RecordInputStream in) field_1_borderType = in.readShort(); field_2_options = in.readShort();
public short	getBorderType() Get the border type field for the Frame record. return One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW return field_1_borderType;
public short	getOptions() Get the options field for the Frame record. return field_2_options;
public int	getRecordSize() Size of record (exluding 4 byte header) return 4 + 2 + 2;
public short	getSid() return sid;
public boolean	isAutoPosition() excel calculates the position automatically return the auto position field value. return autoPosition.isSet(field_2_options);
public boolean	isAutoSize() excel calculates the size automatically if true return the auto size field value. return autoSize.isSet(field_2_options);
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_borderType); LittleEndian.putShort(data, 6 + offset + pos, field_2_options); return getRecordSize();
public void	setAutoPosition(boolean value) Sets the auto position field value. excel calculates the position automatically field_2_options = autoPosition.setShortBoolean(field_2_options, value);
public void	setAutoSize(boolean value) Sets the auto size field value. excel calculates the size automatically if true field_2_options = autoSize.setShortBoolean(field_2_options, value);
public void	setBorderType(short field_1_borderType) Set the border type field for the Frame record. param field_1_borderType One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW this.field_1_borderType = field_1_borderType;
public void	setOptions(short field_2_options) Set the options field for the Frame record. this.field_2_options = field_2_options;
public java.lang.String	toString() StringBuffer buffer = new StringBuffer(); buffer.append("[FRAME]\n"); buffer.append(" .borderType = ") .append("0x").append(HexDump.toHex( getBorderType ())) .append(" (").append( getBorderType() ).append(" )"); buffer.append(System.getProperty("line.separator")); buffer.append(" .options = ") .append("0x").append(HexDump.toHex( getOptions ())) .append(" (").append( getOptions() ).append(" )"); buffer.append(System.getProperty("line.separator")); buffer.append(" .autoSize = ").append(isAutoSize()).append('\n"); buffer.append(" .autoPosition = ").append(isAutoPosition()).append('\n"); buffer.append("[/FRAME]\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 Frame record"); }