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 * Record for the bottom margin. 65 * NOTE: This source was automatically generated. 66 * @author Shawn Laubach (shawnlaubach at cox.net) 67 */ 68 public class BottomMarginRecord 69 extends Record implements Margin 70 { 71 public final static short sid = 0x29; 72 private double field_1_margin; 73 74 75 public BottomMarginRecord() 76 { 77 78 } 79 80 /** 81 * Constructs a BottomMargin record and sets its fields appropriately. 82 * 83 * @param id id must be 0x29 or an exception 84 * will be throw upon validation 85 * @param size size the size of the data area of the record 86 * @param data data of the record (should not contain sid/len) 87 */ 88 89 public BottomMarginRecord(short id, short size, byte [] data) 90 { 91 super(id, size, data); 92 } 93 94 /** 95 * Constructs a BottomMargin record and sets its fields appropriately. 96 * 97 * @param id id must be 0x29 or an exception 98 * will be throw upon validation 99 * @param size size the size of the data area of the record 100 * @param data data of the record (should not contain sid/len) 101 * @param offset of the record's data 102 */ 103 104 public BottomMarginRecord(short id, short size, byte [] data, int offset) 105 { 106 super(id, size, data, offset); 107 } 108 109 /** 110 * Checks the sid matches the expected side for this record 111 * 112 * @param id the expected sid. 113 */ 114 protected void validateSid(short id) 115 { 116 if (id != sid) 117 { 118 throw new RecordFormatException("Not a BottomMargin record"); 119 } 120 } 121 122 protected void fillFields(byte [] data, short size, int offset) 123 { 124 field_1_margin = LittleEndian.getDouble(data, 0x0 + offset); 125 126 } 127 128 public String toString() 129 { 130 StringBuffer buffer = new StringBuffer(); 131 132 buffer.append("[BottomMargin]\n"); 133 134 buffer.append(" .margin = ") 135 .append(" (").append(getMargin()).append(" )\n"); 136 137 buffer.append("[/BottomMargin]\n"); 138 return buffer.toString(); 139 } 140 141 public int serialize(int offset, byte[] data) 142 { 143 LittleEndian.putShort(data, 0 + offset, sid); 144 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 145 146 LittleEndian.putDouble(data, 4 + offset, field_1_margin); 147 148 return getRecordSize(); 149 } 150 151 /** 152 * Size of record (exluding 4 byte header) 153 */ 154 public int getRecordSize() 155 { 156 return 4 + 8; 157 } 158 159 public short getSid() 160 { 161 return this.sid; 162 } 163 164 165 /** 166 * Get the margin field for the BottomMargin record. 167 */ 168 public double getMargin() 169 { 170 return field_1_margin; 171 } 172 173 /** 174 * Set the margin field for the BottomMargin record. 175 */ 176 public void setMargin(double field_1_margin) 177 { 178 this.field_1_margin = field_1_margin; 179 } 180 181 182 } // END OF CLASS 183 184 185 186 187