123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433 |
- /* ====================================================================
- 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.xssf.usermodel;
-
- import org.apache.poi.ooxml.util.POIXMLUnits;
- import org.apache.poi.ss.usermodel.ClientAnchor;
- import org.apache.poi.util.Internal;
- import org.apache.poi.util.Units;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTPoint2D;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D;
- import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker;
-
- /**
- * A client anchor is attached to an excel worksheet. It anchors against:
- * <ol>
- * <li>A fixed position and fixed size
- * <li>A position relative to a cell (top-left) and a fixed size
- * <li>A position relative to a cell (top-left) and sized relative to another cell (bottom right)
- * </ol>
- *
- * which method is used is determined by the {@link AnchorType}.
- */
- public class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor {
-
- /**
- * placeholder for zeros when needed for dynamic position calculations
- */
- private static final CTMarker EMPTY_MARKER = CTMarker.Factory.newInstance();
-
- private AnchorType anchorType;
-
- /**
- * Starting anchor point (top-left cell + relative offset)
- * if left null recalculate as needed from point
- */
- private CTMarker cell1;
-
- /**
- * Ending anchor point (bottom-right cell + relative offset)
- * if left null, re-calculate as needed from size and cell1
- */
- private CTMarker cell2;
-
- /**
- * if present, fixed size of the object to use instead of cell2, which is inferred instead
- */
- private CTPositiveSize2D size;
-
- /**
- * if present, fixed top-left position to use instead of cell1, which is inferred instead
- */
- private CTPoint2D position;
-
- /**
- * sheet to base dynamic calculations on, if needed. Required if size and/or position or set.
- * Not needed if cell1/2 are set explicitly (dynamic sizing and position relative to cells).
- */
- private XSSFSheet sheet;
-
- /**
- * Creates a new client anchor and defaults all the anchor positions to 0.
- * Sets the type to {@link AnchorType#MOVE_AND_RESIZE} relative to cell range A1:A1.
- */
- public XSSFClientAnchor() {
- this(0,0,0,0,0,0,0,0);
- }
-
- /**
- * Creates a new client anchor and sets the top-left and bottom-right
- * coordinates of the anchor by cell references and offsets.
- * Sets the type to {@link AnchorType#MOVE_AND_RESIZE}.
- *
- * @param dx1 the x coordinate within the first cell.
- * @param dy1 the y coordinate within the first cell.
- * @param dx2 the x coordinate within the second cell.
- * @param dy2 the y coordinate 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.
- */
- public XSSFClientAnchor(int dx1, int dy1, int dx2, int dy2, int col1, int row1, int col2, int row2) {
- anchorType = AnchorType.MOVE_AND_RESIZE;
- cell1 = CTMarker.Factory.newInstance();
- cell1.setCol(col1);
- cell1.setColOff(dx1);
- cell1.setRow(row1);
- cell1.setRowOff(dy1);
- cell2 = CTMarker.Factory.newInstance();
- cell2.setCol(col2);
- cell2.setColOff(dx2);
- cell2.setRow(row2);
- cell2.setRowOff(dy2);
- }
-
- /**
- * Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells.
- * Sets the type to {@link AnchorType#MOVE_AND_RESIZE}.
- * @param cell1 starting anchor point
- * @param cell2 ending anchor point
- */
- protected XSSFClientAnchor(CTMarker cell1, CTMarker cell2) {
- anchorType = AnchorType.MOVE_AND_RESIZE;
- this.cell1 = cell1;
- this.cell2 = cell2;
- }
-
- /**
- * Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells.
- * Sets the type to {@link AnchorType#MOVE_DONT_RESIZE}.
- *
- * @param sheet needed to calculate ending point based on column/row sizes
- * @param cell1 starting anchor point
- * @param size object size, to calculate ending anchor point
- */
- protected XSSFClientAnchor(XSSFSheet sheet, CTMarker cell1, CTPositiveSize2D size) {
- anchorType = AnchorType.MOVE_DONT_RESIZE;
- this.sheet = sheet;
- this.size = size;
- this.cell1 = cell1;
- // this.cell2 = calcCell(sheet, cell1, size.getCx(), size.getCy());
- }
-
- /**
- * Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells.
- * Sets the type to {@link AnchorType#DONT_MOVE_AND_RESIZE}.
- *
- * @param sheet needed to calculate starting and ending points based on column/row sizes
- * @param position starting absolute position
- * @param size object size, to calculate ending position
- */
- protected XSSFClientAnchor(XSSFSheet sheet, CTPoint2D position, CTPositiveSize2D size) {
- anchorType = AnchorType.DONT_MOVE_AND_RESIZE;
- this.sheet = sheet;
- this.position = position;
- this.size = size;
- // zeros for row/col/offsets
- // this.cell1 = calcCell(sheet, EMPTY_MARKER, position.getCx(), position.getCy());
- // this.cell2 = calcCell(sheet, cell1, size.getCx(), size.getCy());
- }
-
- private CTMarker calcCell(CTMarker cell, long w, long h) {
- CTMarker c2 = CTMarker.Factory.newInstance();
-
- int r = cell.getRow();
- int c = cell.getCol();
-
- int cw = Units.columnWidthToEMU(sheet.getColumnWidth(c));
-
- // start with width - offset, then keep adding column widths until the next one puts us over w
- long wPos = cw - POIXMLUnits.parseLength(cell.xgetColOff());
-
- while (wPos < w) {
- c++;
- cw = Units.columnWidthToEMU(sheet.getColumnWidth(c));
- wPos += cw;
- }
- // now wPos >= w, so end column = c, now figure offset
- c2.setCol(c);
- c2.setColOff(cw - (wPos - w));
-
- int rh = Units.toEMU(getRowHeight(sheet, r));
- // start with height - offset, then keep adding row heights until the next one puts us over h
- long hPos = rh - POIXMLUnits.parseLength(cell.xgetRowOff());
-
- while (hPos < h) {
- r++;
- rh = Units.toEMU(getRowHeight(sheet, r));
- hPos += rh;
- }
- // now hPos >= h, so end row = r, now figure offset
- c2.setRow(r);
- c2.setRowOff(rh - (hPos - h));
-
- return c2;
- }
-
- /**
- * @return height in twips (1/20th of point) for row or default
- */
- private static float getRowHeight(XSSFSheet sheet, int row) {
- XSSFRow r = sheet.getRow(row);
- return r == null ? sheet.getDefaultRowHeightInPoints() : r.getHeightInPoints();
- }
-
- private CTMarker getCell1() {
- return cell1 != null ? cell1 : calcCell(EMPTY_MARKER, POIXMLUnits.parseLength(position.xgetX()), POIXMLUnits.parseLength(position.xgetY()));
- }
-
- private CTMarker getCell2() {
- return cell2 != null ? cell2 : calcCell(getCell1(), size.getCx(), size.getCy());
- }
-
- @Override
- public short getCol1() {
- return (short)getCell1().getCol();
- }
-
- /**
- * @throws NullPointerException if cell1 is null (fixed position)
- */
- @Override
- public void setCol1(int col1) {
- cell1.setCol(col1);
- }
-
- @Override
- public short getCol2() {
- return (short) getCell2().getCol();
- }
-
- /**
- * @throws NullPointerException if cell2 is null (fixed size)
- */
- @Override
- public void setCol2(int col2) {
- cell2.setCol(col2);
- }
-
- @Override
- public int getRow1() {
- return getCell1().getRow();
- }
-
- /**
- * @throws NullPointerException if cell1 is null (fixed position)
- */
- @Override
- public void setRow1(int row1) {
- cell1.setRow(row1);
- }
-
- @Override
- public int getRow2() {
- return getCell2().getRow();
- }
-
- /**
- * @throws NullPointerException if cell2 is null (fixed size)
- */
- @Override
- public void setRow2(int row2) {
- cell2.setRow(row2);
- }
-
- @Override
- public int getDx1() {
- return Math.toIntExact(POIXMLUnits.parseLength(getCell1().xgetColOff()));
- }
-
- /**
- * @throws NullPointerException if cell1 is null (fixed position)
- * @see org.apache.poi.ss.usermodel.ChildAnchor#setDx1(int)
- */
- @Override
- public void setDx1(int dx1) {
- cell1.setColOff(dx1);
- }
-
- @Override
- public int getDy1() {
- return Math.toIntExact(POIXMLUnits.parseLength(getCell1().xgetRowOff()));
- }
-
- /**
- * @throws NullPointerException if cell1 is null (fixed position)
- * @see org.apache.poi.ss.usermodel.ChildAnchor#setDy1(int)
- */
- @Override
- public void setDy1(int dy1) {
- cell1.setRowOff(dy1);
- }
-
- @Override
- public int getDy2() {
- return Math.toIntExact(POIXMLUnits.parseLength(getCell2().xgetRowOff()));
- }
-
- /**
- * @throws NullPointerException if cell2 is null (fixed size)
- * @see org.apache.poi.ss.usermodel.ChildAnchor#setDy2(int)
- */
- @Override
- public void setDy2(int dy2) {
- cell2.setRowOff(dy2);
- }
-
- @Override
- public int getDx2() {
- return Math.toIntExact(POIXMLUnits.parseLength(getCell2().xgetColOff()));
- }
-
- /**
- * @throws NullPointerException if cell2 is null (fixed size)
- * @see org.apache.poi.ss.usermodel.ChildAnchor#setDx2(int)
- */
- @Override
- public void setDx2(int dx2) {
- cell2.setColOff(dx2);
- }
-
- @Override
- public boolean equals(Object o) {
- if (!(o instanceof XSSFClientAnchor)) return false;
-
- XSSFClientAnchor anchor = (XSSFClientAnchor) o;
- return getDx1() == anchor.getDx1() &&
- getDx2() == anchor.getDx2() &&
- getDy1() == anchor.getDy1() &&
- getDy2() == anchor.getDy2() &&
- getCol1() == anchor.getCol1() &&
- getCol2() == anchor.getCol2() &&
- getRow1() == anchor.getRow1() &&
- getRow2() == anchor.getRow2() ;
-
- }
-
- @Override
- public int hashCode() {
- assert false : "hashCode not designed";
- return 42; // any arbitrary constant will do
- }
-
- @Override
- public String toString(){
- return "from : " + getCell1() + "; to: " + getCell2();
- }
-
- /**
- * Return starting anchor point
- *
- * @return starting anchor point
- */
- @Internal
- public CTMarker getFrom(){
- return getCell1();
- }
-
- protected void setFrom(CTMarker from){
- cell1 = from;
- }
-
- /**
- * Return ending anchor point
- *
- * @return ending anchor point
- */
- @Internal
- public CTMarker getTo(){
- return getCell2();
- }
-
- protected void setTo(CTMarker to){
- cell2 = to;
- }
-
- /**
- * @return absolute top-left position, or null if position is determined from the "from" cell
- * @since POI 3.17 beta 1
- */
- public CTPoint2D getPosition() {
- return position;
- }
-
- /**
- * Sets the top-left absolute position of the object. To use this, "from" must be set to null.
- * @since POI 3.17 beta 1
- */
- public void setPosition(CTPoint2D position) {
- this.position = position;
- }
-
- /**
- *
- * @return size or null, if size is determined from the to and from cells
- * @since POI 3.17 beta 1
- */
- public CTPositiveSize2D getSize() {
- return size;
- }
-
- /**
- * Sets the size of the object. To use this, "to" must be set to null.
- * @since POI 3.17 beta 1
- */
- public void setSize(CTPositiveSize2D size) {
- this.size = size;
- }
-
- /**
- * Sets the anchor type
- * @param anchorType the anchor type to set
- * @since POI 3.14
- */
- @Override
- public void setAnchorType( AnchorType anchorType )
- {
- this.anchorType = anchorType;
- }
-
- /**
- * Gets the anchor type
- * Changed from returning an int to an enum in POI 3.14 beta 1.
- * @return the anchor type
- */
- @Override
- public AnchorType getAnchorType()
- {
- return anchorType;
- }
-
- public boolean isSet(){
- CTMarker c1 = getCell1();
- CTMarker c2 = getCell2();
- return !(c1.getCol() == 0 && c2.getCol() == 0 &&
- c1.getRow() == 0 && c2.getRow() == 0);
- }
- }
|