001: /* ====================================================================
002: Licensed to the Apache Software Foundation (ASF) under one or more
003: contributor license agreements. See the NOTICE file distributed with
004: this work for additional information regarding copyright ownership.
005: The ASF licenses this file to You under the Apache License, Version 2.0
006: (the "License"); you may not use this file except in compliance with
007: the License. You may obtain a copy of the License at
008:
009: http://www.apache.org/licenses/LICENSE-2.0
010:
011: Unless required by applicable law or agreed to in writing, software
012: distributed under the License is distributed on an "AS IS" BASIS,
013: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: See the License for the specific language governing permissions and
015: limitations under the License.
016: ==================================================================== */
017:
018: package org.apache.poi.hssf.record;
019:
020: import org.apache.poi.util.*;
021:
022: /**
023: * The default data label text properties record identifies the text characteristics of the preceeding text record.
024: * NOTE: This source is automatically generated please do not modify this file. Either subclass or
025: * remove the record in src/records/definitions.
026:
027: * @author Glen Stampoultzis (glens at apache.org)
028: */
029: public class DefaultDataLabelTextPropertiesRecord extends Record {
030: public final static short sid = 0x1024;
031: private short field_1_categoryDataType;
032: public final static short CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC = 0;
033: public final static short CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC = 1;
034: public final static short CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC = 2;
035:
036: public DefaultDataLabelTextPropertiesRecord() {
037:
038: }
039:
040: /**
041: * Constructs a DefaultDataLabelTextProperties record and sets its fields appropriately.
042: *
043: * @param in the RecordInputstream to read the record from
044: */
045:
046: public DefaultDataLabelTextPropertiesRecord(RecordInputStream in) {
047: super (in);
048:
049: }
050:
051: /**
052: * Checks the sid matches the expected side for this record
053: *
054: * @param id the expected sid.
055: */
056: protected void validateSid(short id) {
057: if (id != sid) {
058: throw new RecordFormatException(
059: "Not a DefaultDataLabelTextProperties record");
060: }
061: }
062:
063: protected void fillFields(RecordInputStream in) {
064: field_1_categoryDataType = in.readShort();
065: }
066:
067: public String toString() {
068: StringBuffer buffer = new StringBuffer();
069:
070: buffer.append("[DEFAULTTEXT]\n");
071: buffer.append(" .categoryDataType = ").append("0x")
072: .append(HexDump.toHex(getCategoryDataType())).append(
073: " (").append(getCategoryDataType())
074: .append(" )");
075: buffer.append(System.getProperty("line.separator"));
076:
077: buffer.append("[/DEFAULTTEXT]\n");
078: return buffer.toString();
079: }
080:
081: public int serialize(int offset, byte[] data) {
082: int pos = 0;
083:
084: LittleEndian.putShort(data, 0 + offset, sid);
085: LittleEndian.putShort(data, 2 + offset,
086: (short) (getRecordSize() - 4));
087:
088: LittleEndian.putShort(data, 4 + offset + pos,
089: field_1_categoryDataType);
090:
091: return getRecordSize();
092: }
093:
094: /**
095: * Size of record (exluding 4 byte header)
096: */
097: public int getRecordSize() {
098: return 4 + 2;
099: }
100:
101: public short getSid() {
102: return sid;
103: }
104:
105: public Object clone() {
106: DefaultDataLabelTextPropertiesRecord rec = new DefaultDataLabelTextPropertiesRecord();
107:
108: rec.field_1_categoryDataType = field_1_categoryDataType;
109: return rec;
110: }
111:
112: /**
113: * Get the category data type field for the DefaultDataLabelTextProperties record.
114: *
115: * @return One of
116: * CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC
117: * CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC
118: * CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
119: */
120: public short getCategoryDataType() {
121: return field_1_categoryDataType;
122: }
123:
124: /**
125: * Set the category data type field for the DefaultDataLabelTextProperties record.
126: *
127: * @param field_1_categoryDataType
128: * One of
129: * CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC
130: * CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC
131: * CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
132: */
133: public void setCategoryDataType(short field_1_categoryDataType) {
134: this .field_1_categoryDataType = field_1_categoryDataType;
135: }
136:
137: } // END OF CLASS
|