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 package org.apache.poi.hssf.record; 57 58 import org.apache.poi.util.LittleEndian; 59 60 /** 61 * Title: MMS Record<P> 62 * Description: defines how many add menu and del menu options are stored 63 * in the file. Should always be set to 0 for HSSF workbooks<P> 64 * REFERENCE: PG 328 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 65 * @author Andrew C. Oliver (acoliver at apache dot org) 66 * @version 2.0-pre 67 */ 68 69 public class MMSRecord 70 extends Record 71 { 72 public final static short sid = 0xC1; 73 private byte field_1_addMenuCount; // = 0; 74 private byte field_2_delMenuCount; // = 0; 75 76 public MMSRecord() 77 { 78 } 79 80 /** 81 * Constructs a MMS record and sets its fields appropriately. 82 * 83 * @param id id must be 0xc1 or an exception will be throw upon validation 84 * @param size the size of the data area of the record 85 * @param data data of the record (should not contain sid/len) 86 */ 87 88 public MMSRecord(short id, short size, byte [] data) 89 { 90 super(id, size, data); 91 } 92 93 /** 94 * Constructs a MMS record and sets its fields appropriately. 95 * 96 * @param id id must be 0xc1 or an exception will be throw upon validation 97 * @param size the size of the data area of the record 98 * @param data data of the record (should not contain sid/len) 99 * @param offset of the data 100 */ 101 102 public MMSRecord(short id, short size, byte [] data, int offset) 103 { 104 super(id, size, data, offset); 105 } 106 107 protected void validateSid(short id) 108 { 109 if (id != sid) 110 { 111 throw new RecordFormatException("NOT A MMS RECORD"); 112 } 113 } 114 115 protected void fillFields(byte [] data, short size, int offset) 116 { 117 field_1_addMenuCount = data[ 0 + offset ]; 118 field_2_delMenuCount = data[ 1 + offset ]; 119 } 120 121 /** 122 * set number of add menu options (set to 0) 123 * @param am number of add menu options 124 */ 125 126 public void setAddMenuCount(byte am) 127 { 128 field_1_addMenuCount = am; 129 } 130 131 /** 132 * set number of del menu options (set to 0) 133 * @param dm number of del menu options 134 */ 135 136 public void setDelMenuCount(byte dm) 137 { 138 field_2_delMenuCount = dm; 139 } 140 141 /** 142 * get number of add menu options (should be 0) 143 * @return number of add menu options 144 */ 145 146 public byte getAddMenuCount() 147 { 148 return field_1_addMenuCount; 149 } 150 151 /** 152 * get number of add del options (should be 0) 153 * @return number of add menu options 154 */ 155 156 public byte getDelMenuCount() 157 { 158 return field_2_delMenuCount; 159 } 160 161 public String toString() 162 { 163 StringBuffer buffer = new StringBuffer(); 164 165 buffer.append("[MMS]\n"); 166 buffer.append(" .addMenu = ") 167 .append(Integer.toHexString(getAddMenuCount())).append("\n"); 168 buffer.append(" .delMenu = ") 169 .append(Integer.toHexString(getDelMenuCount())).append("\n"); 170 buffer.append("[/MMS]\n"); 171 return buffer.toString(); 172 } 173 174 public int serialize(int offset, byte [] data) 175 { 176 LittleEndian.putShort(data, 0 + offset, sid); 177 LittleEndian.putShort(data, 2 + offset, 178 (( short ) 0x02)); // 2 bytes (6 total) 179 data[ 4 + offset ] = getAddMenuCount(); 180 data[ 5 + offset ] = getDelMenuCount(); 181 return getRecordSize(); 182 } 183 184 public int getRecordSize() 185 { 186 return 6; 187 } 188 189 public short getSid() 190 { 191 return this.sid; 192 } 193 } 194