qadevOOo/tests/java/mod/_sw/SwXFootnotes.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
  19 package mod._sw;
  20
  21 import java.io.PrintWriter;
  22
  23 import lib.StatusException;
  24 import lib.TestCase;
  25 import lib.TestEnvironment;
  26 import lib.TestParameters;
  27 import util.SOfficeFactory;
  28
  29 import com.sun.star.lang.XMultiServiceFactory;
  30 import com.sun.star.text.XFootnote;
  31 import com.sun.star.text.XFootnotesSupplier;
  32 import com.sun.star.text.XText;
  33 import com.sun.star.text.XTextCursor;
  34 import com.sun.star.text.XTextDocument;
  35 import com.sun.star.uno.UnoRuntime;
  36 import com.sun.star.uno.XInterface;
  37
  38
  39 /**
  40  * Test for object which is represented by service
  41  * <code>com.sun.star.text.Footnotes</code>.<p>
  42  * Object implements the following interfaces :
  43  * <ul>
  44  *  <li> <code>com::sun::star::container::XIndexAccess</code></li>
  45  *  <li> <code>com::sun::star::container::XElementAccess</code></li>
  46  * </ul> <p>
  47  * This object test <b> is NOT </b> designed to be run in several
  48  * threads concurently.
  49  * @see com.sun.star.container.XIndexAccess
  50  * @see com.sun.star.container.XElementAccess
  51  * @see ifc.container._XIndexAccess
  52  * @see ifc.container._XElementAccess
  53  */
  54 public class SwXFootnotes extends TestCase {
  55     XTextDocument xTextDoc;
  56
  57     /**
  58     * Creates text document.
  59     */
  60     protected void initialize( TestParameters tParam, PrintWriter log ) {
  61         SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() );
  62         try {
  63             log.println( "creating a textdocument" );
  64             xTextDoc = SOF.createTextDoc( null );
  65         } catch ( com.sun.star.uno.Exception e ) {
  66             e.printStackTrace( log );
  67             throw new StatusException( "Couldn't create document", e );
  68         }
  69     }
  70
  71     /**
  72     * Disposes text document.
  73     */
  74     protected void cleanup( TestParameters tParam, PrintWriter log ) {
  75         log.println( "    disposing xTextDoc " );
  76         util.DesktopTools.closeDoc(xTextDoc);
  77     }
  78
  79     /**
  80     * Creating a Testenvironment for the interfaces to be tested.
  81     * Creates an instance of the service
  82     * <code>com.sun.star.text.Footnote</code>. Then inserts created Footnote
  83     * to the text, and finally gets all footnotes of text document
  84     * through <code>XFootnotesSupplier</code> interface.
  85     */
  86     public synchronized TestEnvironment createTestEnvironment(
  87             TestParameters Param, PrintWriter log ) throws StatusException {
  88         XFootnotesSupplier oInterface = null;
  89         XInterface oObj = null;
  90
  91         log.println( "Creating a test environment" );
  92         XMultiServiceFactory msf = UnoRuntime.queryInterface(XMultiServiceFactory.class, xTextDoc);
  93         log.println("creating a footnote");
  94         XFootnote oFootnote;
  95
  96         try {
  97             oFootnote = UnoRuntime.queryInterface(XFootnote.class,
  98                     msf.createInstance("com.sun.star.text.Footnote"));
  99         } catch (com.sun.star.uno.Exception e) {
 100             e.printStackTrace(log);
 101             throw new StatusException("Couldn't create footnote", e);
 102         }
 103
 104         XText oText = xTextDoc.getText();
 105         XTextCursor oCursor = oText.createTextCursor();
 106
 107         log.println("inserting the footnote into text document");
 108         try {
 109             oText.insertTextContent(oCursor, oFootnote, false);
 110         } catch (com.sun.star.lang.IllegalArgumentException e) {
 111             e.printStackTrace(log);
 112             throw new StatusException("Couldn't insert the footnote", e);
 113         }
 114         oInterface = UnoRuntime.queryInterface(XFootnotesSupplier.class, xTextDoc);
 115         oObj = oInterface.getFootnotes();
 116
 117         log.println( "creating a new environment for Foontnotes object" );
 118         TestEnvironment tEnv = new TestEnvironment(oObj);
 119         return tEnv;
 120     }
 121
 122 }    // finish class SwXFootnote
 123