qadevOOo/tests/java/ifc/datatransfer/clipboard/_XClipboardNotifier.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.datatransfer.clipboard;
  20
  21 import lib.MultiMethodTest;
  22 import lib.StatusException;
  23
  24 import com.sun.star.datatransfer.DataFlavor;
  25 import com.sun.star.datatransfer.XTransferable;
  26 import com.sun.star.datatransfer.clipboard.ClipboardEvent;
  27 import com.sun.star.datatransfer.clipboard.XClipboard;
  28 import com.sun.star.datatransfer.clipboard.XClipboardListener;
  29 import com.sun.star.datatransfer.clipboard.XClipboardNotifier;
  30 import com.sun.star.datatransfer.clipboard.XClipboardOwner;
  31 import com.sun.star.lang.EventObject;
  32 import com.sun.star.uno.Type;
  33 import com.sun.star.uno.UnoRuntime;
  34
  35 /**
  36 * Testing <code>com.sun.star.datatransfer.clipboard.XClipboardNotifier</code>
  37 * interface methods :
  38 * <ul>
  39 *  <li><code> addClipboardListener()</code></li>
  40 *  <li><code> removeClipboardListener()</code></li>
  41 * </ul> <p>
  42 * The object <b>must also implement</b> <code>XClipboard</code>
  43 * interface. <p>
  44 * Test is <b> NOT </b> multithread compliant. <p>
  45 * @see com.sun.star.datatransfer.clipboard.XClipboardNotifier
  46 * @see com.sun.star.datatransfer.clipboard.XClipboard
  47 */
  48 public class _XClipboardNotifier extends MultiMethodTest {
  49
  50     public XClipboardNotifier oObj;
  51
  52     /**
  53      * <code>XClipboardOwner</code> interface implementation which
  54      * stores parameters passed to <code>lostOwnership</code> method.
  55      */
  56     class MyOwner implements XClipboardOwner {
  57         XClipboard board;
  58         XTransferable contents;
  59
  60         public void lostOwnership(XClipboard board, XTransferable contents) {
  61             this.board = board;
  62             this.contents = contents;
  63         }
  64     }
  65
  66     /**
  67      * Simpliest <code>XTransferable</code> interface implementation
  68      * which supports "text/htmp" data type.
  69      */
  70     class MyTransferable implements XTransferable {
  71         DataFlavor[] supportedFlavors;
  72
  73         public MyTransferable() {
  74             supportedFlavors = new DataFlavor[] {
  75                 new DataFlavor("text/plain", "Plain text", new Type(String.class))
  76             };
  77         }
  78
  79         public Object getTransferData(DataFlavor dataFlavor) {
  80             return "";
  81         }
  82
  83         public DataFlavor[] getTransferDataFlavors() {
  84             return supportedFlavors;
  85         }
  86
  87         public boolean isDataFlavorSupported(DataFlavor dataFlavor) {
  88             return supportedFlavors[0].MimeType.equals(dataFlavor.MimeType);
  89         }
  90     }
  91
  92     /**
  93      * Implementation of listener which registers its method calls.
  94      */
  95     class MyClipboardListener implements XClipboardListener {
  96         boolean called = false;
  97
  98         public void changedContents(ClipboardEvent evt) {
  99             called = true;
 100         }
 101
 102         public void disposing(EventObject wvt) {
 103             log.println("");
 104         }
 105     }
 106
 107     MyClipboardListener myListener;
 108
 109     /**
 110     * Adds a listener and put a new contents into clipboard. <p>
 111     * Has <b> OK </b> status if the listener was called on contents changing.
 112     */
 113     public void _addClipboardListener() {
 114         oObj.addClipboardListener(myListener = new MyClipboardListener());
 115
 116         XClipboard board = UnoRuntime.queryInterface(
 117                 XClipboard.class, tEnv.getTestObject());
 118
 119         board.setContents(new MyTransferable(), new MyOwner());
 120
 121         log.println("sleeping for 1 second");
 122
 123         try {
 124             Thread.sleep(1000);
 125         } catch (InterruptedException e) {
 126             log.println("interrupted");
 127             e.printStackTrace(log);
 128             throw new StatusException("Operation interrupted", e);
 129         }
 130
 131         tRes.tested("addClipboardListener()", myListener.called);
 132     }
 133
 134     /**
 135     * Removes the listener and put a new contents into clipboard. <p>
 136     * Has <b> OK </b> status if the listener was not called on contents
 137     * changing.
 138     * The following method tests are to be completed successfully before :
 139     * <ul>
 140     *  <li> <code>addClipboardListener()</code> </li>
 141     * </ul>
 142     */
 143     public void _removeClipboardListener() {
 144         try {
 145             requiredMethod("addClipboardListener()");
 146             myListener.called = false;
 147         } finally {
 148             oObj.removeClipboardListener(myListener);
 149         }
 150
 151         XClipboard board = UnoRuntime.queryInterface(
 152                 XClipboard.class, oObj);
 153
 154         board.setContents(new MyTransferable(), new MyOwner());
 155
 156         try {
 157             Thread.sleep(1000);
 158         } catch (InterruptedException e) {
 159             log.println("interrupted");
 160             e.printStackTrace(log);
 161             throw new StatusException("Operation interrupted", e);
 162         }
 163
 164         tRes.tested("removeClipboardListener()", !myListener.called);
 165     }
 166 }