qadevOOo/tests/java/ifc/beans/_XMultiPropertyStates.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.beans;
  20
  21 import lib.MultiMethodTest;
  22 import lib.Status;
  23 import lib.StatusException;
  24
  25 import com.sun.star.beans.Property;
  26 import com.sun.star.beans.PropertyAttribute;
  27 import com.sun.star.beans.PropertyState;
  28 import com.sun.star.beans.XMultiPropertyStates;
  29 import com.sun.star.beans.XPropertySet;
  30 import com.sun.star.beans.XPropertySetInfo;
  31 import com.sun.star.uno.UnoRuntime;
  32
  33 /**
  34 * Testing <code>com.sun.star.beans.XMultiPropertyStates</code>
  35 * interface methods :
  36 * <ul>
  37 *  <li><code> getPropertyStates()</code></li>
  38 *  <li><code> setAllPropertiesToDefault()</code></li>
  39 *  <li><code> getPropertyValues()</code></li>
  40 *  <li><code> setPropertiesToDefault()</code></li>
  41 *  <li><code> getPropertyDefaults()</code></li>
  42 * </ul>
  43 * @see com.sun.star.beans.XMultiPropertyStates
  44 */
  45 public class _XMultiPropertyStates extends MultiMethodTest {
  46
  47     public XMultiPropertyStates oObj = null;
  48
  49     private PropertyState[] states = null;
  50     private String[] names = null;
  51
  52     @Override
  53     public void before() {
  54         names = (String[]) tEnv.getObjRelation("PropertyNames");
  55         if (names == null) {
  56             throw new StatusException(Status.failed("No PropertyNames given"));
  57         }
  58
  59         log.println("Totally " + names.length + " properties encountered:");
  60         log.print("{");
  61         for (int i = 0; i < names.length; i++)
  62             log.print(names[i] + " ");
  63         log.print("}");
  64         log.println("");
  65     }
  66
  67
  68     /**
  69     * Test calls the method and checks return value.
  70     * <code>PropertyDefaults</code> are stored<p>
  71     * Has <b> OK </b> status if the method returns not null value
  72     * and no exceptions were thrown. <p>
  73     */
  74     public void _getPropertyDefaults() {
  75         boolean result = false;
  76         try {
  77             Object[] defaults = oObj.getPropertyDefaults(names);
  78             result = (defaults != null) && defaults.length == names.length;
  79             log.println("Number of default values: " + defaults.length);
  80         } catch (com.sun.star.beans.UnknownPropertyException e) {
  81             log.println("some properties seem to be unknown: " + e.toString());
  82         } catch (com.sun.star.lang.WrappedTargetException e) {
  83             log.println("Wrapped target Exception was thrown: " + e.toString());
  84         }
  85         tRes.tested("getPropertyDefaults()", result) ;
  86     }
  87
  88     /**
  89     * Test calls the method and checks return value.
  90     * Has <b> OK </b> status if the method returns not null value
  91     * and no exceptions were thrown. <p>
  92     */
  93     public void _getPropertyStates() {
  94         boolean result = false;
  95         try {
  96             states = oObj.getPropertyStates(names);
  97             result = (states != null) && (states.length == names.length);
  98             log.println("Number of states: " + states.length);
  99         } catch (com.sun.star.beans.UnknownPropertyException e) {
 100             log.println("some properties seem to be unknown: " + e.toString());
 101         }
 102         tRes.tested("getPropertyStates()", result) ;
 103     }
 104
 105     /**
 106     * Test calls the method and checks return value.
 107     * Has <b> OK </b> status if the Property
 108     * has default state afterwards. <p>
 109     */
 110     public void _setPropertiesToDefault() {
 111         requiredMethod("getPropertyStates()");
 112         // searching for property which currently don't have default value
 113         // and preferable has MAYBEDEFAULT attr
 114         // if no such properties are found then the first one is selected
 115
 116         String ro = (String) tEnv.getObjRelation("allReadOnly");
 117         if (ro != null) {
 118             log.println(ro);
 119             tRes.tested("setPropertiesToDefault()",Status.skipped(true));
 120             return;
 121         }
 122
 123         boolean mayBeDef = false;
 124         String propName = names[0];
 125
 126         for(int i = 0; i < names.length; i++) {
 127             if (!mayBeDef && states[i] != PropertyState.DEFAULT_VALUE ) {
 128                 propName = names[i];
 129                 XPropertySet xPropSet = UnoRuntime.queryInterface(XPropertySet.class, oObj);
 130                 XPropertySetInfo xPropSetInfo = xPropSet.getPropertySetInfo();
 131                 Property prop = null;
 132                 try {
 133                     prop = xPropSetInfo.getPropertyByName(names[i]);
 134                 }
 135                 catch(com.sun.star.beans.UnknownPropertyException e) {
 136                     throw new StatusException(e, Status.failed("couldn't get property info"));
 137                 }
 138                 if ( (prop.Attributes & PropertyAttribute.MAYBEDEFAULT) != 0){
 139                     log.println("Property " + names[i] +
 140                         " 'may be default' and doesn't have default value");
 141                     mayBeDef = true;
 142                 }
 143             }
 144         }
 145         log.println("The property " + propName + " selected");
 146
 147         boolean result = false;
 148         try {
 149             String[] the_first = new String[1];
 150             the_first[0] = propName;
 151             log.println("Setting " + propName + " to default");
 152             oObj.setPropertiesToDefault(the_first);
 153             result = (oObj.getPropertyStates(the_first)[0].equals
 154                 (PropertyState.DEFAULT_VALUE));
 155         } catch (com.sun.star.beans.UnknownPropertyException e) {
 156             log.println("some properties seem to be unknown: " + e.toString());
 157         }
 158
 159         if (!result) {
 160             log.println("The property didn't change its state to default ...");
 161             if (mayBeDef) {
 162                 log.println("   ... and it may be default - FAILED");
 163             } else {
 164                 log.println("   ... but it may not be default - OK");
 165                 result = true;
 166             }
 167         }
 168
 169         tRes.tested("setPropertiesToDefault()", result) ;
 170     }
 171
 172     /**
 173     * Test calls the method and checks return value.
 174     * Has <b> OK </b> status if the all Properties
 175     * have default state afterwards. <p>
 176     */
 177     public void _setAllPropertiesToDefault() {
 178         requiredMethod("setPropertiesToDefault()");
 179         boolean result = true;
 180
 181        try {
 182             oObj.setAllPropertiesToDefault();
 183        } catch(RuntimeException e) {
 184            log.println("Ignore Runtime Exception: " + e.getMessage());
 185        }
 186         log.println("Checking that all properties are now in DEFAULT state" +
 187             " excepting may be those which 'cann't be default'");
 188
 189         try {
 190             states = oObj.getPropertyStates(names);
 191             for (int i = 0; i < states.length; i++) {
 192                 boolean part_result = states[i].equals
 193                     (PropertyState.DEFAULT_VALUE);
 194                 if (!part_result) {
 195                     log.println("Property '" + names[i] +
 196                         "' wasn't set to default");
 197                     XPropertySet xPropSet = UnoRuntime.queryInterface(XPropertySet.class, oObj);
 198                     XPropertySetInfo xPropSetInfo =
 199                         xPropSet.getPropertySetInfo();
 200                     Property prop = xPropSetInfo.getPropertyByName(names[i]);
 201                     if ( (prop.Attributes &
 202                             PropertyAttribute.MAYBEDEFAULT) != 0 ) {
 203                         log.println("   ... and it has MAYBEDEFAULT "+
 204                             "attribute - FAILED");
 205                     } else {
 206                         log.println("   ... but it has no MAYBEDEFAULT "+
 207                             "attribute - OK");
 208                         part_result = true;
 209                     }
 210                 }
 211
 212                 result &= part_result;
 213             }
 214         } catch (com.sun.star.beans.UnknownPropertyException e) {
 215             log.println("some properties seem to be unknown: " + e.toString());
 216             result=false;
 217         }
 218
 219         tRes.tested("setAllPropertiesToDefault()", result) ;
 220     }
 221
 222 }
 223