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

DatRecord

• 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_options
private BitField	horizontalBorder
private BitField	verticalBorder
private BitField	border
private BitField	showSeriesKey

Constructors Summary
public DatRecord()
public DatRecord(RecordInputStream in) Constructs a Dat record and sets its fields appropriately. param id id must be 0x1063 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() DatRecord rec = new DatRecord(); rec.field_1_options = field_1_options; return rec;
protected void	fillFields(org.apache.poi.hssf.record.RecordInputStream in) field_1_options = in.readShort();
public short	getOptions() Get the options field for the Dat record. return field_1_options;
public int	getRecordSize() Size of record (exluding 4 byte header) return 4 + 2;
public short	getSid() return sid;
public boolean	isBorder() data table has a border return the border field value. return border.isSet(field_1_options);
public boolean	isHorizontalBorder() has a horizontal border return the horizontal border field value. return horizontalBorder.isSet(field_1_options);
public boolean	isShowSeriesKey() shows the series key return the show series key field value. return showSeriesKey.isSet(field_1_options);
public boolean	isVerticalBorder() has vertical border return the vertical border field value. return verticalBorder.isSet(field_1_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_options); return getRecordSize();
public void	setBorder(boolean value) Sets the border field value. data table has a border field_1_options = border.setShortBoolean(field_1_options, value);
public void	setHorizontalBorder(boolean value) Sets the horizontal border field value. has a horizontal border field_1_options = horizontalBorder.setShortBoolean(field_1_options, value);
public void	setOptions(short field_1_options) Set the options field for the Dat record. this.field_1_options = field_1_options;
public void	setShowSeriesKey(boolean value) Sets the show series key field value. shows the series key field_1_options = showSeriesKey.setShortBoolean(field_1_options, value);
public void	setVerticalBorder(boolean value) Sets the vertical border field value. has vertical border field_1_options = verticalBorder.setShortBoolean(field_1_options, value);
public java.lang.String	toString() StringBuffer buffer = new StringBuffer(); buffer.append("[DAT]\n"); buffer.append(" .options = ") .append("0x").append(HexDump.toHex( getOptions ())) .append(" (").append( getOptions() ).append(" )"); buffer.append(System.getProperty("line.separator")); buffer.append(" .horizontalBorder = ").append(isHorizontalBorder()).append('\n"); buffer.append(" .verticalBorder = ").append(isVerticalBorder()).append('\n"); buffer.append(" .border = ").append(isBorder()).append('\n"); buffer.append(" .showSeriesKey = ").append(isShowSeriesKey()).append('\n"); buffer.append("[/DAT]\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 Dat record"); }