1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   
57   package org.apache.poi.hssf.record;
58   
59   
60   
61   import org.apache.poi.util.*;
62   
63   /**
64    * The font basis record stores various font metrics.
65    * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
66    *       remove the record in src/records/definitions.
67   
68    * @author Glen Stampoultzis (glens at apache.org)
69    */
70   public class FontBasisRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1060;
74       private  short      field_1_xBasis;
75       private  short      field_2_yBasis;
76       private  short      field_3_heightBasis;
77       private  short      field_4_scale;
78       private  short      field_5_indexToFontTable;
79   
80   
81       public FontBasisRecord()
82       {
83   
84       }
85   
86       /**
87        * Constructs a FontBasis record and sets its fields appropriately.
88        *
89        * @param id    id must be 0x1060 or an exception
90        *              will be throw upon validation
91        * @param size  size the size of the data area of the record
92        * @param data  data of the record (should not contain sid/len)
93        */
94   
95       public FontBasisRecord(short id, short size, byte [] data)
96       {
97           super(id, size, data);
98       }
99   
100      /**
101       * Constructs a FontBasis record and sets its fields appropriately.
102       *
103       * @param id    id must be 0x1060 or an exception
104       *              will be throw upon validation
105       * @param size  size the size of the data area of the record
106       * @param data  data of the record (should not contain sid/len)
107       * @param offset of the record's data
108       */
109  
110      public FontBasisRecord(short id, short size, byte [] data, int offset)
111      {
112          super(id, size, data, offset);
113      }
114  
115      /**
116       * Checks the sid matches the expected side for this record
117       *
118       * @param id   the expected sid.
119       */
120      protected void validateSid(short id)
121      {
122          if (id != sid)
123          {
124              throw new RecordFormatException("Not a FontBasis record");
125          }
126      }
127  
128      protected void fillFields(byte [] data, short size, int offset)
129      {
130          field_1_xBasis                  = LittleEndian.getShort(data, 0x0 + offset);
131          field_2_yBasis                  = LittleEndian.getShort(data, 0x2 + offset);
132          field_3_heightBasis             = LittleEndian.getShort(data, 0x4 + offset);
133          field_4_scale                   = LittleEndian.getShort(data, 0x6 + offset);
134          field_5_indexToFontTable        = LittleEndian.getShort(data, 0x8 + offset);
135  
136      }
137  
138      public String toString()
139      {
140          StringBuffer buffer = new StringBuffer();
141  
142          buffer.append("[FontBasis]\n");
143  
144          buffer.append("    .xBasis               = ")
145              .append("0x")
146              .append(HexDump.toHex((short)getXBasis()))
147              .append(" (").append(getXBasis()).append(" )\n");
148  
149          buffer.append("    .yBasis               = ")
150              .append("0x")
151              .append(HexDump.toHex((short)getYBasis()))
152              .append(" (").append(getYBasis()).append(" )\n");
153  
154          buffer.append("    .heightBasis          = ")
155              .append("0x")
156              .append(HexDump.toHex((short)getHeightBasis()))
157              .append(" (").append(getHeightBasis()).append(" )\n");
158  
159          buffer.append("    .scale                = ")
160              .append("0x")
161              .append(HexDump.toHex((short)getScale()))
162              .append(" (").append(getScale()).append(" )\n");
163  
164          buffer.append("    .indexToFontTable     = ")
165              .append("0x")
166              .append(HexDump.toHex((short)getIndexToFontTable()))
167              .append(" (").append(getIndexToFontTable()).append(" )\n");
168  
169          buffer.append("[/FontBasis]\n");
170          return buffer.toString();
171      }
172  
173      public int serialize(int offset, byte[] data)
174      {
175          LittleEndian.putShort(data, 0 + offset, sid);
176          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
177  
178          LittleEndian.putShort(data, 4 + offset, field_1_xBasis);
179          LittleEndian.putShort(data, 6 + offset, field_2_yBasis);
180          LittleEndian.putShort(data, 8 + offset, field_3_heightBasis);
181          LittleEndian.putShort(data, 10 + offset, field_4_scale);
182          LittleEndian.putShort(data, 12 + offset, field_5_indexToFontTable);
183  
184          return getRecordSize();
185      }
186  
187      /**
188       * Size of record (exluding 4 byte header)
189       */
190      public int getRecordSize()
191      {
192          return 4 + 2 + 2 + 2 + 2 + 2;
193      }
194  
195      public short getSid()
196      {
197          return this.sid;
198      }
199  
200  
201      /**
202       * Get the x Basis field for the FontBasis record.
203       */
204      public short getXBasis()
205      {
206          return field_1_xBasis;
207      }
208  
209      /**
210       * Set the x Basis field for the FontBasis record.
211       */
212      public void setXBasis(short field_1_xBasis)
213      {
214          this.field_1_xBasis = field_1_xBasis;
215      }
216  
217      /**
218       * Get the y Basis field for the FontBasis record.
219       */
220      public short getYBasis()
221      {
222          return field_2_yBasis;
223      }
224  
225      /**
226       * Set the y Basis field for the FontBasis record.
227       */
228      public void setYBasis(short field_2_yBasis)
229      {
230          this.field_2_yBasis = field_2_yBasis;
231      }
232  
233      /**
234       * Get the height basis field for the FontBasis record.
235       */
236      public short getHeightBasis()
237      {
238          return field_3_heightBasis;
239      }
240  
241      /**
242       * Set the height basis field for the FontBasis record.
243       */
244      public void setHeightBasis(short field_3_heightBasis)
245      {
246          this.field_3_heightBasis = field_3_heightBasis;
247      }
248  
249      /**
250       * Get the scale field for the FontBasis record.
251       */
252      public short getScale()
253      {
254          return field_4_scale;
255      }
256  
257      /**
258       * Set the scale field for the FontBasis record.
259       */
260      public void setScale(short field_4_scale)
261      {
262          this.field_4_scale = field_4_scale;
263      }
264  
265      /**
266       * Get the index to font table field for the FontBasis record.
267       */
268      public short getIndexToFontTable()
269      {
270          return field_5_indexToFontTable;
271      }
272  
273      /**
274       * Set the index to font table field for the FontBasis record.
275       */
276      public void setIndexToFontTable(short field_5_indexToFontTable)
277      {
278          this.field_5_indexToFontTable = field_5_indexToFontTable;
279      }
280  
281  
282  }  // END OF CLASS
283  
284  
285  
286  
287