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