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.sheet.XSheetAnnotation;
  23 import com.sun.star.sheet.XSheetAnnotationAnchor;
  24 import com.sun.star.sheet.XSheetAnnotationShapeSupplier;
  25 import com.sun.star.sheet.XSpreadsheet;
  26 import com.sun.star.sheet.XSpreadsheetDocument;
  27 import com.sun.star.sheet.XSpreadsheets;
  28 import com.sun.star.table.CellAddress;
  29 import com.sun.star.table.XCell;
  30 import com.sun.star.table.XCellRange;
  31 import com.sun.star.text.XSimpleText;
  32 import com.sun.star.uno.AnyConverter;
  33 import com.sun.star.uno.Type;
  34 import com.sun.star.uno.UnoRuntime;
  35 import com.sun.star.uno.XInterface;
  36
  37 import lib.TestCase;
  38 import lib.TestEnvironment;
  39 import lib.TestParameters;
  40
  41 import util.SOfficeFactory;
  42 import util.utils;
  43
  44 import java.io.PrintWriter;
  45 import util.DefaultDsc;
  46 import util.InstCreator;
  47
  48
  49 /**
  50 * Test for object which represents some text annotation
  51 * anchored to some cell in spreadsheet (implement
  52 * <code>com.sun.star.sheet.CellAnnotation</code>).<p>
  53 * Object implements the following interfaces :
  54 * <ul>
  55 *  <li> <code>com::sun::star::text::XSimpleText</code></li>
  56 *  <li> <code>com::sun::star::text::XTextRange</code></li>
  57 *  <li> <code>com::sun::star::sheet::XSheetAnnotation</code></li>
  58 * </ul>
  59 * This object test <b> is NOT </b> designed to be run in several
  60 * threads concurrently.
  61 * @see com.sun.star.sheet.CellAnnotation
  62 * @see com.sun.star.text.XSimpleText
  63 * @see com.sun.star.text.XTextRange
  64 * @see com.sun.star.sheet.XSheetAnnotation
  65 * @see ifc.text._XSimpleText
  66 * @see ifc.text._XTextRange
  67 * @see ifc.sheet._XSheetAnnotation
  68 */
  69 public class ScAnnotationShapeObj extends TestCase {
  70     private XSpreadsheetDocument xSheetDoc = null;
  71
  72     /**
  73     * Creates a spreadsheet document.
  74     */
  75     @Override
  76     protected void initialize(TestParameters tParam, PrintWriter log) throws Exception {
  77         SOfficeFactory SOF =
  78             SOfficeFactory.getFactory(tParam
  79                 .getMSF());
  80
  81         log.println("creating a Spreadsheet document");
  82         log.println("Loading: "+utils.getFullTestURL(
  83                         "ScAnnotationShapeObj.sxc"));
  84         xSheetDoc =
  85             UnoRuntime.queryInterface(XSpreadsheetDocument.class,
  86                 SOF.loadDocument(utils.getFullTestURL(
  87                         "ScAnnotationShapeObj.sxc")));
  88     }
  89
  90     /**
  91     * Disposes a spreadsheet document.
  92     */
  93     @Override
  94     protected void cleanup(TestParameters tParam, PrintWriter log) {
  95         log.println("    disposing xSheetDoc ");
  96
  97         XComponent oComp =
  98             UnoRuntime.queryInterface(XComponent.class,
  99             xSheetDoc);
 100         util.DesktopTools.closeDoc(oComp);
 101     }
 102
 103     /**
 104     * Creating a TestEnvironment for the interfaces to be tested.
 105     * Retrieves a collection of spreadsheets from a document,
 106     * and takes one them. Then a single cell is retrieved, and
 107     * using its <code>com.sun.star.sheet.XSheetAnnotationAnchor</code>
 108     * interface an annotation is got.
 109     * Object relations created :
 110     * <ul>
 111     *  <li> <code>'CELLPOS'</code> for
 112     *      {@link ifc.sheet._XSheetAnnotation} (of <code>
 113     *       com.sun.star.table.CellAddress</code> type) which
 114     *      contains the annotation cell address.</li>
 115     * </ul>
 116     */
 117     @Override
 118     public TestEnvironment createTestEnvironment(
 119         TestParameters Param, PrintWriter log) throws Exception {
 120         XInterface oObj = null;
 121
 122         // creation of testobject here
 123         // first we write what we are intend to do to log file
 124         log.println("Creating a test environment");
 125
 126         CellAddress cellPos = new CellAddress((short) 0, 1, 2);
 127
 128         log.println("Getting test object ");
 129
 130         XSpreadsheetDocument xArea =
 131             UnoRuntime.queryInterface(XSpreadsheetDocument.class,
 132             xSheetDoc);
 133         XSpreadsheets oSheets = xArea.getSheets();
 134
 135         XIndexAccess XAccess =
 136             UnoRuntime.queryInterface(XIndexAccess.class,
 137             oSheets);
 138         XCell oCell = null;
 139
 140         XSpreadsheet oSheet =
 141             (XSpreadsheet) AnyConverter.toObject(new Type(
 142                     XSpreadsheet.class),
 143                 XAccess.getByIndex(cellPos.Sheet));
 144         XCellRange oCRange =
 145             UnoRuntime.queryInterface(XCellRange.class,
 146             oSheet);
 147         oCell =
 148             oCRange.getCellByPosition(cellPos.Column, cellPos.Row);
 149
 150         XSheetAnnotationAnchor oAnnoA =
 151             UnoRuntime.queryInterface(XSheetAnnotationAnchor.class,
 152             oCell);
 153         XSheetAnnotation oAnno = oAnnoA.getAnnotation();
 154
 155         XSimpleText xAnnoText =
 156             UnoRuntime.queryInterface(XSimpleText.class,
 157             oAnno);
 158         xAnnoText.setString("ScAnnotationShapeObj");
 159
 160         XSheetAnnotationShapeSupplier xSheetAnnotationShapeSupplier =
 161             UnoRuntime.queryInterface(XSheetAnnotationShapeSupplier.class,
 162             oAnno);
 163
 164         oObj = xSheetAnnotationShapeSupplier.getAnnotationShape();
 165
 166         log.println("ImplementationName: "
 167             + util.utils.getImplName(oObj));
 168
 169         TestEnvironment tEnv = new TestEnvironment(oObj);
 170
 171         //adding ObjRelation for RotationDescriptor
 172         tEnv.addObjRelation("NoShear", Boolean.TRUE);
 173
 174         //adding ObjRelation for XText
 175         DefaultDsc tDsc = new DefaultDsc("com.sun.star.text.XTextContent",
 176                                     "com.sun.star.text.TextField.DateTime");
 177
 178         log.println( "adding InstCreator object" );
 179         tEnv.addObjRelation(
 180             "XTEXTINFO", new InstCreator( xSheetDoc, tDsc ) );
 181
 182         return tEnv;
 183     }
 184 }
 185  // finish class ScAnnotationShapeObj