main/src/main/java/org/apache/poi/ddf/EscherSplitMenuColorsRecord.java

/* ====================================================================
   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.ddf;

import java.util.Map;
import java.util.function.Supplier;

import org.apache.poi.util.GenericRecordUtil;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.RecordFormatException;

/**
 * A list of the most recently used colours for the drawings contained in
 * this document.
 */
public class EscherSplitMenuColorsRecord extends EscherRecord {
    public static final short RECORD_ID = EscherRecordTypes.SPLIT_MENU_COLORS.typeID;

    private int field_1_color1;
    private int field_2_color2;
    private int field_3_color3;
    private int field_4_color4;

    public EscherSplitMenuColorsRecord() {}

    public EscherSplitMenuColorsRecord(EscherSplitMenuColorsRecord other) {
        super(other);
        field_1_color1 = other.field_1_color1;
        field_2_color2 = other.field_2_color2;
        field_3_color3 = other.field_3_color3;
        field_4_color4 = other.field_4_color4;
    }

    @Override
    public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) {
        int bytesRemaining = readHeader( data, offset );
        int pos            = offset + 8;
        int size           = 0;
        field_1_color1 =  LittleEndian.getInt( data, pos + size );size+=4;
        field_2_color2 =  LittleEndian.getInt( data, pos + size );size+=4;
        field_3_color3 =  LittleEndian.getInt( data, pos + size );size+=4;
        field_4_color4 =  LittleEndian.getInt( data, pos + size );size+=4;
        bytesRemaining -= size;
        if (bytesRemaining != 0) {
            throw new RecordFormatException("Expecting no remaining data but got " + bytesRemaining + " byte(s).");
        }
        return 8 + size + bytesRemaining;
    }

    @Override
    public int serialize( int offset, byte[] data, EscherSerializationListener listener ) {
//        int field_2_numIdClusters = field_5_fileIdClusters.length + 1;
        listener.beforeRecordSerialize( offset, getRecordId(), this );

        int pos = offset;
        LittleEndian.putShort( data, pos, getOptions() );     pos += 2;
        LittleEndian.putShort( data, pos, getRecordId() );    pos += 2;
        int remainingBytes =  getRecordSize() - 8;

        LittleEndian.putInt( data, pos, remainingBytes );          pos += 4;
        LittleEndian.putInt( data, pos, field_1_color1 );          pos += 4;
        LittleEndian.putInt( data, pos, field_2_color2 );          pos += 4;
        LittleEndian.putInt( data, pos, field_3_color3 );          pos += 4;
        LittleEndian.putInt( data, pos, field_4_color4 );          pos += 4;
        listener.afterRecordSerialize( pos, getRecordId(), pos - offset, this );
        return getRecordSize();
    }

    @Override
    public int getRecordSize() {
        return 8 + 4 * 4;
    }

    @Override
    public short getRecordId() {
        return RECORD_ID;
    }

    @Override
    public String getRecordName() {
        return EscherRecordTypes.SPLIT_MENU_COLORS.recordName;
    }

    /**
     * Gets the fill color
     *
     * @return the fill color
     */
    public int getColor1() {
        return field_1_color1;
    }

    /**
     * Sets the fill color
     *
     * @param field_1_color1 the fill color
     */
    public void setColor1( int field_1_color1 ) {
        this.field_1_color1 = field_1_color1;
    }

    /**
     * Gets the line color
     *
     * @return the line color
     */
    public int getColor2() {
        return field_2_color2;
    }

    /**
     * Sets the line color
     *
     * @param field_2_color2 the line color
     */
    public void setColor2( int field_2_color2 ) {
        this.field_2_color2 = field_2_color2;
    }

    /**
     * Gets the shadow color
     *
     * @return the shadow color
     */
    public int getColor3() {
        return field_3_color3;
    }

    /**
     * Sets the shadow color
     *
     * @param field_3_color3 the shadow color
     */
    public void setColor3( int field_3_color3 ) {
        this.field_3_color3 = field_3_color3;
    }

    /**
     * Gets the 3-D color
     *
     * @return the 3-D color
     */
    public int getColor4() {
        return field_4_color4;
    }

    /**
     * Sets the 3-D color
     *
     * @param field_4_color4 the 3-D color
     */
    public void setColor4( int field_4_color4 ) {
        this.field_4_color4 = field_4_color4;
    }

    @Override
    public Map<String, Supplier<?>> getGenericProperties() {
        return GenericRecordUtil.getGenericProperties(
            "base", super::getGenericProperties,
            "color1", this::getColor1,
            "color2", this::getColor2,
            "color3", this::getColor3,
            "color4", this::getColor4
        );
    }

    @Override
    public Enum getGenericRecordType() {
        return EscherRecordTypes.SPLIT_MENU_COLORS;
    }

    @Override
    public EscherSplitMenuColorsRecord copy() {
        return new EscherSplitMenuColorsRecord(this);
    }
}