2004-04-09 07:45:38 -04:00
|
|
|
/* ====================================================================
|
2006-12-22 14:18:16 -05:00
|
|
|
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
|
2004-04-09 09:05:39 -04:00
|
|
|
|
|
|
|
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.
|
|
|
|
==================================================================== */
|
2009-05-19 15:21:12 -04:00
|
|
|
|
2004-04-09 07:45:38 -04:00
|
|
|
package org.apache.poi.ddf;
|
|
|
|
|
|
|
|
import org.apache.poi.util.HexDump;
|
|
|
|
import org.apache.poi.util.LittleEndian;
|
2008-07-21 05:34:08 -04:00
|
|
|
import org.apache.poi.util.RecordFormatException;
|
2004-04-09 07:45:38 -04:00
|
|
|
|
|
|
|
/**
|
2005-05-05 09:40:06 -04:00
|
|
|
* Holds data from the parent application. Most commonly used to store
|
2009-05-19 15:21:12 -04:00
|
|
|
* text in the format of the parent application, rather than in
|
2005-05-05 09:40:06 -04:00
|
|
|
* Escher format. We don't attempt to understand the contents, since
|
|
|
|
* they will be in the parent's format, not Escher format.
|
2004-04-09 07:45:38 -04:00
|
|
|
*
|
|
|
|
* @author Glen Stampoultzis (glens at apache.org)
|
2005-05-05 09:40:06 -04:00
|
|
|
* @author Nick Burch (nick at torchbox dot com)
|
2004-04-09 07:45:38 -04:00
|
|
|
*/
|
|
|
|
public class EscherTextboxRecord extends EscherRecord
|
|
|
|
{
|
|
|
|
public static final short RECORD_ID = (short)0xF00D;
|
|
|
|
public static final String RECORD_DESCRIPTION = "msofbtClientTextbox";
|
|
|
|
|
|
|
|
private static final byte[] NO_BYTES = new byte[0];
|
|
|
|
|
|
|
|
/** The data for this record not including the the 8 byte header */
|
|
|
|
private byte[] thedata = NO_BYTES;
|
|
|
|
|
|
|
|
public EscherTextboxRecord()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2009-05-19 15:21:12 -04:00
|
|
|
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) {
|
2004-04-09 07:45:38 -04:00
|
|
|
int bytesRemaining = readHeader( data, offset );
|
2005-05-05 09:40:06 -04:00
|
|
|
|
|
|
|
// Save the data, ready for the calling code to do something
|
|
|
|
// useful with it
|
|
|
|
thedata = new byte[bytesRemaining];
|
|
|
|
System.arraycopy( data, offset + 8, thedata, 0, bytesRemaining );
|
|
|
|
return bytesRemaining + 8;
|
2004-04-09 07:45:38 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
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 = thedata.length;
|
|
|
|
LittleEndian.putInt(data, offset+4, remainingBytes);
|
|
|
|
System.arraycopy(thedata, 0, data, offset+8, thedata.length);
|
|
|
|
int pos = offset+8+thedata.length;
|
|
|
|
|
|
|
|
listener.afterRecordSerialize( pos, getRecordId(), pos - offset, this );
|
|
|
|
int size = pos - offset;
|
|
|
|
if (size != getRecordSize())
|
|
|
|
throw new RecordFormatException(size + " bytes written but getRecordSize() reports " + getRecordSize());
|
|
|
|
return size;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns any extra data associated with this record. In practice excel
|
2005-05-05 09:40:06 -04:00
|
|
|
* does not seem to put anything here, but with PowerPoint this will
|
|
|
|
* contain the bytes that make up a TextHeaderAtom followed by a
|
|
|
|
* TextBytesAtom/TextCharsAtom
|
2004-04-09 07:45:38 -04:00
|
|
|
*/
|
|
|
|
public byte[] getData()
|
|
|
|
{
|
|
|
|
return thedata;
|
|
|
|
}
|
|
|
|
|
2005-05-05 09:40:06 -04:00
|
|
|
/**
|
|
|
|
* Sets the extra data (in the parent application's format) to be
|
|
|
|
* contained by the record. Used when the parent application changes
|
|
|
|
* the contents.
|
|
|
|
*/
|
|
|
|
public void setData(byte[] b, int start, int length)
|
|
|
|
{
|
|
|
|
thedata = new byte[length];
|
|
|
|
System.arraycopy(b,start,thedata,0,length);
|
|
|
|
}
|
|
|
|
public void setData(byte[] b) {
|
|
|
|
setData(b,0,b.length);
|
|
|
|
}
|
|
|
|
|
2004-04-09 07:45:38 -04:00
|
|
|
public int getRecordSize()
|
|
|
|
{
|
|
|
|
return 8 + thedata.length;
|
|
|
|
}
|
|
|
|
|
|
|
|
public Object clone()
|
|
|
|
{
|
|
|
|
// shallow clone
|
|
|
|
return super.clone();
|
|
|
|
}
|
|
|
|
|
2009-05-19 15:21:12 -04:00
|
|
|
public String getRecordName() {
|
2004-04-09 07:45:38 -04:00
|
|
|
return "ClientTextbox";
|
|
|
|
}
|
|
|
|
|
|
|
|
public String toString()
|
|
|
|
{
|
|
|
|
String nl = System.getProperty( "line.separator" );
|
|
|
|
|
|
|
|
String theDumpHex = "";
|
|
|
|
try
|
|
|
|
{
|
|
|
|
if (thedata.length != 0)
|
|
|
|
{
|
|
|
|
theDumpHex = " Extra Data:" + nl;
|
|
|
|
theDumpHex += HexDump.dump(thedata, 0, 0);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
catch ( Exception e )
|
|
|
|
{
|
|
|
|
theDumpHex = "Error!!";
|
|
|
|
}
|
|
|
|
|
|
|
|
return getClass().getName() + ":" + nl +
|
|
|
|
" isContainer: " + isContainerRecord() + nl +
|
2011-08-31 09:14:09 -04:00
|
|
|
" version: 0x" + HexDump.toHex( getVersion() ) + nl +
|
|
|
|
" instance: 0x" + HexDump.toHex( getInstance() ) + nl +
|
2004-04-09 07:45:38 -04:00
|
|
|
" recordId: 0x" + HexDump.toHex( getRecordId() ) + nl +
|
|
|
|
" numchildren: " + getChildRecords().size() + nl +
|
|
|
|
theDumpHex;
|
|
|
|
}
|
|
|
|
|
2012-05-02 10:00:46 -04:00
|
|
|
@Override
|
|
|
|
public String toXml(String tab) {
|
|
|
|
String theDumpHex = "";
|
|
|
|
try
|
|
|
|
{
|
|
|
|
if (thedata.length != 0)
|
|
|
|
{
|
|
|
|
theDumpHex += HexDump.dump(thedata, 0, 0);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
catch ( Exception e )
|
|
|
|
{
|
|
|
|
theDumpHex = "Error!!";
|
|
|
|
}
|
|
|
|
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("<ExtraData>").append(theDumpHex).append("</ExtraData>\n");
|
|
|
|
builder.append(tab).append("</").append(getClass().getSimpleName()).append(">\n");
|
|
|
|
return builder.toString();
|
|
|
|
}
|
2004-04-09 07:45:38 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|