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

CategorySeriesAxisRecord

• 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_crossingPoint
private short	field_2_labelFrequency
private short	field_3_tickMarkFrequency
private short	field_4_options
private BitField	valueAxisCrossing
private BitField	crossesFarRight
private BitField	reversed

Constructors Summary
public CategorySeriesAxisRecord()
public CategorySeriesAxisRecord(RecordInputStream in) Constructs a CategorySeriesAxis record and sets its fields appropriately. param id id must be 0x1020 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() CategorySeriesAxisRecord rec = new CategorySeriesAxisRecord(); rec.field_1_crossingPoint = field_1_crossingPoint; rec.field_2_labelFrequency = field_2_labelFrequency; rec.field_3_tickMarkFrequency = field_3_tickMarkFrequency; rec.field_4_options = field_4_options; return rec;
protected void	fillFields(org.apache.poi.hssf.record.RecordInputStream in) field_1_crossingPoint = in.readShort(); field_2_labelFrequency = in.readShort(); field_3_tickMarkFrequency = in.readShort(); field_4_options = in.readShort();
public short	getCrossingPoint() Get the crossing point field for the CategorySeriesAxis record. return field_1_crossingPoint;
public short	getLabelFrequency() Get the label frequency field for the CategorySeriesAxis record. return field_2_labelFrequency;
public short	getOptions() Get the options field for the CategorySeriesAxis record. return field_4_options;
public int	getRecordSize() Size of record (exluding 4 byte header) return 4 + 2 + 2 + 2 + 2;
public short	getSid() return sid;
public short	getTickMarkFrequency() Get the tick mark frequency field for the CategorySeriesAxis record. return field_3_tickMarkFrequency;
public boolean	isCrossesFarRight() axis crosses at the far right return the crosses far right field value. return crossesFarRight.isSet(field_4_options);
public boolean	isReversed() categories are displayed in reverse order return the reversed field value. return reversed.isSet(field_4_options);
public boolean	isValueAxisCrossing() set true to indicate axis crosses between categories and false to cross axis midway return the value axis crossing field value. return valueAxisCrossing.isSet(field_4_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_crossingPoint); LittleEndian.putShort(data, 6 + offset + pos, field_2_labelFrequency); LittleEndian.putShort(data, 8 + offset + pos, field_3_tickMarkFrequency); LittleEndian.putShort(data, 10 + offset + pos, field_4_options); return getRecordSize();
public void	setCrossesFarRight(boolean value) Sets the crosses far right field value. axis crosses at the far right field_4_options = crossesFarRight.setShortBoolean(field_4_options, value);
public void	setCrossingPoint(short field_1_crossingPoint) Set the crossing point field for the CategorySeriesAxis record. this.field_1_crossingPoint = field_1_crossingPoint;
public void	setLabelFrequency(short field_2_labelFrequency) Set the label frequency field for the CategorySeriesAxis record. this.field_2_labelFrequency = field_2_labelFrequency;
public void	setOptions(short field_4_options) Set the options field for the CategorySeriesAxis record. this.field_4_options = field_4_options;
public void	setReversed(boolean value) Sets the reversed field value. categories are displayed in reverse order field_4_options = reversed.setShortBoolean(field_4_options, value);
public void	setTickMarkFrequency(short field_3_tickMarkFrequency) Set the tick mark frequency field for the CategorySeriesAxis record. this.field_3_tickMarkFrequency = field_3_tickMarkFrequency;
public void	setValueAxisCrossing(boolean value) Sets the value axis crossing field value. set true to indicate axis crosses between categories and false to cross axis midway field_4_options = valueAxisCrossing.setShortBoolean(field_4_options, value);
public java.lang.String	toString() StringBuffer buffer = new StringBuffer(); buffer.append("[CATSERRANGE]\n"); buffer.append(" .crossingPoint = ") .append("0x").append(HexDump.toHex( getCrossingPoint ())) .append(" (").append( getCrossingPoint() ).append(" )"); buffer.append(System.getProperty("line.separator")); buffer.append(" .labelFrequency = ") .append("0x").append(HexDump.toHex( getLabelFrequency ())) .append(" (").append( getLabelFrequency() ).append(" )"); buffer.append(System.getProperty("line.separator")); buffer.append(" .tickMarkFrequency = ") .append("0x").append(HexDump.toHex( getTickMarkFrequency ())) .append(" (").append( getTickMarkFrequency() ).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(" .valueAxisCrossing = ").append(isValueAxisCrossing()).append('\n"); buffer.append(" .crossesFarRight = ").append(isCrossesFarRight()).append('\n"); buffer.append(" .reversed = ").append(isReversed()).append('\n"); buffer.append("[/CATSERRANGE]\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 CategorySeriesAxis record"); }