org.apache.poi.hslf.record.TextHeaderAtom 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.hslf.record;

import java.io.IOException;
import java.io.OutputStream;
import java.util.Map;
import java.util.function.Supplier;

import org.apache.poi.hslf.exceptions.HSLFException;
import org.apache.poi.sl.usermodel.TextShape.TextPlaceholder;
import org.apache.poi.util.GenericRecordUtil;
import org.apache.poi.util.LittleEndian;

/**
 * A TextHeaderAtom  (type 3999). Holds information on what kind of
 *  text is contained in the TextBytesAtom / TextCharsAtom that follows
 *  straight after
 */

public final class TextHeaderAtom extends RecordAtom implements ParentAwareRecord {
    public static final long _type = RecordTypes.TextHeaderAtom.typeID;
	private byte[] _header;
	public org.apache.poi.hslf.record.RecordContainer parentRecord;

	/** The kind of text it is */
	private int textType;
	/** position in the owning SlideListWithText */
	private int index = -1;

	public int getTextType() { return textType; }
	public void setTextType(int type) { textType = type; }

	public TextPlaceholder getTextTypeEnum() {
		return TextPlaceholder.fromNativeId(textType);
	}

	public void setTextTypeEnum(TextPlaceholder placeholder) {
		textType = placeholder.nativeId;
	}

    /**
     * @return  0-based index of the text run in the SLWT container
     */
	public int getIndex() { return index; }

    /**
     *  @param index 0-based index of the text run in the SLWT container
     */
	public void setIndex(int index) { this.index = index; }

	@Override
    public org.apache.poi.hslf.record.RecordContainer getParentRecord() { return parentRecord; }
	@Override
    public void setParentRecord(RecordContainer record) { this.parentRecord = record; }

	/* *************** record code follows ********************** */

	/**
	 * For the TextHeader Atom
	 */
	protected TextHeaderAtom(byte[] source, int start, int len) {
		// Sanity Checking - we're always 12 bytes long
		if(len < 12) {
			len = 12;
			if(source.length - start < 12) {
				throw new HSLFException("Not enough data to form a TextHeaderAtom (always 12 bytes long) - found " + (source.length - start));
			}
		}

		// Get the header
		_header = new byte[8];
		System.arraycopy(source,start,_header,0,8);

		// Grab the type
		textType = LittleEndian.getInt(source,start+8);
	}

	/**
	 * Create a new TextHeader Atom, for an unknown type of text
	 */
	public TextHeaderAtom() {
		_header = new byte[8];
		LittleEndian.putUShort(_header, 0, 0);
		LittleEndian.putUShort(_header, 2, (int)_type);
		LittleEndian.putInt(_header, 4, 4);

		textType = TextPlaceholder.OTHER.nativeId;
	}

	/**
	 * We are of type 3999
	 */
	@Override
    public long getRecordType() { return _type; }

	/**
	 * Write the contents of the record back, so it can be written
	 *  to disk
	 */
	@Override
    public void writeOut(OutputStream out) throws IOException {
		// Header - size or type unchanged
		out.write(_header);

		// Write out our type
		writeLittleEndian(textType,out);
	}

	@Override
	public Map> getGenericProperties() {
		return GenericRecordUtil.getGenericProperties(
			"index", this::getIndex,
			"textType", this::getTextTypeEnum
		);
	}
}