qadevOOo/tests/java/mod/_sc/ScAnnotationShapeObj.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 package mod._sc;
  19
  20 import com.sun.star.container.XIndexAccess;
  21 import com.sun.star.lang.XComponent;
  22 import com.sun.star.lang.XMultiServiceFactory;
  23 import com.sun.star.sheet.XSheetAnnotation;
  24 import com.sun.star.sheet.XSheetAnnotationAnchor;
  25 import com.sun.star.sheet.XSheetAnnotationShapeSupplier;
  26 import com.sun.star.sheet.XSpreadsheet;
  27 import com.sun.star.sheet.XSpreadsheetDocument;
  28 import com.sun.star.sheet.XSpreadsheets;
  29 import com.sun.star.table.CellAddress;
  30 import com.sun.star.table.XCell;
  31 import com.sun.star.table.XCellRange;
  32 import com.sun.star.text.XSimpleText;
  33 import com.sun.star.uno.AnyConverter;
  34 import com.sun.star.uno.Type;
  35 import com.sun.star.uno.UnoRuntime;
  36 import com.sun.star.uno.XInterface;
  37
  38 import lib.StatusException;
  39 import lib.TestCase;
  40 import lib.TestEnvironment;
  41 import lib.TestParameters;
  42
  43 import util.SOfficeFactory;
  44 import util.utils;
  45
  46 import java.io.PrintWriter;
  47 import util.DefaultDsc;
  48 import util.InstCreator;
  49
  50
  51 /**
  52 * Test for object which represents some text annotation
  53 * anchored to some cell in spreadsheet (implement
  54 * <code>com.sun.star.sheet.CellAnnotation</code>).<p>
  55 * Object implements the following interfaces :
  56 * <ul>
  57 *  <li> <code>com::sun::star::text::XSimpleText</code></li>
  58 *  <li> <code>com::sun::star::text::XTextRange</code></li>
  59 *  <li> <code>com::sun::star::sheet::XSheetAnnotation</code></li>
  60 * </ul>
  61 * This object test <b> is NOT </b> designed to be run in several
  62 * threads concurently.
  63 * @see com.sun.star.sheet.CellAnnotation
  64 * @see com.sun.star.text.XSimpleText
  65 * @see com.sun.star.text.XTextRange
  66 * @see com.sun.star.sheet.XSheetAnnotation
  67 * @see ifc.text._XSimpleText
  68 * @see ifc.text._XTextRange
  69 * @see ifc.sheet._XSheetAnnotation
  70 */
  71 public class ScAnnotationShapeObj extends TestCase {
  72     private XSpreadsheetDocument xSheetDoc = null;
  73
  74     /**
  75     * Creates a spreadsheet document.
  76     */
  77     protected void initialize(TestParameters tParam, PrintWriter log) {
  78         SOfficeFactory SOF =
  79             SOfficeFactory.getFactory((XMultiServiceFactory) tParam
  80                 .getMSF());
  81
  82         try {
  83             log.println("creating a Spreadsheet document");
  84             log.println("Loading: "+utils.getFullTestURL(
  85                             "ScAnnotationShapeObj.sxc"));
  86             xSheetDoc =
  87                 UnoRuntime.queryInterface(XSpreadsheetDocument.class,
  88                     SOF.loadDocument(utils.getFullTestURL(
  89                             "ScAnnotationShapeObj.sxc")));
  90         } catch (com.sun.star.uno.Exception e) {
  91             // Some exception occurs.FAILED
  92             e.printStackTrace(log);
  93             throw new StatusException("Couldn't create document", e);
  94         }
  95     }
  96
  97     /**
  98     * Disposes a spreadsheet document.
  99     */
 100     protected void cleanup(TestParameters tParam, PrintWriter log) {
 101         log.println("    disposing xSheetDoc ");
 102
 103         XComponent oComp =
 104             UnoRuntime.queryInterface(XComponent.class,
 105             xSheetDoc);
 106         util.DesktopTools.closeDoc(oComp);
 107     }
 108
 109     /**
 110     * Creating a Testenvironment for the interfaces to be tested.
 111     * Retrieves a collection of spreadsheets from a document,
 112     * and takes one them. Then a single cell is retrieved, and
 113     * using its <code>com.sun.star.sheet.XSheetAnnotationAnchor</code>
 114     * interface an annotation is got.
 115     * Object relations created :
 116     * <ul>
 117     *  <li> <code>'CELLPOS'</code> for
 118     *      {@link ifc.sheet._XSheetAnnotation} (of <code>
 119     *       com.sun.star.table.CellAddress</code> type) which
 120     *      contains the annotation cell address.</li>
 121     * </ul>
 122     */
 123     public synchronized TestEnvironment createTestEnvironment(
 124         TestParameters Param, PrintWriter log) throws StatusException {
 125         XInterface oObj = null;
 126
 127         // creation of testobject here
 128         // first we write what we are intend to do to log file
 129         log.println("Creating a test environment");
 130
 131         CellAddress cellPos = new CellAddress((short) 0, 1, 2);
 132
 133         log.println("Getting test object ");
 134
 135         XSpreadsheetDocument xArea =
 136             UnoRuntime.queryInterface(XSpreadsheetDocument.class,
 137             xSheetDoc);
 138         XSpreadsheets oSheets = xArea.getSheets();
 139
 140         XIndexAccess XAccess =
 141             UnoRuntime.queryInterface(XIndexAccess.class,
 142             oSheets);
 143         XCell oCell = null;
 144
 145         try {
 146             XSpreadsheet oSheet =
 147                 (XSpreadsheet) AnyConverter.toObject(new Type(
 148                         XSpreadsheet.class),
 149                     XAccess.getByIndex(cellPos.Sheet));
 150             XCellRange oCRange =
 151                 UnoRuntime.queryInterface(XCellRange.class,
 152                 oSheet);
 153             oCell =
 154                 oCRange.getCellByPosition(cellPos.Column, cellPos.Row);
 155         } catch (com.sun.star.lang.WrappedTargetException e) {
 156             e.printStackTrace(log);
 157             throw new StatusException("Error getting test object from spreadsheet document",
 158                 e);
 159         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 160             e.printStackTrace(log);
 161             throw new StatusException("Error getting test object from spreadsheet document",
 162                 e);
 163         } catch (com.sun.star.lang.IllegalArgumentException e) {
 164             e.printStackTrace(log);
 165             throw new StatusException("Error getting test object from spreadsheet document",
 166                 e);
 167         }
 168
 169         XSheetAnnotationAnchor oAnnoA =
 170             UnoRuntime.queryInterface(XSheetAnnotationAnchor.class,
 171             oCell);
 172         XSheetAnnotation oAnno = oAnnoA.getAnnotation();
 173
 174         XSimpleText xAnnoText =
 175             UnoRuntime.queryInterface(XSimpleText.class,
 176             oAnno);
 177         xAnnoText.setString("ScAnnotationShapeObj");
 178
 179         XSheetAnnotationShapeSupplier xSheetAnnotationShapeSupplier =
 180             UnoRuntime.queryInterface(XSheetAnnotationShapeSupplier.class,
 181             oAnno);
 182
 183         oObj = xSheetAnnotationShapeSupplier.getAnnotationShape();
 184
 185         log.println("ImplementationName: "
 186             + util.utils.getImplName(oObj));
 187
 188         TestEnvironment tEnv = new TestEnvironment(oObj);
 189
 190         //adding ObjRelation for RotationDescriptor
 191         tEnv.addObjRelation("NoShear", Boolean.TRUE);
 192
 193         //adding ObjRelation for XText
 194         DefaultDsc tDsc = new DefaultDsc("com.sun.star.text.XTextContent",
 195                                     "com.sun.star.text.TextField.DateTime");
 196
 197         log.println( "adding InstCreator object" );
 198         tEnv.addObjRelation(
 199             "XTEXTINFO", new InstCreator( xSheetDoc, tDsc ) );
 200
 201         return tEnv;
 202     }
 203 }
 204  // finish class ScAnnotationShapeObj