src/java/org/apache/poi/hssf/record/AreaRecord.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 area record is used to define a area chart.
  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 AreaRecord
  34     extends Record
  35 {
  36     public final static short      sid                             = 0x101A;
  37     private  short      field_1_formatFlags;
  38     private  BitField   stacked                                     = BitFieldFactory.getInstance(0x1);
  39     private  BitField   displayAsPercentage                         = BitFieldFactory.getInstance(0x2);
  40     private  BitField   shadow                                      = BitFieldFactory.getInstance(0x4);
  41
  42
  43     public AreaRecord()
  44     {
  45
  46     }
  47
  48     /**
  49      * Constructs a Area record and sets its fields appropriately.
  50      *
  51      * @param in the RecordInputstream to read the record from
  52      */
  53
  54     public AreaRecord(RecordInputStream in)
  55     {
  56         super(in);
  57
  58     }
  59
  60     /**
  61      * Checks the sid matches the expected side for this record
  62      *
  63      * @param id   the expected sid.
  64      */
  65     protected void validateSid(short id)
  66     {
  67         if (id != sid)
  68         {
  69             throw new RecordFormatException("Not a Area record");
  70         }
  71     }
  72
  73     protected void fillFields(RecordInputStream in)
  74     {
  75
  76         field_1_formatFlags            = in.readShort();
  77     }
  78
  79     public String toString()
  80     {
  81         StringBuffer buffer = new StringBuffer();
  82
  83         buffer.append("[AREA]\n");
  84         buffer.append("    .formatFlags          = ")
  85             .append("0x").append(HexDump.toHex(  getFormatFlags ()))
  86             .append(" (").append( getFormatFlags() ).append(" )");
  87         buffer.append(System.getProperty("line.separator"));
  88         buffer.append("         .stacked                  = ").append(isStacked()).append('\n');
  89         buffer.append("         .displayAsPercentage      = ").append(isDisplayAsPercentage()).append('\n');
  90         buffer.append("         .shadow                   = ").append(isShadow()).append('\n');
  91
  92         buffer.append("[/AREA]\n");
  93         return buffer.toString();
  94     }
  95
  96     public int serialize(int offset, byte[] data)
  97     {
  98         int pos = 0;
  99
 100         LittleEndian.putShort(data, 0 + offset, sid);
 101         LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
 102
 103         LittleEndian.putShort(data, 4 + offset + pos, field_1_formatFlags);
 104
 105         return getRecordSize();
 106     }
 107
 108     /**
 109      * Size of record (exluding 4 byte header)
 110      */
 111     public int getRecordSize()
 112     {
 113         return 4  + 2;
 114     }
 115
 116     public short getSid()
 117     {
 118         return sid;
 119     }
 120
 121     public Object clone() {
 122         AreaRecord rec = new AreaRecord();
 123
 124         rec.field_1_formatFlags = field_1_formatFlags;
 125         return rec;
 126     }
 127
 128
 129
 130
 131     /**
 132      * Get the format flags field for the Area record.
 133      */
 134     public short getFormatFlags()
 135     {
 136         return field_1_formatFlags;
 137     }
 138
 139     /**
 140      * Set the format flags field for the Area record.
 141      */
 142     public void setFormatFlags(short field_1_formatFlags)
 143     {
 144         this.field_1_formatFlags = field_1_formatFlags;
 145     }
 146
 147     /**
 148      * Sets the stacked field value.
 149      * series is stacked
 150      */
 151     public void setStacked(boolean value)
 152     {
 153         field_1_formatFlags = stacked.setShortBoolean(field_1_formatFlags, value);
 154     }
 155
 156     /**
 157      * series is stacked
 158      * @return  the stacked field value.
 159      */
 160     public boolean isStacked()
 161     {
 162         return stacked.isSet(field_1_formatFlags);
 163     }
 164
 165     /**
 166      * Sets the display as percentage field value.
 167      * results displayed as percentages
 168      */
 169     public void setDisplayAsPercentage(boolean value)
 170     {
 171         field_1_formatFlags = displayAsPercentage.setShortBoolean(field_1_formatFlags, value);
 172     }
 173
 174     /**
 175      * results displayed as percentages
 176      * @return  the display as percentage field value.
 177      */
 178     public boolean isDisplayAsPercentage()
 179     {
 180         return displayAsPercentage.isSet(field_1_formatFlags);
 181     }
 182
 183     /**
 184      * Sets the shadow field value.
 185      * display a shadow for the chart
 186      */
 187     public void setShadow(boolean value)
 188     {
 189         field_1_formatFlags = shadow.setShortBoolean(field_1_formatFlags, value);
 190     }
 191
 192     /**
 193      * display a shadow for the chart
 194      * @return  the shadow field value.
 195      */
 196     public boolean isShadow()
 197     {
 198         return shadow.isSet(field_1_formatFlags);
 199     }
 200
 201
 202 }  // END OF CLASS
 203
 204
 205
 206