| /* ==================================================================== |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| ==================================================================== */ |
| |
| package org.apache.poi.hssf.record.chart; |
| |
| import java.util.Map; |
| import java.util.function.Supplier; |
| |
| import org.apache.poi.hssf.record.HSSFRecordTypes; |
| import org.apache.poi.hssf.record.RecordInputStream; |
| import org.apache.poi.hssf.record.StandardRecord; |
| import org.apache.poi.util.BitField; |
| import org.apache.poi.util.BitFieldFactory; |
| import org.apache.poi.util.GenericRecordUtil; |
| import org.apache.poi.util.LittleEndianOutput; |
| |
| /** |
| * The area record is used to define a area chart. |
| */ |
| public final class AreaRecord extends StandardRecord { |
| public static final short sid = 0x101A; |
| private static final BitField stacked = BitFieldFactory.getInstance(0x1); |
| private static final BitField displayAsPercentage = BitFieldFactory.getInstance(0x2); |
| private static final BitField shadow = BitFieldFactory.getInstance(0x4); |
| |
| private short field_1_formatFlags; |
| |
| |
| public AreaRecord() {} |
| |
| public AreaRecord(AreaRecord other) { |
| super(other); |
| field_1_formatFlags = other.field_1_formatFlags; |
| } |
| |
| public AreaRecord(RecordInputStream in) { |
| field_1_formatFlags = in.readShort(); |
| } |
| |
| public void serialize(LittleEndianOutput out) { |
| out.writeShort(field_1_formatFlags); |
| } |
| |
| protected int getDataSize() { |
| return 2; |
| } |
| |
| public short getSid() |
| { |
| return sid; |
| } |
| |
| /** |
| * Get the format flags field for the Area record. |
| */ |
| public short getFormatFlags() |
| { |
| return field_1_formatFlags; |
| } |
| |
| /** |
| * Set the format flags field for the Area record. |
| */ |
| public void setFormatFlags(short field_1_formatFlags) |
| { |
| this.field_1_formatFlags = field_1_formatFlags; |
| } |
| |
| /** |
| * Sets the stacked field value. |
| * series is stacked |
| */ |
| public void setStacked(boolean value) |
| { |
| field_1_formatFlags = stacked.setShortBoolean(field_1_formatFlags, value); |
| } |
| |
| /** |
| * series is stacked |
| * @return the stacked field value. |
| */ |
| public boolean isStacked() |
| { |
| return stacked.isSet(field_1_formatFlags); |
| } |
| |
| /** |
| * Sets the display as percentage field value. |
| * results displayed as percentages |
| */ |
| public void setDisplayAsPercentage(boolean value) |
| { |
| field_1_formatFlags = displayAsPercentage.setShortBoolean(field_1_formatFlags, value); |
| } |
| |
| /** |
| * results displayed as percentages |
| * @return the display as percentage field value. |
| */ |
| public boolean isDisplayAsPercentage() |
| { |
| return displayAsPercentage.isSet(field_1_formatFlags); |
| } |
| |
| /** |
| * Sets the shadow field value. |
| * display a shadow for the chart |
| */ |
| public void setShadow(boolean value) |
| { |
| field_1_formatFlags = shadow.setShortBoolean(field_1_formatFlags, value); |
| } |
| |
| /** |
| * display a shadow for the chart |
| * @return the shadow field value. |
| */ |
| public boolean isShadow() |
| { |
| return shadow.isSet(field_1_formatFlags); |
| } |
| |
| @Override |
| public AreaRecord copy() { |
| return new AreaRecord(this); |
| } |
| |
| @Override |
| public HSSFRecordTypes getGenericRecordType() { |
| return HSSFRecordTypes.AREA; |
| } |
| |
| @Override |
| public Map<String, Supplier<?>> getGenericProperties() { |
| return GenericRecordUtil.getGenericProperties( |
| "formatFlags", this::getFormatFlags, |
| "stacked", this::isStacked, |
| "displayAsPercentage", this::isDisplayAsPercentage, |
| "shadow", this::isShadow |
| ); |
| } |
| } |