301 lines
11 KiB
Java
301 lines
11 KiB
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 org.apache.poi.util.HexDump;
|
|
import org.apache.poi.util.LittleEndian;
|
|
import org.apache.poi.util.RecordFormatException;
|
|
|
|
import java.util.*;
|
|
|
|
/**
|
|
* This record defines the drawing groups used for a particular sheet.
|
|
*/
|
|
public final class EscherDggRecord extends EscherRecord {
|
|
public static final short RECORD_ID = (short) 0xF006;
|
|
public static final String RECORD_DESCRIPTION = "MsofbtDgg";
|
|
|
|
private int field_1_shapeIdMax;
|
|
// private int field_2_numIdClusters; // for some reason the number of clusters is actually the real number + 1
|
|
private int field_3_numShapesSaved;
|
|
private int field_4_drawingsSaved;
|
|
private FileIdCluster[] field_5_fileIdClusters;
|
|
private int maxDgId;
|
|
|
|
public static class FileIdCluster
|
|
{
|
|
public FileIdCluster( int drawingGroupId, int numShapeIdsUsed )
|
|
{
|
|
this.field_1_drawingGroupId = drawingGroupId;
|
|
this.field_2_numShapeIdsUsed = numShapeIdsUsed;
|
|
}
|
|
|
|
private int field_1_drawingGroupId;
|
|
private int field_2_numShapeIdsUsed;
|
|
|
|
public int getDrawingGroupId()
|
|
{
|
|
return field_1_drawingGroupId;
|
|
}
|
|
|
|
public int getNumShapeIdsUsed()
|
|
{
|
|
return field_2_numShapeIdsUsed;
|
|
}
|
|
|
|
public void incrementShapeId( )
|
|
{
|
|
this.field_2_numShapeIdsUsed++;
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) {
|
|
int bytesRemaining = readHeader( data, offset );
|
|
int pos = offset + 8;
|
|
int size = 0;
|
|
field_1_shapeIdMax = LittleEndian.getInt( data, pos + size );size+=4;
|
|
// field_2_numIdClusters = LittleEndian.getInt( data, pos + size );
|
|
size+=4;
|
|
field_3_numShapesSaved = LittleEndian.getInt( data, pos + size );size+=4;
|
|
field_4_drawingsSaved = LittleEndian.getInt( data, pos + size );size+=4;
|
|
field_5_fileIdClusters = new FileIdCluster[(bytesRemaining-size) / 8]; // Can't rely on field_2_numIdClusters
|
|
for (int i = 0; i < field_5_fileIdClusters.length; i++)
|
|
{
|
|
field_5_fileIdClusters[i] = new FileIdCluster(LittleEndian.getInt( data, pos + size ), LittleEndian.getInt( data, pos + size + 4 ));
|
|
maxDgId = Math.max(maxDgId, field_5_fileIdClusters[i].getDrawingGroupId());
|
|
size += 8;
|
|
}
|
|
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) {
|
|
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_shapeIdMax ); pos += 4;
|
|
LittleEndian.putInt( data, pos, getNumIdClusters() ); pos += 4;
|
|
LittleEndian.putInt( data, pos, field_3_numShapesSaved ); pos += 4;
|
|
LittleEndian.putInt( data, pos, field_4_drawingsSaved ); pos += 4;
|
|
for (int i = 0; i < field_5_fileIdClusters.length; i++) {
|
|
LittleEndian.putInt( data, pos, field_5_fileIdClusters[i].field_1_drawingGroupId ); pos += 4;
|
|
LittleEndian.putInt( data, pos, field_5_fileIdClusters[i].field_2_numShapeIdsUsed ); pos += 4;
|
|
}
|
|
|
|
listener.afterRecordSerialize( pos, getRecordId(), getRecordSize(), this );
|
|
return getRecordSize();
|
|
}
|
|
|
|
@Override
|
|
public int getRecordSize() {
|
|
return 8 + 16 + (8 * field_5_fileIdClusters.length);
|
|
}
|
|
|
|
@Override
|
|
public short getRecordId() {
|
|
return RECORD_ID;
|
|
}
|
|
|
|
@Override
|
|
public String getRecordName() {
|
|
return "Dgg";
|
|
}
|
|
|
|
@Override
|
|
public String toString() {
|
|
|
|
StringBuilder field_5_string = new StringBuilder();
|
|
if(field_5_fileIdClusters != null) for (int i = 0; i < field_5_fileIdClusters.length; i++) {
|
|
field_5_string.append(" DrawingGroupId").append(i+1).append(": ");
|
|
field_5_string.append(field_5_fileIdClusters[i].field_1_drawingGroupId);
|
|
field_5_string.append('\n');
|
|
field_5_string.append(" NumShapeIdsUsed").append(i+1).append(": ");
|
|
field_5_string.append(field_5_fileIdClusters[i].field_2_numShapeIdsUsed);
|
|
field_5_string.append('\n');
|
|
}
|
|
return getClass().getName() + ":" + '\n' +
|
|
" RecordId: 0x" + HexDump.toHex(RECORD_ID) + '\n' +
|
|
" Version: 0x" + HexDump.toHex(getVersion()) + '\n' +
|
|
" Instance: 0x" + HexDump.toHex(getInstance()) + '\n' +
|
|
" ShapeIdMax: " + field_1_shapeIdMax + '\n' +
|
|
" NumIdClusters: " + getNumIdClusters() + '\n' +
|
|
" NumShapesSaved: " + field_3_numShapesSaved + '\n' +
|
|
" DrawingsSaved: " + field_4_drawingsSaved + '\n' +
|
|
"" + field_5_string.toString();
|
|
|
|
}
|
|
|
|
@Override
|
|
public String toXml(String tab) {
|
|
StringBuilder builder = new StringBuilder();
|
|
builder.append(tab).append(formatXmlRecordHeader(getClass().getSimpleName(), HexDump.toHex(getRecordId()), HexDump.toHex(getVersion()), HexDump.toHex(getInstance())))
|
|
.append(tab).append("\t").append("<ShapeIdMax>").append(field_1_shapeIdMax).append("</ShapeIdMax>\n")
|
|
.append(tab).append("\t").append("<NumIdClusters>").append(getNumIdClusters()).append("</NumIdClusters>\n")
|
|
.append(tab).append("\t").append("<NumShapesSaved>").append(field_3_numShapesSaved).append("</NumShapesSaved>\n")
|
|
.append(tab).append("\t").append("<DrawingsSaved>").append(field_4_drawingsSaved).append("</DrawingsSaved>\n");
|
|
builder.append(tab).append("</").append(getClass().getSimpleName()).append(">\n");
|
|
return builder.toString();
|
|
}
|
|
|
|
/**
|
|
* Gets the next available shape id
|
|
*
|
|
* @return the next available shape id
|
|
*/
|
|
public int getShapeIdMax() {
|
|
return field_1_shapeIdMax;
|
|
}
|
|
|
|
/**
|
|
* The maximum is actually the next available shape id.
|
|
*
|
|
* @param shapeIdMax the next available shape id
|
|
*/
|
|
public void setShapeIdMax(int shapeIdMax) {
|
|
this.field_1_shapeIdMax = shapeIdMax;
|
|
}
|
|
|
|
/**
|
|
* Number of id clusters + 1
|
|
*
|
|
* @return the number of id clusters + 1
|
|
*/
|
|
public int getNumIdClusters() {
|
|
return (field_5_fileIdClusters == null ? 0 : (field_5_fileIdClusters.length + 1));
|
|
}
|
|
|
|
/**
|
|
* Gets the number of shapes saved
|
|
*
|
|
* @return the number of shapes saved
|
|
*/
|
|
public int getNumShapesSaved() {
|
|
return field_3_numShapesSaved;
|
|
}
|
|
|
|
/**
|
|
* Sets the number of shapes saved
|
|
*
|
|
* @param numShapesSaved the number of shapes saved
|
|
*/
|
|
public void setNumShapesSaved(int numShapesSaved) {
|
|
this.field_3_numShapesSaved = numShapesSaved;
|
|
}
|
|
|
|
/**
|
|
* Gets the number of drawings saved
|
|
*
|
|
* @return the number of drawings saved
|
|
*/
|
|
public int getDrawingsSaved() {
|
|
return field_4_drawingsSaved;
|
|
}
|
|
|
|
/**
|
|
* Sets the number of drawings saved
|
|
*
|
|
* @param drawingsSaved the number of drawings saved
|
|
*/
|
|
public void setDrawingsSaved(int drawingsSaved) {
|
|
this.field_4_drawingsSaved = drawingsSaved;
|
|
}
|
|
|
|
/**
|
|
* Gets the maximum drawing group ID
|
|
*
|
|
* @return The maximum drawing group ID
|
|
*/
|
|
public int getMaxDrawingGroupId() {
|
|
return maxDgId;
|
|
}
|
|
|
|
/**
|
|
* Sets the maximum drawing group ID
|
|
*
|
|
* @param id the maximum drawing group ID
|
|
*/
|
|
public void setMaxDrawingGroupId(int id) {
|
|
maxDgId = id;
|
|
}
|
|
|
|
/**
|
|
* @return the file id clusters
|
|
*/
|
|
public FileIdCluster[] getFileIdClusters() {
|
|
return field_5_fileIdClusters;
|
|
}
|
|
|
|
/**
|
|
* Sets the file id clusters
|
|
*
|
|
* @param fileIdClusters the file id clusters
|
|
*/
|
|
public void setFileIdClusters(FileIdCluster[] fileIdClusters) {
|
|
this.field_5_fileIdClusters = fileIdClusters.clone();
|
|
}
|
|
|
|
|
|
/**
|
|
* Add a new cluster
|
|
*
|
|
* @param dgId id of the drawing group (stored in the record options)
|
|
* @param numShapedUsed initial value of the numShapedUsed field
|
|
*/
|
|
public void addCluster(int dgId, int numShapedUsed) {
|
|
addCluster(dgId, numShapedUsed, true);
|
|
}
|
|
|
|
/**
|
|
* Add a new cluster
|
|
*
|
|
* @param dgId id of the drawing group (stored in the record options)
|
|
* @param numShapedUsed initial value of the numShapedUsed field
|
|
* @param sort if true then sort clusters by drawing group id.(
|
|
* In Excel the clusters are sorted but in PPT they are not)
|
|
*/
|
|
public void addCluster( int dgId, int numShapedUsed, boolean sort ) {
|
|
List<FileIdCluster> clusters = new ArrayList<FileIdCluster>(Arrays.asList(field_5_fileIdClusters));
|
|
clusters.add(new FileIdCluster(dgId, numShapedUsed));
|
|
if(sort) Collections.sort(clusters, MY_COMP );
|
|
maxDgId = Math.min(maxDgId, dgId);
|
|
field_5_fileIdClusters = clusters.toArray( new FileIdCluster[clusters.size()] );
|
|
}
|
|
|
|
private static final Comparator<FileIdCluster> MY_COMP = new Comparator<FileIdCluster>() {
|
|
@Override
|
|
public int compare(FileIdCluster f1, FileIdCluster f2) {
|
|
if (f1.getDrawingGroupId() == f2.getDrawingGroupId()) {
|
|
return 0;
|
|
}
|
|
if (f1.getDrawingGroupId() < f2.getDrawingGroupId()) {
|
|
return -1;
|
|
}
|
|
return +1;
|
|
}
|
|
};
|
|
}
|