qadevOOo/tests/java/ifc/frame/_XDispatch.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: _XDispatch.java,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package ifc.frame;
  32
  33
  34 import com.sun.star.beans.PropertyValue;
  35 import com.sun.star.frame.XDispatch;
  36 import com.sun.star.util.URL;
  37 import lib.MultiMethodTest;
  38 import lib.Status;
  39 import lib.StatusException;
  40 import com.sun.star.frame.XNotifyingDispatch;
  41 import com.sun.star.uno.UnoRuntime;
  42 import com.sun.star.frame.DispatchResultEvent;
  43
  44 /**
  45 * Testing <code>com.sun.star.frame.XDispatch</code>
  46 * interface methods :
  47 * <ul>
  48 *  <li><code> dispatch()</code></li>
  49 *  <li><code> addStatusListener()</code></li>
  50 *  <li><code> removeStatusListener()</code></li>
  51 * </ul> <p>
  52 * This test needs the following object relations :
  53 * <ul>
  54 *  <li> <code>'XDispatch.URL'</code> (of type <code>com.sun.star.util.URL
  55 *   </code>): URL for passing to <code>dispatch()</code> method. </li>
  56 * <ul> <p>
  57 * @see com.sun.star.frame.XDispatch
  58 * @see com.sun.star.frame.XNotifyingDispatch
  59 * @see ifc.frame._XDispatch
  60 * @see ifc.frame._XNotifyingDispatch
  61 */
  62
  63 public class _XDispatch extends MultiMethodTest {
  64
  65     public XDispatch oObj = null;
  66
  67     /**
  68     * Listener implementation which sets flags on appropriate method calls
  69     */
  70     protected class TestStatusListener implements
  71             com.sun.star.frame.XStatusListener {
  72         public boolean disposingCalled = false ;
  73         public boolean statusChangedCalled = false ;
  74         private java.io.PrintWriter log = null ;
  75
  76         public TestStatusListener(java.io.PrintWriter log) {
  77             this.log = log ;
  78         }
  79
  80         public void disposing(com.sun.star.lang.EventObject e) {
  81             disposingCalled = true ;
  82             log.println(" disposing was called.") ;
  83         }
  84
  85         public void statusChanged(com.sun.star.frame.FeatureStateEvent e) {
  86             statusChangedCalled = true ;
  87             log.println(" statusChanged was called.") ;
  88             log.println("  FeatureURL = '" + e.FeatureURL + "'");
  89             log.println("  FeatureDescriptor = '" + e.FeatureDescriptor + "'");
  90             log.println("  IsEnabled = " + e.IsEnabled);
  91             log.println("  Requery = " + e.Requery);
  92             log.println("  State = '" + e.State.toString() +  "'");
  93         }
  94
  95     }
  96
  97     /**
  98     * Listener implementation which sets flags on appropriate method calls
  99     */
 100     protected class TestNotificationListener implements
 101             com.sun.star.frame.XDispatchResultListener {
 102         public boolean disposingCalled = false ;
 103         public boolean finishedDispatch = false ;
 104         private java.io.PrintWriter log = null ;
 105
 106         public TestNotificationListener(java.io.PrintWriter log) {
 107             this.log = log ;
 108         }
 109
 110         public void disposing(com.sun.star.lang.EventObject e) {
 111             disposingCalled = true ;
 112             log.println("   disposing was called.") ;
 113         }
 114
 115         public void dispatchFinished( DispatchResultEvent e) {
 116             finishedDispatch = true ;
 117             log.println("   dispatchFinished was called.") ;
 118         }
 119
 120     }
 121
 122     TestStatusListener listener = null ;
 123     TestNotificationListener notificationListener = null;
 124     URL url = null ;
 125
 126     /**
 127      * Not all implementations could call the
 128      * <code>com.sun.star.frame.XStatusListener</code>. For this purposes the
 129      * <code>com.sun.star.frame.XDispatchWithNotification</code> was designed.
 130      * If <code>com.sun.star.frame.XStatusListener</code> was not called and
 131      * <code>com.sun.star.frame.XStatusListener</code> is present, it was used
 132      * to check listeners.
 133     */
 134     private boolean checkXDispatchWithNotification()
 135     {
 136         XNotifyingDispatch xND = (XNotifyingDispatch)
 137                       UnoRuntime.queryInterface(XNotifyingDispatch.class, oObj);
 138         if ( xND != null) {
 139             log.println("   XNotifyingDispatch found:");
 140             PropertyValue[] arguments = (PropertyValue[])
 141                               tEnv.getObjRelation("XNotifyingDispatchArgument");
 142
 143             notificationListener = new TestNotificationListener(log) ;
 144             xND.dispatchWithNotification(url, arguments, notificationListener);
 145
 146             try {
 147                 Thread.sleep(200);
 148             }
 149             catch(java.lang.InterruptedException e) {}
 150
 151             log.println("   Listener called: "+ notificationListener.finishedDispatch);
 152
 153             return notificationListener.finishedDispatch;
 154         } else {
 155             return false;
 156         }
 157
 158     }
 159     /**
 160     * Retrieves object relations and creates new listeners.
 161     * @throws StatusException If one of relations not found.
 162     */
 163     public void before() {
 164         listener = new TestStatusListener(log) ;
 165         url = (URL) tEnv.getObjRelation("XDispatch.URL") ;
 166
 167         if (url == null) throw new StatusException
 168             (Status.failed("Relation not found.")) ;
 169     }
 170
 171     /**
 172     * Calls the method using URL from relation. <p>
 173     * Has <b> OK </b> status if one listener (not removed) is called, and
 174     * another (removed) is not.
 175     * The following method tests are to be completed successfully before :
 176     * <ul>
 177     *  <li> <code>addStatusListener</code> :
 178     *    to check that the listener is called
 179     *  </li>
 180     * </ul>
 181     */
 182     public void _dispatch() {
 183         requiredMethod("addStatusListener()") ;
 184
 185         boolean result = true ;
 186
 187         oObj.dispatch(url, new PropertyValue[0]) ;
 188
 189         try {
 190             Thread.sleep(200);
 191         }
 192         catch(java.lang.InterruptedException e) {}
 193
 194         log.println("Listener called: "+ listener.statusChangedCalled);
 195
 196         result = listener.statusChangedCalled;
 197
 198         if (result == false) {
 199             result = checkXDispatchWithNotification();
 200         }
 201
 202         tRes.tested("dispatch()", result) ;
 203     }
 204
 205     /**
 206     * Adds two listeners. <p>
 207     * Has <b> OK </b> status if no runtime exceptions occured.
 208     */
 209     public void _addStatusListener() {
 210
 211         boolean result = true ;
 212         oObj.addStatusListener(listener, url) ;
 213
 214         tRes.tested("addStatusListener()", result) ;
 215     }
 216
 217     /**
 218     * Removes the listener added before. <p>
 219     * Has <b> OK </b> status if the dispatch call doesn't call the listener.
 220     * The following method tests are to be completed successfully before :
 221     * <ul>
 222     *  <li> <code> dispatch() </code> : to have a listener to remove
 223     *  </li>
 224     * </ul>
 225     */
 226     public void _removeStatusListener() {
 227         requiredMethod("dispatch()") ;
 228         listener.statusChangedCalled = false;
 229         boolean result = true ;
 230         oObj.removeStatusListener(listener, url) ;
 231
 232         oObj.dispatch(url, new PropertyValue[0]) ;
 233
 234         try {
 235             Thread.sleep(200);
 236         }
 237         catch(java.lang.InterruptedException e) {}
 238
 239         System.out.println("Listener called: "+ listener.statusChangedCalled);
 240
 241         result = ! listener.statusChangedCalled;
 242
 243         tRes.tested("removeStatusListener()", result) ;
 244     }
 245 }
 246