123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175 |
- /* ====================================================================
- 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 org.apache.poi.util.LittleEndian;
- import org.apache.poi.util.POILogger;
-
- /**
- * This class represents a comment on a slide, in the format used by
- * PPT 2000/XP/etc. (PPT 97 uses plain Escher Text Boxes for comments)
- * @author Nick Burch
- */
- public final class Comment2000 extends RecordContainer {
- private byte[] _header;
- private static final long _type = RecordTypes.Comment2000.typeID;
-
- // Links to our more interesting children
-
- /**
- * An optional string that specifies the name of the author of the presentation comment.
- */
- private CString authorRecord;
- /**
- * An optional string record that specifies the text of the presentation comment
- */
- private CString authorInitialsRecord;
- /**
- * An optional string record that specifies the initials of the author of the presentation comment
- */
- private CString commentRecord;
-
- /**
- * A Comment2000Atom record that specifies the settings for displaying the presentation comment
- */
- private Comment2000Atom commentAtom;
-
- /**
- * Returns the Comment2000Atom of this Comment
- */
- public Comment2000Atom getComment2000Atom() { return commentAtom; }
-
- /**
- * Get the Author of this comment
- */
- public String getAuthor() {
- return authorRecord == null ? null : authorRecord.getText();
- }
- /**
- * Set the Author of this comment
- */
- public void setAuthor(String author) {
- authorRecord.setText(author);
- }
-
- /**
- * Get the Author's Initials of this comment
- */
- public String getAuthorInitials() {
- return authorInitialsRecord == null ? null : authorInitialsRecord.getText();
- }
- /**
- * Set the Author's Initials of this comment
- */
- public void setAuthorInitials(String initials) {
- authorInitialsRecord.setText(initials);
- }
-
- /**
- * Get the text of this comment
- */
- public String getText() {
- return commentRecord == null ? null : commentRecord.getText();
- }
- /**
- * Set the text of this comment
- */
- public void setText(String text) {
- commentRecord.setText(text);
- }
-
- /**
- * Set things up, and find our more interesting children
- */
- protected Comment2000(byte[] source, int start, int len) {
- // Grab the header
- _header = new byte[8];
- System.arraycopy(source,start,_header,0,8);
-
- // Find our children
- _children = org.apache.poi.hslf.record.Record.findChildRecords(source,start+8,len-8);
- findInterestingChildren();
- }
-
- /**
- * Go through our child records, picking out the ones that are
- * interesting, and saving those for use by the easy helper
- * methods.
- */
- private void findInterestingChildren() {
-
- for(org.apache.poi.hslf.record.Record r : _children){
- if (r instanceof CString){
- CString cs = (CString)r;
- int recInstance = cs.getOptions() >> 4;
- switch(recInstance){
- case 0: authorRecord = cs; break;
- case 1: commentRecord = cs; break;
- case 2: authorInitialsRecord = cs; break;
- default: break;
- }
- } else if (r instanceof Comment2000Atom){
- commentAtom = (Comment2000Atom)r;
- } else {
- logger.log(POILogger.WARN, "Unexpected record with type="+r.getRecordType()+" in Comment2000: " + r.getClass().getName());
- }
- }
-
- }
-
- /**
- * Create a new Comment2000, with blank fields
- */
- public Comment2000() {
- _header = new byte[8];
- _children = new org.apache.poi.hslf.record.Record[4];
-
- // Setup our header block
- _header[0] = 0x0f; // We are a container record
- LittleEndian.putShort(_header, 2, (short)_type);
-
- // Setup our child records
- CString csa = new CString();
- CString csb = new CString();
- CString csc = new CString();
- csa.setOptions(0x00);
- csb.setOptions(0x10);
- csc.setOptions(0x20);
- _children[0] = csa;
- _children[1] = csb;
- _children[2] = csc;
- _children[3] = new Comment2000Atom();
- findInterestingChildren();
- }
-
- /**
- * We are of type 1200
- */
- public long getRecordType() { return _type; }
-
- /**
- * Write the contents of the record back, so it can be written
- * to disk
- */
- public void writeOut(OutputStream out) throws IOException {
- writeOut(_header[0],_header[1],_type,_children,out);
- }
- }
|