123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561 |
- /* ====================================================================
- 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.hssf.usermodel;
-
- import java.io.FileNotFoundException;
- import java.util.ArrayList;
- import java.util.Collections;
- import java.util.HashSet;
- import java.util.Iterator;
- import java.util.List;
- import java.util.Map;
- import java.util.Set;
-
- import org.apache.poi.ddf.EscherComplexProperty;
- import org.apache.poi.ddf.EscherContainerRecord;
- import org.apache.poi.ddf.EscherDgRecord;
- import org.apache.poi.ddf.EscherOptRecord;
- import org.apache.poi.ddf.EscherProperty;
- import org.apache.poi.ddf.EscherSpRecord;
- import org.apache.poi.ddf.EscherSpgrRecord;
- import org.apache.poi.hssf.model.DrawingManager2;
- import org.apache.poi.hssf.record.CommonObjectDataSubRecord;
- import org.apache.poi.hssf.record.EmbeddedObjectRefSubRecord;
- import org.apache.poi.hssf.record.EndSubRecord;
- import org.apache.poi.hssf.record.EscherAggregate;
- import org.apache.poi.hssf.record.FtCfSubRecord;
- import org.apache.poi.hssf.record.FtPioGrbitSubRecord;
- import org.apache.poi.hssf.record.NoteRecord;
- import org.apache.poi.hssf.record.ObjRecord;
- import org.apache.poi.ss.util.CellReference;
- import org.apache.poi.poifs.filesystem.DirectoryEntry;
- import org.apache.poi.poifs.filesystem.DirectoryNode;
- import org.apache.poi.ss.usermodel.ClientAnchor;
- import org.apache.poi.ss.usermodel.Drawing;
- import org.apache.poi.ss.usermodel.Workbook;
- import org.apache.poi.util.HexDump;
- import org.apache.poi.util.Internal;
- import org.apache.poi.util.StringUtil;
-
- /**
- * The patriarch is the toplevel container for shapes in a sheet. It does
- * little other than act as a container for other shapes and groups.
- */
- public final class HSSFPatriarch implements HSSFShapeContainer, Drawing<HSSFShape> {
- // private static POILogger log = POILogFactory.getLogger(HSSFPatriarch.class);
- private final List<HSSFShape> _shapes = new ArrayList<>();
-
- private final EscherSpgrRecord _spgrRecord;
- private final EscherContainerRecord _mainSpgrContainer;
-
- /**
- * The EscherAggregate we have been bound to.
- * (This will handle writing us out into records,
- * and building up our shapes from the records)
- */
- private EscherAggregate _boundAggregate;
- private final HSSFSheet _sheet;
-
- /**
- * Creates the patriarch.
- *
- * @param sheet the sheet this patriarch is stored in.
- * @param boundAggregate -low level representation of all binary data inside sheet
- */
- HSSFPatriarch(HSSFSheet sheet, EscherAggregate boundAggregate) {
- _sheet = sheet;
- _boundAggregate = boundAggregate;
- _mainSpgrContainer = _boundAggregate.getEscherContainer().getChildContainers().get(0);
- EscherContainerRecord spContainer = (EscherContainerRecord) _boundAggregate.getEscherContainer()
- .getChildContainers().get(0).getChild(0);
- _spgrRecord = spContainer.getChildById(EscherSpgrRecord.RECORD_ID);
- buildShapeTree();
- }
-
- /**
- * used to clone patriarch
- *
- * create patriarch from existing one
- * @param patriarch - copy all the shapes from this patriarch to new one
- * @param sheet where must be located new patriarch
- * @return new patriarch with copies of all shapes from the existing patriarch
- */
- static HSSFPatriarch createPatriarch(HSSFPatriarch patriarch, HSSFSheet sheet){
- HSSFPatriarch newPatriarch = new HSSFPatriarch(sheet, new EscherAggregate(true));
- newPatriarch.afterCreate();
- for (HSSFShape shape: patriarch.getChildren()){
- HSSFShape newShape;
- if (shape instanceof HSSFShapeGroup){
- newShape = ((HSSFShapeGroup)shape).cloneShape(newPatriarch);
- } else {
- newShape = shape.cloneShape();
- }
- newPatriarch.onCreate(newShape);
- newPatriarch.addShape(newShape);
- }
- return newPatriarch;
- }
-
- /**
- * check if any shapes contain wrong data
- * At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates
- */
- protected void preSerialize(){
- Map<Integer, NoteRecord> tailRecords = _boundAggregate.getTailRecords();
- /*
- * contains coordinates of comments we iterate over
- */
- Set<String> coordinates = new HashSet<>(tailRecords.size());
- for(NoteRecord rec : tailRecords.values()){
- String noteRef = new CellReference(rec.getRow(),
- rec.getColumn(), true, true).formatAsString(); // A1-style notation
- if(coordinates.contains(noteRef )){
- throw new IllegalStateException("found multiple cell comments for cell " + noteRef );
- } else {
- coordinates.add(noteRef);
- }
- }
- }
-
- /**
- * @param shape to be removed
- * @return true of shape is removed
- */
- @Override
- public boolean removeShape(HSSFShape shape) {
- boolean isRemoved = _mainSpgrContainer.removeChildRecord(shape.getEscherContainer());
- if (isRemoved){
- shape.afterRemove(this);
- _shapes.remove(shape);
- }
- return isRemoved;
- }
-
- void afterCreate() {
- DrawingManager2 drawingManager = _sheet.getWorkbook().getWorkbook().getDrawingManager();
- short dgId = drawingManager.findNewDrawingGroupId();
- _boundAggregate.setDgId(dgId);
- _boundAggregate.setMainSpRecordId(newShapeId());
- drawingManager.incrementDrawingsSaved();
- }
-
- /**
- * Creates a new group record stored under this patriarch.
- *
- * @param anchor the client anchor describes how this group is attached
- * to the sheet.
- * @return the newly created group.
- */
- public HSSFShapeGroup createGroup(HSSFClientAnchor anchor) {
- HSSFShapeGroup group = new HSSFShapeGroup(null, anchor);
- addShape(group);
- onCreate(group);
- return group;
- }
-
- /**
- * Creates a simple shape. This includes such shapes as lines, rectangles,
- * and ovals.
- *
- * Note: Microsoft Excel seems to sometimes disallow
- * higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
- * reverse them and draw shapes vertically or horizontally flipped!
- *
- * @param anchor the client anchor describes how this group is attached
- * to the sheet.
- * @return the newly created shape.
- */
- public HSSFSimpleShape createSimpleShape(HSSFClientAnchor anchor) {
- HSSFSimpleShape shape = new HSSFSimpleShape(null, anchor);
- addShape(shape);
- //open existing file
- onCreate(shape);
- return shape;
- }
-
- /**
- * Creates a picture.
- *
- * @param anchor the client anchor describes how this group is attached
- * to the sheet.
- * @param pictureIndex - pointer to the byte array saved inside workbook in escher bse record
- * @return the newly created shape.
- */
- public HSSFPicture createPicture(HSSFClientAnchor anchor, int pictureIndex) {
- HSSFPicture shape = new HSSFPicture(null, anchor);
- shape.setPictureIndex(pictureIndex);
- addShape(shape);
- //open existing file
- onCreate(shape);
- return shape;
- }
-
- /**
- *
- * @param anchor the client anchor describes how this picture is
- * attached to the sheet.
- * @param pictureIndex the index of the picture in the workbook collection
- * of pictures.
- *
- * @return newly created shape
- */
- @Override
- public HSSFPicture createPicture(ClientAnchor anchor, int pictureIndex) {
- return createPicture((HSSFClientAnchor) anchor, pictureIndex);
- }
-
- @Override
- public HSSFObjectData createObjectData(ClientAnchor anchor, int storageId, int pictureIndex) {
- ObjRecord obj = new ObjRecord();
-
- CommonObjectDataSubRecord ftCmo = new CommonObjectDataSubRecord();
- ftCmo.setObjectType(CommonObjectDataSubRecord.OBJECT_TYPE_PICTURE);
- // ftCmo.setObjectId(oleShape.getShapeId()); ... will be set by onCreate(...)
- ftCmo.setLocked(true);
- ftCmo.setPrintable(true);
- ftCmo.setAutofill(true);
- ftCmo.setAutoline(true);
- ftCmo.setReserved1(0);
- ftCmo.setReserved2(0);
- ftCmo.setReserved3(0);
- obj.addSubRecord(ftCmo);
-
- // FtCf (pictFormat)
- FtCfSubRecord ftCf = new FtCfSubRecord();
- HSSFPictureData pictData = getSheet().getWorkbook().getAllPictures().get(pictureIndex-1);
- switch (pictData.getFormat()) {
- case Workbook.PICTURE_TYPE_WMF:
- case Workbook.PICTURE_TYPE_EMF:
- // this needs patch #49658 to be applied to actually work
- ftCf.setFlags(FtCfSubRecord.METAFILE_BIT);
- break;
- case Workbook.PICTURE_TYPE_DIB:
- case Workbook.PICTURE_TYPE_PNG:
- case Workbook.PICTURE_TYPE_JPEG:
- case Workbook.PICTURE_TYPE_PICT:
- ftCf.setFlags(FtCfSubRecord.BITMAP_BIT);
- break;
- default:
- throw new IllegalStateException("Invalid picture type: " + pictData.getFormat());
- }
- obj.addSubRecord(ftCf);
- // FtPioGrbit (pictFlags)
- FtPioGrbitSubRecord ftPioGrbit = new FtPioGrbitSubRecord();
- ftPioGrbit.setFlagByBit(FtPioGrbitSubRecord.AUTO_PICT_BIT, true);
- obj.addSubRecord(ftPioGrbit);
-
- EmbeddedObjectRefSubRecord ftPictFmla = new EmbeddedObjectRefSubRecord();
- ftPictFmla.setUnknownFormulaData(new byte[]{2, 0, 0, 0, 0});
- ftPictFmla.setOleClassname("Paket");
- ftPictFmla.setStorageId(storageId);
-
- obj.addSubRecord(ftPictFmla);
- obj.addSubRecord(new EndSubRecord());
-
- String entryName = "MBD"+HexDump.toHex(storageId);
- DirectoryEntry oleRoot;
- try {
- DirectoryNode dn = _sheet.getWorkbook().getDirectory();
- if (dn == null) {
- throw new FileNotFoundException();
- }
- oleRoot = (DirectoryEntry)dn.getEntry(entryName);
- } catch (FileNotFoundException e) {
- throw new IllegalStateException("trying to add ole shape without actually adding data first - use HSSFWorkbook.addOlePackage first", e);
- }
-
- // create picture shape, which need to be minimal modified for oleshapes
- HSSFPicture shape = new HSSFPicture(null, (HSSFClientAnchor)anchor);
- shape.setPictureIndex(pictureIndex);
- EscherContainerRecord spContainer = shape.getEscherContainer();
- EscherSpRecord spRecord = spContainer.getChildById(EscherSpRecord.RECORD_ID);
- spRecord.setFlags(spRecord.getFlags() | EscherSpRecord.FLAG_OLESHAPE);
-
- HSSFObjectData oleShape = new HSSFObjectData(spContainer, obj, oleRoot);
- addShape(oleShape);
- onCreate(oleShape);
-
-
- return oleShape;
- }
-
- /**
- * Creates a polygon
- *
- * @param anchor the client anchor describes how this group is attached
- * to the sheet.
- * @return the newly created shape.
- */
- public HSSFPolygon createPolygon(HSSFClientAnchor anchor) {
- HSSFPolygon shape = new HSSFPolygon(null, anchor);
- addShape(shape);
- onCreate(shape);
- return shape;
- }
-
- /**
- * Constructs a textbox under the patriarch.
- *
- * @param anchor the client anchor describes how this group is attached
- * to the sheet.
- * @return the newly created textbox.
- */
- public HSSFTextbox createTextbox(HSSFClientAnchor anchor) {
- HSSFTextbox shape = new HSSFTextbox(null, anchor);
- addShape(shape);
- onCreate(shape);
- return shape;
- }
-
- /**
- * Constructs a cell comment.
- *
- * @param anchor the client anchor describes how this comment is attached
- * to the sheet.
- * @return the newly created comment.
- */
- public HSSFComment createComment(HSSFAnchor anchor) {
- HSSFComment shape = new HSSFComment(null, anchor);
- addShape(shape);
- onCreate(shape);
- return shape;
- }
-
- /**
- * YK: used to create autofilters
- *
- * @see org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(org.apache.poi.ss.util.CellRangeAddress)
- */
- HSSFSimpleShape createComboBox(HSSFAnchor anchor) {
- HSSFCombobox shape = new HSSFCombobox(null, anchor);
- addShape(shape);
- onCreate(shape);
- return shape;
- }
-
- @Override
- public HSSFComment createCellComment(ClientAnchor anchor) {
- return createComment((HSSFAnchor) anchor);
- }
-
- /**
- * Returns a unmodifiable list of all shapes contained by the patriarch.
- */
- @Override
- public List<HSSFShape> getChildren() {
- return Collections.unmodifiableList(_shapes);
- }
-
- /**
- * add a shape to this drawing
- */
- @Override
- @Internal
- public void addShape(HSSFShape shape) {
- shape.setPatriarch(this);
- _shapes.add(shape);
- }
-
- private void onCreate(HSSFShape shape) {
- EscherContainerRecord spgrContainer =
- _boundAggregate.getEscherContainer().getChildContainers().get(0);
-
- EscherContainerRecord spContainer = shape.getEscherContainer();
- int shapeId = newShapeId();
- shape.setShapeId(shapeId);
-
- spgrContainer.addChildRecord(spContainer);
- shape.afterInsert(this);
- setFlipFlags(shape);
- }
-
- /**
- * Total count of all children and their children's children.
- * @return count of shapes including shapes inside shape groups
- */
- public int countOfAllChildren() {
- int count = _shapes.size();
- for (HSSFShape shape : _shapes) {
- count += shape.countOfAllChildren();
- }
- return count;
- }
-
- /**
- * Sets the coordinate space of this group. All children are constrained
- * to these coordinates.
- */
- @Override
- public void setCoordinates(int x1, int y1, int x2, int y2) {
- _spgrRecord.setRectY1(y1);
- _spgrRecord.setRectY2(y2);
- _spgrRecord.setRectX1(x1);
- _spgrRecord.setRectX2(x2);
- }
-
- /**
- * remove all shapes inside patriarch
- */
- @Override
- public void clear() {
- ArrayList <HSSFShape> copy = new ArrayList<>(_shapes);
- for (HSSFShape shape: copy){
- removeShape(shape);
- }
- }
-
- /**
- * @return new unique shapeId
- */
- int newShapeId() {
- DrawingManager2 dm = _sheet.getWorkbook().getWorkbook().getDrawingManager();
- EscherDgRecord dg =
- _boundAggregate.getEscherContainer().getChildById(EscherDgRecord.RECORD_ID);
- return dm.allocateShapeId(dg);
- }
-
- /**
- * Does this HSSFPatriarch contain a chart?
- * (Technically a reference to a chart, since they
- * get stored in a different block of records)
- * FIXME - detect chart in all cases (only seems
- * to work on some charts so far)
- */
- public boolean containsChart() {
- // TODO - support charts properly in usermodel
-
- // We're looking for a EscherOptRecord
- EscherOptRecord optRecord = (EscherOptRecord)
- _boundAggregate.findFirstWithId(EscherOptRecord.RECORD_ID);
- if (optRecord == null) {
- // No opt record, can't have chart
- return false;
- }
-
- for (EscherProperty prop : optRecord.getEscherProperties()) {
- if (prop.getPropertyNumber() == 896 && prop.isComplex()) {
- EscherComplexProperty cp = (EscherComplexProperty) prop;
- String str = StringUtil.getFromUnicodeLE(cp.getComplexData());
-
- if (str.equals("Chart 1\0")) {
- return true;
- }
- }
- }
-
- return false;
- }
-
- /**
- * @return x coordinate of the left up corner
- */
- @Override
- public int getX1() {
- return _spgrRecord.getRectX1();
- }
-
- /**
- * @return y coordinate of the left up corner
- */
- @Override
- public int getY1() {
- return _spgrRecord.getRectY1();
- }
-
- /**
- * @return x coordinate of the right down corner
- */
- @Override
- public int getX2() {
- return _spgrRecord.getRectX2();
- }
-
- /**
- * @return y coordinate of the right down corner
- */
- @Override
- public int getY2() {
- return _spgrRecord.getRectY2();
- }
-
- /**
- * Returns the aggregate escher record we're bound to
- * @return - low level representation of sheet drawing data
- */
- @Internal
- public EscherAggregate getBoundAggregate() {
- return _boundAggregate;
- }
-
- /**
- * Creates a new client anchor and sets the top-left and bottom-right
- * coordinates of the anchor.
- *
- * @param dx1 the x coordinate in EMU within the first cell.
- * @param dy1 the y coordinate in EMU within the first cell.
- * @param dx2 the x coordinate in EMU within the second cell.
- * @param dy2 the y coordinate in EMU within the second cell.
- * @param col1 the column (0 based) of the first cell.
- * @param row1 the row (0 based) of the first cell.
- * @param col2 the column (0 based) of the second cell.
- * @param row2 the row (0 based) of the second cell.
- * @return the newly created client anchor
- */
- @Override
- public HSSFClientAnchor createAnchor(int dx1, int dy1, int dx2, int dy2, int col1, int row1, int col2, int row2) {
- return new HSSFClientAnchor(dx1, dy1, dx2, dy2, (short) col1, row1, (short) col2, row2);
- }
-
- /**
- * create shape tree from existing escher records tree
- */
- void buildShapeTree() {
- EscherContainerRecord dgContainer = _boundAggregate.getEscherContainer();
- if (dgContainer == null) {
- return;
- }
- EscherContainerRecord spgrConrainer = dgContainer.getChildContainers().get(0);
- List<EscherContainerRecord> spgrChildren = spgrConrainer.getChildContainers();
-
- for (int i = 0; i < spgrChildren.size(); i++) {
- EscherContainerRecord spContainer = spgrChildren.get(i);
- if (i != 0) {
- HSSFShapeFactory.createShapeTree(spContainer, _boundAggregate, this, _sheet.getWorkbook().getDirectory());
- }
- }
- }
-
- private void setFlipFlags(HSSFShape shape){
- EscherSpRecord sp = shape.getEscherContainer().getChildById(EscherSpRecord.RECORD_ID);
- if (shape.getAnchor().isHorizontallyFlipped()) {
- sp.setFlags(sp.getFlags() | EscherSpRecord.FLAG_FLIPHORIZ);
- }
- if (shape.getAnchor().isVerticallyFlipped()) {
- sp.setFlags(sp.getFlags() | EscherSpRecord.FLAG_FLIPVERT);
- }
- }
-
- @Override
- public Iterator<HSSFShape> iterator() {
- return _shapes.iterator();
- }
-
- protected HSSFSheet getSheet() {
- return _sheet;
- }
- }
|