org.apache.poi.hwpf.usermodel.ShadingDescriptor80 Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi-scratchpad Show documentation
Apache POI - Java API To Access Microsoft Format Files
There is a newer version: 5.2.5
/* ====================================================================
   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.hwpf.usermodel;

import org.apache.poi.common.Duplicatable;
import org.apache.poi.hwpf.model.Colorref;
import org.apache.poi.hwpf.model.types.SHD80AbstractType;
import org.apache.poi.util.Removal;

/**
 * The SHD80 is a substructure of the CHP and PAP, and TC for Word 97.
 */
@SuppressWarnings("unused")
public final class ShadingDescriptor80 extends SHD80AbstractType implements Duplicatable {

    public ShadingDescriptor80() {}

    public ShadingDescriptor80(ShadingDescriptor80 other) {
        super(other);
    }

    public ShadingDescriptor80( byte[] buf, int offset ) {
        fillFields( buf, offset );
    }

    public ShadingDescriptor80( short value ) {
        field_1_value = value;
    }

    @Override
    @SuppressWarnings({"squid:S2975", "MethodDoesntCallSuperMethod"})
    @Deprecated
    @Removal(version = "5.0.0")
    public ShadingDescriptor80 clone() {
        return copy();
    }

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

    public boolean isEmpty()
    {
        return field_1_value == 0;
    }

    public byte[] serialize()
    {
        byte[] result = new byte[getSize()];
        serialize( result, 0 );
        return result;
    }

    public ShadingDescriptor toShadingDescriptor()
    {
        ShadingDescriptor result = new ShadingDescriptor();
        result.setCvFore( Colorref.valueOfIco( getIcoFore() ) );
        result.setCvBack( Colorref.valueOfIco( getIcoBack() ) );
        result.setIpat( getIpat() );
        return result;
    }

    @Override
    public String toString()
    {
        if ( isEmpty() )
            return "[SHD80] EMPTY";

        return "[SHD80] (icoFore: " + getIcoFore() + "; icoBack: "
                + getIcoBack() + "; iPat: " + getIpat() + ")";
    }

}