| /* ==================================================================== |
| 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.util.ArrayList; |
| import java.util.Iterator; |
| import java.util.List; |
| |
| import org.apache.poi.ddf.EscherComplexProperty; |
| import org.apache.poi.ddf.EscherOptRecord; |
| import org.apache.poi.ddf.EscherProperty; |
| import org.apache.poi.hssf.record.EscherAggregate; |
| 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. |
| * |
| * @author Glen Stampoultzis (glens at apache.org) |
| */ |
| public final class HSSFPatriarch implements HSSFShapeContainer |
| { |
| List shapes = new ArrayList(); |
| HSSFSheet sheet; |
| int x1 = 0; |
| int y1 = 0 ; |
| int x2 = 1023; |
| int y2 = 255; |
| |
| /** |
| * 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; |
| |
| /** |
| * Creates the patriarch. |
| * |
| * @param sheet the sheet this patriarch is stored in. |
| */ |
| HSSFPatriarch(HSSFSheet sheet, EscherAggregate boundAggregate) |
| { |
| this.boundAggregate = boundAggregate; |
| this.sheet = sheet; |
| } |
| |
| /** |
| * 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); |
| group.anchor = anchor; |
| shapes.add(group); |
| return group; |
| } |
| |
| /** |
| * Creates a simple shape. This includes such shapes as lines, rectangles, |
| * and ovals. |
| * |
| * @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); |
| shape.anchor = anchor; |
| shapes.add(shape); |
| return shape; |
| } |
| |
| /** |
| * Creates a picture. |
| * |
| * @param anchor the client anchor describes how this group is attached |
| * to the sheet. |
| * @return the newly created shape. |
| */ |
| public HSSFPicture createPicture(HSSFClientAnchor anchor, int pictureIndex) |
| { |
| HSSFPicture shape = new HSSFPicture(null, anchor); |
| shape.setPictureIndex( pictureIndex ); |
| shape.anchor = anchor; |
| shape.patriarch = this; |
| shapes.add(shape); |
| return shape; |
| } |
| |
| |
| /** |
| * 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); |
| shape.anchor = anchor; |
| shapes.add(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); |
| shape.anchor = anchor; |
| shapes.add(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); |
| shape.anchor = anchor; |
| shapes.add(shape); |
| return shape; |
| } |
| |
| /** |
| * Returns a list of all shapes contained by the patriarch. |
| */ |
| public List getChildren() |
| { |
| return shapes; |
| } |
| |
| /** |
| * Total count of all children and their children's children. |
| */ |
| public int countOfAllChildren() |
| { |
| int count = shapes.size(); |
| for ( Iterator iterator = shapes.iterator(); iterator.hasNext(); ) |
| { |
| HSSFShape shape = (HSSFShape) iterator.next(); |
| count += shape.countOfAllChildren(); |
| } |
| return count; |
| } |
| /** |
| * Sets the coordinate space of this group. All children are contrained |
| * to these coordinates. |
| */ |
| public void setCoordinates( int x1, int y1, int x2, int y2 ) |
| { |
| this.x1 = x1; |
| this.y1 = y1; |
| this.x2 = x2; |
| this.y2 = y2; |
| } |
| |
| /** |
| * 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(Iterator it = optRecord.getEscherProperties().iterator(); it.hasNext();) { |
| EscherProperty prop = (EscherProperty)it.next(); |
| if(prop.getPropertyNumber() == 896 && prop.isComplex()) { |
| EscherComplexProperty cp = (EscherComplexProperty)prop; |
| String str = StringUtil.getFromUnicodeLE(cp.getComplexData()); |
| //System.err.println(str); |
| if(str.equals("Chart 1\0")) { |
| return true; |
| } |
| } |
| } |
| |
| return false; |
| } |
| |
| /** |
| * The top left x coordinate of this group. |
| */ |
| public int getX1() |
| { |
| return x1; |
| } |
| |
| /** |
| * The top left y coordinate of this group. |
| */ |
| public int getY1() |
| { |
| return y1; |
| } |
| |
| /** |
| * The bottom right x coordinate of this group. |
| */ |
| public int getX2() |
| { |
| return x2; |
| } |
| |
| /** |
| * The bottom right y coordinate of this group. |
| */ |
| public int getY2() |
| { |
| return y2; |
| } |
| |
| /** |
| * Returns the aggregate escher record we're bound to |
| */ |
| protected EscherAggregate _getBoundAggregate() { |
| return boundAggregate; |
| } |
| } |