src/java/org/apache/poi/hssf/record/FontBasisRecord.java

   1
   2 /* ====================================================================
   3    Licensed to the Apache Software Foundation (ASF) under one or more
   4    contributor license agreements.  See the NOTICE file distributed with
   5    this work for additional information regarding copyright ownership.
   6    The ASF licenses this file to You under the Apache License, Version 2.0
   7    (the "License"); you may not use this file except in compliance with
   8    the License.  You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================== */
  18
  19
  20 package org.apache.poi.hssf.record;
  21
  22
  23
  24 import org.apache.poi.util.*;
  25
  26 /**
  27  * The font basis record stores various font metrics.
  28  * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
  29  *       remove the record in src/records/definitions.
  30
  31  * @author Glen Stampoultzis (glens at apache.org)
  32  */
  33 public class FontBasisRecord
  34     extends Record
  35 {
  36     public final static short      sid                             = 0x1060;
  37     private  short      field_1_xBasis;
  38     private  short      field_2_yBasis;
  39     private  short      field_3_heightBasis;
  40     private  short      field_4_scale;
  41     private  short      field_5_indexToFontTable;
  42
  43
  44     public FontBasisRecord()
  45     {
  46
  47     }
  48
  49     /**
  50      * Constructs a FontBasis record and sets its fields appropriately.
  51      *
  52      * @param in the RecordInputstream to read the record from
  53      */
  54
  55     public FontBasisRecord(RecordInputStream in)
  56     {
  57         super(in);
  58
  59     }
  60
  61     /**
  62      * Checks the sid matches the expected side for this record
  63      *
  64      * @param id   the expected sid.
  65      */
  66     protected void validateSid(short id)
  67     {
  68         if (id != sid)
  69         {
  70             throw new RecordFormatException("Not a FontBasis record");
  71         }
  72     }
  73
  74     protected void fillFields(RecordInputStream in)
  75     {
  76         field_1_xBasis                 = in.readShort();
  77         field_2_yBasis                 = in.readShort();
  78         field_3_heightBasis            = in.readShort();
  79         field_4_scale                  = in.readShort();
  80         field_5_indexToFontTable       = in.readShort();
  81     }
  82
  83     public String toString()
  84     {
  85         StringBuffer buffer = new StringBuffer();
  86
  87         buffer.append("[FBI]\n");
  88         buffer.append("    .xBasis               = ")
  89             .append("0x").append(HexDump.toHex(  getXBasis ()))
  90             .append(" (").append( getXBasis() ).append(" )");
  91         buffer.append(System.getProperty("line.separator"));
  92         buffer.append("    .yBasis               = ")
  93             .append("0x").append(HexDump.toHex(  getYBasis ()))
  94             .append(" (").append( getYBasis() ).append(" )");
  95         buffer.append(System.getProperty("line.separator"));
  96         buffer.append("    .heightBasis          = ")
  97             .append("0x").append(HexDump.toHex(  getHeightBasis ()))
  98             .append(" (").append( getHeightBasis() ).append(" )");
  99         buffer.append(System.getProperty("line.separator"));
 100         buffer.append("    .scale                = ")
 101             .append("0x").append(HexDump.toHex(  getScale ()))
 102             .append(" (").append( getScale() ).append(" )");
 103         buffer.append(System.getProperty("line.separator"));
 104         buffer.append("    .indexToFontTable     = ")
 105             .append("0x").append(HexDump.toHex(  getIndexToFontTable ()))
 106             .append(" (").append( getIndexToFontTable() ).append(" )");
 107         buffer.append(System.getProperty("line.separator"));
 108
 109         buffer.append("[/FBI]\n");
 110         return buffer.toString();
 111     }
 112
 113     public int serialize(int offset, byte[] data)
 114     {
 115         int pos = 0;
 116
 117         LittleEndian.putShort(data, 0 + offset, sid);
 118         LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
 119
 120         LittleEndian.putShort(data, 4 + offset + pos, field_1_xBasis);
 121         LittleEndian.putShort(data, 6 + offset + pos, field_2_yBasis);
 122         LittleEndian.putShort(data, 8 + offset + pos, field_3_heightBasis);
 123         LittleEndian.putShort(data, 10 + offset + pos, field_4_scale);
 124         LittleEndian.putShort(data, 12 + offset + pos, field_5_indexToFontTable);
 125
 126         return getRecordSize();
 127     }
 128
 129     /**
 130      * Size of record (exluding 4 byte header)
 131      */
 132     public int getRecordSize()
 133     {
 134         return 4  + 2 + 2 + 2 + 2 + 2;
 135     }
 136
 137     public short getSid()
 138     {
 139         return sid;
 140     }
 141
 142     public Object clone() {
 143         FontBasisRecord rec = new FontBasisRecord();
 144
 145         rec.field_1_xBasis = field_1_xBasis;
 146         rec.field_2_yBasis = field_2_yBasis;
 147         rec.field_3_heightBasis = field_3_heightBasis;
 148         rec.field_4_scale = field_4_scale;
 149         rec.field_5_indexToFontTable = field_5_indexToFontTable;
 150         return rec;
 151     }
 152
 153
 154
 155
 156     /**
 157      * Get the x Basis field for the FontBasis record.
 158      */
 159     public short getXBasis()
 160     {
 161         return field_1_xBasis;
 162     }
 163
 164     /**
 165      * Set the x Basis field for the FontBasis record.
 166      */
 167     public void setXBasis(short field_1_xBasis)
 168     {
 169         this.field_1_xBasis = field_1_xBasis;
 170     }
 171
 172     /**
 173      * Get the y Basis field for the FontBasis record.
 174      */
 175     public short getYBasis()
 176     {
 177         return field_2_yBasis;
 178     }
 179
 180     /**
 181      * Set the y Basis field for the FontBasis record.
 182      */
 183     public void setYBasis(short field_2_yBasis)
 184     {
 185         this.field_2_yBasis = field_2_yBasis;
 186     }
 187
 188     /**
 189      * Get the height basis field for the FontBasis record.
 190      */
 191     public short getHeightBasis()
 192     {
 193         return field_3_heightBasis;
 194     }
 195
 196     /**
 197      * Set the height basis field for the FontBasis record.
 198      */
 199     public void setHeightBasis(short field_3_heightBasis)
 200     {
 201         this.field_3_heightBasis = field_3_heightBasis;
 202     }
 203
 204     /**
 205      * Get the scale field for the FontBasis record.
 206      */
 207     public short getScale()
 208     {
 209         return field_4_scale;
 210     }
 211
 212     /**
 213      * Set the scale field for the FontBasis record.
 214      */
 215     public void setScale(short field_4_scale)
 216     {
 217         this.field_4_scale = field_4_scale;
 218     }
 219
 220     /**
 221      * Get the index to font table field for the FontBasis record.
 222      */
 223     public short getIndexToFontTable()
 224     {
 225         return field_5_indexToFontTable;
 226     }
 227
 228     /**
 229      * Set the index to font table field for the FontBasis record.
 230      */
 231     public void setIndexToFontTable(short field_5_indexToFontTable)
 232     {
 233         this.field_5_indexToFontTable = field_5_indexToFontTable;
 234     }
 235
 236
 237 }  // END OF CLASS
 238
 239
 240
 241