qadevOOo/tests/java/ifc/accessibility/_XAccessibleEventBroadcaster.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: _XAccessibleEventBroadcaster.java,v $
  10  * $Revision: 1.8 $
  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.accessibility;
  32
  33 import lib.MultiMethodTest;
  34 import lib.Status;
  35 import lib.StatusException;
  36
  37 import com.sun.star.accessibility.AccessibleEventObject;
  38 import com.sun.star.accessibility.XAccessible;
  39 import com.sun.star.accessibility.XAccessibleContext;
  40 import com.sun.star.accessibility.XAccessibleEventBroadcaster;
  41 import com.sun.star.accessibility.XAccessibleEventListener;
  42 import com.sun.star.lang.EventObject;
  43 import com.sun.star.uno.UnoRuntime;
  44
  45 /**
  46  * Testing <code>
  47  * com.sun.star.accessibility.XAccessibleEventBroadcaster</code>
  48  * interface methods :
  49  * <ul>
  50  *  <li><code> addEventListener()</code></li>
  51  *  <li><code> removeEventListener()</code></li>
  52  * </ul> <p>
  53  *
  54  * This test needs the following object relations :
  55  * <ul>
  56  *  <li> <code>'EventProducer'</code> (of type
  57  *  <code>ifc.accessibility._XAccessibleEventBroadcaster.EventProducer</code>):
  58  *   this must be an implementation of the interface which could perform
  59  *   some actions for generating any kind of <code>AccessibleEvent</code></li>
  60  * <ul> <p>
  61  *
  62  * @see com.sun.star.accessibility.XAccessibleEventBroadcaster
  63  */
  64 public class _XAccessibleEventBroadcaster extends MultiMethodTest {
  65
  66     public static interface EventProducer {
  67         void fireEvent();
  68     }
  69
  70     public XAccessibleEventBroadcaster oObj = null;
  71     public String EventMsg = "";
  72     public boolean destroy = false;
  73
  74
  75     /**
  76      * Listener implementation which registers listener calls.
  77      */
  78     private class EvListener implements XAccessibleEventListener {
  79         public AccessibleEventObject notifiedEvent = null ;
  80         public void notifyEvent(AccessibleEventObject ev) {
  81             log.println("Listener, Event : " + ev.EventId);
  82             System.out.println("EventID: " + ev.EventId);
  83             Object old=ev.OldValue;
  84             if (old instanceof com.sun.star.accessibility.XAccessible) {
  85                 System.out.println("Old: "+((XAccessible)old).getAccessibleContext().getAccessibleName());
  86             }
  87
  88             Object nev=ev.NewValue;
  89             if (nev instanceof com.sun.star.accessibility.XAccessible) {
  90                 System.out.println("New: "+((XAccessible)nev).getAccessibleContext().getAccessibleName());
  91             }
  92             notifiedEvent = ev;
  93         }
  94
  95         public void disposing(EventObject ev) {}
  96     }
  97
  98     /**
  99      * Retrieves relation.
 100      * @throws StatusException If the relation is not found.
 101      */
 102     public void before() {
 103         prod = (EventProducer) tEnv.getObjRelation("EventProducer") ;
 104         if (prod == null) {
 105             throw new StatusException(Status.failed("Relation missed."));
 106         }
 107         EventMsg = (String) tEnv.getObjRelation("EventMsg");
 108         Object dp = tEnv.getObjRelation("Destroy");
 109         if (dp != null) {
 110             destroy=true;
 111         }
 112     }
 113
 114     EventProducer prod = null ;
 115     EvListener list = new EvListener();
 116
 117     /**
 118      * Adds two listeners and fires event by mean of object relation. <p>
 119      * Has <b> OK </b> status if both listeners were called
 120      */
 121     public void _addEventListener() {
 122         log.println("adding listener");
 123         oObj.addEventListener(list);
 124         boolean isTransient = chkTransient(tEnv.getTestObject());
 125         log.println("fire event");
 126         prod.fireEvent() ;
 127
 128         try {
 129             Thread.sleep(3000);
 130         }
 131         catch (InterruptedException ex) {
 132         }
 133
 134         boolean works = true;
 135
 136         if (list.notifiedEvent == null) {
 137             if (!isTransient) {
 138                 log.println("listener wasn't called");
 139                 works = false;
 140             } else {
 141                 log.println("Object is Transient, listener isn't expected to be called");
 142             }
 143             oObj.removeEventListener(list);
 144         }
 145
 146         if (EventMsg != null) {
 147             log.println(EventMsg);
 148             tRes.tested("addEventListener()", Status.skipped(true) );
 149             return;
 150         }
 151
 152         tRes.tested("addEventListener()", works );
 153     }
 154
 155     /**
 156      * Removes one of two listeners added before and and fires event
 157      * by mean of object relation. <p>
 158      *
 159      * Has <b> OK </b> status if the removed listener wasn't called. <p>
 160      *
 161      * The following method tests are to be completed successfully before :
 162      * <ul>
 163      *  <li> <code>addEventListener()</code> : to have added listeners </li>
 164      * </ul>
 165      */
 166     public void _removeEventListener() {
 167         requiredMethod("addEventListener()");
 168
 169         list.notifiedEvent = null;
 170
 171         log.println("remove listener");
 172         oObj.removeEventListener(list);
 173
 174         log.println("fire event");
 175         prod.fireEvent() ;
 176
 177         try {
 178             Thread.sleep(500);
 179         }
 180         catch (InterruptedException ex) {
 181         }
 182
 183         if (list.notifiedEvent == null) {
 184             log.println("listener wasn't called -- OK");
 185         }
 186
 187         tRes.tested("removeEventListener()", list.notifiedEvent == null);
 188
 189     }
 190
 191     protected static boolean chkTransient(Object Testcase) {
 192         boolean ret = false;
 193         XAccessibleContext accCon = (XAccessibleContext)
 194                     UnoRuntime.queryInterface(XAccessibleContext.class,Testcase);
 195         if (accCon.getAccessibleStateSet().contains(
 196             com.sun.star.accessibility.AccessibleStateType.TRANSIENT)){
 197             if (!accCon.getAccessibleParent().getAccessibleContext().getAccessibleStateSet().contains(
 198                 com.sun.star.accessibility.AccessibleStateType.MANAGES_DESCENDANTS)) {
 199                 throw new lib.StatusException(lib.Status.failed("Parent doesn't manage descendents"));
 200             }
 201             ret=true;
 202         }
 203         return ret;
 204     }
 205
 206     /**
 207     * Forces environment recreation.
 208     */
 209     protected void after() {
 210         if (destroy) disposeEnvironment();
 211     }
 212
 213
 214 }
 215