| /* ==================================================================== |
| 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 static org.apache.poi.util.GenericRecordUtil.getBitsAsString; |
| |
| import java.util.Map; |
| import java.util.function.Supplier; |
| |
| import org.apache.poi.util.GenericRecordUtil; |
| import org.apache.poi.util.LittleEndian; |
| |
| /** |
| * Together the the EscherOptRecord this record defines some of the basic |
| * properties of a shape. |
| */ |
| public class EscherSpRecord extends EscherRecord { |
| public static final short RECORD_ID = EscherRecordTypes.SP.typeID; |
| |
| public static final int FLAG_GROUP = 0x0001; |
| public static final int FLAG_CHILD = 0x0002; |
| public static final int FLAG_PATRIARCH = 0x0004; |
| public static final int FLAG_DELETED = 0x0008; |
| public static final int FLAG_OLESHAPE = 0x0010; |
| public static final int FLAG_HAVEMASTER = 0x0020; |
| public static final int FLAG_FLIPHORIZ = 0x0040; |
| public static final int FLAG_FLIPVERT = 0x0080; |
| public static final int FLAG_CONNECTOR = 0x0100; |
| public static final int FLAG_HAVEANCHOR = 0x0200; |
| public static final int FLAG_BACKGROUND = 0x0400; |
| public static final int FLAG_HASSHAPETYPE = 0x0800; |
| |
| private static final int[] FLAGS_MASKS = { |
| FLAG_GROUP, |
| FLAG_CHILD, |
| FLAG_PATRIARCH, |
| FLAG_DELETED, |
| FLAG_OLESHAPE, |
| FLAG_HAVEMASTER, |
| FLAG_FLIPHORIZ, |
| FLAG_FLIPVERT, |
| FLAG_CONNECTOR, |
| FLAG_HAVEANCHOR, |
| FLAG_BACKGROUND, |
| FLAG_HASSHAPETYPE |
| }; |
| |
| private static final String[] FLAGS_NAMES = { |
| "GROUP", |
| "CHILD", |
| "PATRIARCH", |
| "DELETED", |
| "OLESHAPE", |
| "HAVEMASTER", |
| "FLIPHORIZ", |
| "FLIPVERT", |
| "CONNECTOR", |
| "HAVEANCHOR", |
| "BACKGROUND", |
| "HASSHAPETYPE" |
| }; |
| |
| private int field_1_shapeId; |
| private int field_2_flags; |
| |
| public EscherSpRecord() {} |
| |
| public EscherSpRecord(EscherSpRecord other) { |
| super(other); |
| field_1_shapeId = other.field_1_shapeId; |
| field_2_flags = other.field_2_flags; |
| } |
| |
| @Override |
| public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) { |
| readHeader( data, offset ); |
| int pos = offset + 8; |
| int size = 0; |
| field_1_shapeId = LittleEndian.getInt( data, pos + size ); size += 4; |
| field_2_flags = LittleEndian.getInt( data, pos + size ); size += 4; |
| return getRecordSize(); |
| } |
| |
| /** |
| * This method serializes this escher record into a byte array. |
| * |
| * @param offset The offset into <code>data</code> to start writing the record data to. |
| * @param data The byte array to serialize to. |
| * @param listener A listener to retrieve start and end callbacks. Use a <code>NullEscherSerailizationListener</code> to ignore these events. |
| * @return The number of bytes written. |
| * |
| * @see NullEscherSerializationListener |
| */ |
| @Override |
| public int serialize( int offset, byte[] data, EscherSerializationListener listener ) |
| { |
| listener.beforeRecordSerialize( offset, getRecordId(), this ); |
| LittleEndian.putShort( data, offset, getOptions() ); |
| LittleEndian.putShort( data, offset + 2, getRecordId() ); |
| int remainingBytes = 8; |
| LittleEndian.putInt( data, offset + 4, remainingBytes ); |
| LittleEndian.putInt( data, offset + 8, field_1_shapeId ); |
| LittleEndian.putInt( data, offset + 12, field_2_flags ); |
| listener.afterRecordSerialize( offset + getRecordSize(), getRecordId(), getRecordSize(), this ); |
| return 8 + 8; |
| } |
| |
| @Override |
| public int getRecordSize() |
| { |
| return 8 + 8; |
| } |
| |
| @Override |
| public short getRecordId() { |
| return RECORD_ID; |
| } |
| |
| @Override |
| public String getRecordName() { |
| return EscherRecordTypes.SP.recordName; |
| } |
| |
| /** |
| * Converts the shape flags into a more descriptive name. |
| */ |
| private String decodeFlags( int flags ) |
| { |
| StringBuilder result = new StringBuilder(); |
| result.append( ( flags & FLAG_GROUP ) != 0 ? "|GROUP" : "" ); |
| result.append( ( flags & FLAG_CHILD ) != 0 ? "|CHILD" : "" ); |
| result.append( ( flags & FLAG_PATRIARCH ) != 0 ? "|PATRIARCH" : "" ); |
| result.append( ( flags & FLAG_DELETED ) != 0 ? "|DELETED" : "" ); |
| result.append( ( flags & FLAG_OLESHAPE ) != 0 ? "|OLESHAPE" : "" ); |
| result.append( ( flags & FLAG_HAVEMASTER ) != 0 ? "|HAVEMASTER" : "" ); |
| result.append( ( flags & FLAG_FLIPHORIZ ) != 0 ? "|FLIPHORIZ" : "" ); |
| result.append( ( flags & FLAG_FLIPVERT ) != 0 ? "|FLIPVERT" : "" ); |
| result.append( ( flags & FLAG_CONNECTOR ) != 0 ? "|CONNECTOR" : "" ); |
| result.append( ( flags & FLAG_HAVEANCHOR ) != 0 ? "|HAVEANCHOR" : "" ); |
| result.append( ( flags & FLAG_BACKGROUND ) != 0 ? "|BACKGROUND" : "" ); |
| result.append( ( flags & FLAG_HASSHAPETYPE ) != 0 ? "|HASSHAPETYPE" : "" ); |
| |
| //need to check, else blows up on some records - bug 34435 |
| if(result.length() > 0) { |
| result.deleteCharAt(0); |
| } |
| return result.toString(); |
| } |
| |
| /** |
| * @return A number that identifies this shape |
| */ |
| public int getShapeId() |
| { |
| return field_1_shapeId; |
| } |
| |
| /** |
| * Sets a number that identifies this shape. |
| * |
| * @param field_1_shapeId the shape id |
| */ |
| public void setShapeId( int field_1_shapeId ) |
| { |
| this.field_1_shapeId = field_1_shapeId; |
| } |
| |
| /** |
| * The flags that apply to this shape. |
| * |
| * @return the flags |
| * |
| * @see #FLAG_GROUP |
| * @see #FLAG_CHILD |
| * @see #FLAG_PATRIARCH |
| * @see #FLAG_DELETED |
| * @see #FLAG_OLESHAPE |
| * @see #FLAG_HAVEMASTER |
| * @see #FLAG_FLIPHORIZ |
| * @see #FLAG_FLIPVERT |
| * @see #FLAG_CONNECTOR |
| * @see #FLAG_HAVEANCHOR |
| * @see #FLAG_BACKGROUND |
| * @see #FLAG_HASSHAPETYPE |
| */ |
| public int getFlags() |
| { |
| return field_2_flags; |
| } |
| |
| /** |
| * The flags that apply to this shape. |
| * |
| * @param field_2_flags the flags |
| * |
| * @see #FLAG_GROUP |
| * @see #FLAG_CHILD |
| * @see #FLAG_PATRIARCH |
| * @see #FLAG_DELETED |
| * @see #FLAG_OLESHAPE |
| * @see #FLAG_HAVEMASTER |
| * @see #FLAG_FLIPHORIZ |
| * @see #FLAG_FLIPVERT |
| * @see #FLAG_CONNECTOR |
| * @see #FLAG_HAVEANCHOR |
| * @see #FLAG_BACKGROUND |
| * @see #FLAG_HASSHAPETYPE |
| */ |
| public void setFlags( int field_2_flags ) |
| { |
| this.field_2_flags = field_2_flags; |
| } |
| |
| /** |
| * Returns shape type. Must be one of MSOSPT values (see [MS-ODRAW] for |
| * details). |
| * |
| * @return shape type |
| */ |
| public short getShapeType() |
| { |
| return getInstance(); |
| } |
| |
| /** |
| * Sets shape type. Must be one of MSOSPT values (see [MS-ODRAW] for |
| * details). |
| * |
| * @param value |
| * new shape type |
| */ |
| public void setShapeType( short value ) |
| { |
| setInstance( value ); |
| } |
| |
| @Override |
| public Map<String, Supplier<?>> getGenericProperties() { |
| return GenericRecordUtil.getGenericProperties( |
| "base", super::getGenericProperties, |
| "shapeType", this::getShapeType, |
| "shapeId", this::getShapeId, |
| "flags", getBitsAsString(this::getFlags, FLAGS_MASKS, FLAGS_NAMES) |
| ); |
| } |
| |
| @Override |
| public Enum getGenericRecordType() { |
| return EscherRecordTypes.SP; |
| } |
| |
| @Override |
| public EscherSpRecord copy() { |
| return new EscherSpRecord(this); |
| } |
| } |
