poi-scratchpad/src/main/java/org/apache/poi/hwpf/model/CHPX.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.hwpf.model;

import org.apache.poi.hwpf.sprm.CharacterSprmUncompressor;
import org.apache.poi.hwpf.sprm.SprmBuffer;
import org.apache.poi.hwpf.usermodel.CharacterProperties;
import org.apache.poi.util.Internal;

/**
 * DANGER - works in bytes!
 * <p>
 * Make sure you call getStart() / getEnd() when you want characters
 * (normal use), but getStartByte() / getEndByte() when you're
 * reading in / writing out!
 */
@Internal
@SuppressWarnings("deprecation")
public final class CHPX extends BytePropertyNode<CHPX> {

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

    CHPX(int charStart, int charEnd, SprmBuffer buf) {
        super(charStart, charEnd, buf);
    }

    public byte[] getGrpprl() {
        return ((SprmBuffer) _buf).toByteArray();
    }

    public SprmBuffer getSprmBuf() {
        return (SprmBuffer) _buf;
    }

    public CharacterProperties getCharacterProperties(StyleSheet ss, short istd) {
        if (ss == null) {
            // TODO Fix up for Word 6/95
            return new CharacterProperties();
        }

        CharacterProperties baseStyle = ss.getCharacterStyle(istd);
        return CharacterSprmUncompressor.uncompressCHP(
                ss, baseStyle, getGrpprl(), 0);
    }

    public String toString() {
        return "CHPX from " + getStart() + " to " + getEnd() +
                " (in bytes " + getStartBytes() + " to " + getEndBytes() + ")";
    }

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