qadevOOo/tests/java/ifc/frame/_XSynchronousFrameLoader.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 ifc.frame;
  20
  21 import lib.MultiMethodTest;
  22 import lib.Status;
  23 import lib.StatusException;
  24 import util.SOfficeFactory;
  25
  26 import com.sun.star.beans.PropertyValue;
  27 import com.sun.star.frame.XDesktop;
  28 import com.sun.star.frame.XFrame;
  29 import com.sun.star.frame.XSynchronousFrameLoader;
  30 import com.sun.star.lang.XComponent;
  31 import com.sun.star.lang.XMultiServiceFactory;
  32 import com.sun.star.uno.UnoRuntime;
  33 import com.sun.star.util.URL;
  34 import com.sun.star.util.XURLTransformer;
  35
  36 /**
  37  * Testing <code>com.sun.star.frame.XSynchronousFrameLoader</code>
  38  * interface methods :
  39  * <ul>
  40  *  <li><code> load()</code></li>
  41  *  <li><code> cancel()</code></li>
  42  * </ul> <p>
  43  * This test needs the following object relations :
  44  * <ul>
  45  *  <li> <code>'FrameLoader.URL'</code> (of type <code>String</code>):
  46  *   an url of component to be loaded </li>
  47  *  <li> <code>'FrameLoader.Frame'</code> <b>(optional)</b>
  48  *  (of type <code>com.sun.star.frame.XFrame</code>):
  49  *   a target frame where component to be loaded. If this
  50  *   relation is ommited then a text document created and its
  51  *   frame is used. </li>
  52  * <ul> <p>
  53  *
  54  * @see com.sun.star.frame.XSynchronousFrameLoader
  55  */
  56 public class _XSynchronousFrameLoader extends MultiMethodTest {
  57
  58     public XSynchronousFrameLoader oObj = null; // oObj filled by MultiMethodTest
  59     private String url = null ;
  60     private XFrame frame = null ;
  61     private XComponent frameSup = null ;
  62     private PropertyValue[] descr = null;
  63
  64     /**
  65      * Retrieves all relations. If optional relation
  66      * <code>FrameLoader.Frame</code> not found
  67      * creates a new document and otains its frame for loading. <p>
  68      *
  69      * Also <code>MediaDescriptor</code> is created using
  70      * URL from <code>FrameLoader.URL</code> relation.
  71      *
  72      * @throws StatusException If one of required relations not found.
  73      */
  74     public void before() {
  75         url = (String) tEnv.getObjRelation("FrameLoader.URL") ;
  76         frame = (XFrame) tEnv.getObjRelation("FrameLoader.Frame") ;
  77
  78         if (url == null) {
  79             throw new StatusException(Status.failed("Some relations not found")) ;
  80         }
  81
  82         SOfficeFactory SOF = SOfficeFactory.getFactory(
  83                              (XMultiServiceFactory)tParam.getMSF() );
  84
  85         XURLTransformer xURLTrans = null;
  86
  87         // if frame is not contained in relations the writer frmame will be used.
  88         if (frame == null) {
  89             try {
  90                 log.println( "creating a textdocument" );
  91                 frameSup = SOF.createTextDoc( null );
  92
  93                 Object oDsk = (
  94                     (XMultiServiceFactory)tParam.getMSF()).createInstance
  95                     ("com.sun.star.frame.Desktop") ;
  96                 XDesktop dsk = UnoRuntime.queryInterface
  97                     (XDesktop.class, oDsk) ;
  98                 frame = dsk.getCurrentFrame() ;
  99
 100                 Object o = (
 101                     (XMultiServiceFactory)tParam.getMSF()).createInstance
 102                     ("com.sun.star.util.URLTransformer") ;
 103                 xURLTrans = UnoRuntime.queryInterface
 104                     (XURLTransformer.class, o) ;
 105
 106             } catch ( com.sun.star.uno.Exception e ) {
 107                 // Some exception occurs.FAILED
 108                 e.printStackTrace( log );
 109                 throw new StatusException( "Couldn't create a document.", e );
 110             }
 111         }
 112
 113         URL[] urlS = new URL[1];
 114         urlS[0] = new URL();
 115         urlS[0].Complete = url;
 116         boolean res = xURLTrans.parseStrict(urlS);
 117         log.println("Parsing URL '" + url + "': " + res);
 118         descr = new PropertyValue[1] ;
 119         descr[0] = new PropertyValue();
 120         descr[0].Name = "URL" ;
 121         descr[0].Value = urlS[0] ;
 122     }
 123
 124
 125     /**
 126      * Tries to load component to a frame. <p>
 127      * Has <b> OK </b> status if <code>true</code> is returned.
 128      */
 129     public void _load() {
 130         boolean result = oObj.load(descr, frame) ;
 131
 132         tRes.tested("load()", result) ;
 133     }
 134
 135     /**
 136      * Tries to load component to a frame in separate thread to
 137      * avoid blocking of the current thread and imediately
 138      * cancels loading. <p>
 139      *
 140      * Has <b> OK </b> status if <code>flase</code> is returned,
 141      * i.e. loading was not completed.
 142      */
 143     public void _cancel() {
 144         requiredMethod("load()") ;
 145
 146         final boolean[] result = new boolean[1] ;
 147
 148         (new Thread() {
 149             public void run() {
 150                 result[0] = oObj.load(descr, frame);
 151             }
 152         }).start();
 153
 154         oObj.cancel() ;
 155
 156         try {
 157             Thread.sleep(1000);
 158         } catch (InterruptedException ex) {}
 159
 160
 161         tRes.tested("cancel()", !result[0]) ;
 162     }
 163
 164     /**
 165      * Disposes document if it was created for frame supplying.
 166      */
 167     protected void after() {
 168         if (frameSup != null) {
 169             frameSup.dispose();
 170         }
 171     }
 172 }
 173
 174