qadevOOo/tests/java/ifc/sheet/_XNamedRange.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.sheet;
  20
  21 import java.util.Random;
  22 import java.util.StringTokenizer;
  23
  24 import lib.MultiMethodTest;
  25
  26 import com.sun.star.sheet.NamedRangeFlag;
  27 import com.sun.star.sheet.XNamedRange;
  28 import com.sun.star.table.CellAddress;
  29
  30 /**
  31 * Testing <code>com.sun.star.sheet.XNamedRange</code>
  32 * interface methods :
  33 * <ul>
  34 *  <li><code> getContent()</code></li>
  35 *  <li><code> setContent()</code></li>
  36 *  <li><code> getReferencePosition()</code></li>
  37 *  <li><code> setReferencePosition()</code></li>
  38 *  <li><code> getType()</code></li>
  39 *  <li><code> setType()</code></li>
  40 * </ul> <p>
  41 * After test completion object environment has to be recreated.
  42 * @see com.sun.star.sheet.XNamedRange
  43 */
  44 public class _XNamedRange extends MultiMethodTest {
  45
  46     public XNamedRange oObj = null;
  47     String sContent = "";
  48     int type = 0;
  49     CellAddress CA = null;
  50
  51     /**
  52     * Test calls the method and compares returned value to value that was set
  53     * by method <code>setContent()</code>. <p>
  54     * Has <b> OK </b> status if values are equal. <p>
  55     * The following method tests are to be completed successfully before :
  56     * <ul>
  57     *  <li> <code> setContent() </code> : to have current content </li>
  58     * </ul>
  59     */
  60     public void _getContent() {
  61         requiredMethod("setContent()");
  62         String content = oObj.getContent();
  63         log.println("Returned content is \"" + content + "\"");
  64         boolean bResult = content.equals(sContent);
  65         tRes.tested("getContent()", bResult);
  66     }
  67
  68     /**
  69     * Test creates and stores random content and calls the method. <p>
  70     * Has <b> OK </b> status if the method successfully returns. <p>
  71     */
  72     public void _setContent() {
  73         sContent = getRandomContent("A1;A4:C5;=B2");
  74         log.println("Set content to \"" + sContent + "\"");
  75         oObj.setContent(sContent);
  76
  77         tRes.tested("setContent()", true);
  78     }
  79
  80     /**
  81     * Test calls the method and compares returned value to value that was set
  82     * by method <code>setType()</code>. <p>
  83     * Has <b> OK </b> status if values are equal. <p>
  84     * The following method tests are to be completed successfully before :
  85     * <ul>
  86     *  <li> <code> setType() </code> : to have current type </li>
  87     * </ul>
  88     */
  89     public void _getType() {
  90         requiredMethod("setType()");
  91
  92         int rtype = oObj.getType();
  93         log.println("Returned type is " + rtype);
  94
  95         tRes.tested("getType()", type == rtype);
  96     }
  97
  98     /**
  99     * Test sets random type and stores it. <p>
 100     * Has <b> OK </b> status if the method successfully returns. <p>
 101     */
 102     public void _setType() {
 103         /*
 104          * The type must be 0 or a combination of the NamedRangeFlag
 105          * constants and controls if the named range is listed in
 106          * dialogs prompting for special ranges
 107          *
 108          * NamedRangeFlag:    COLUMN_HEADER
 109          *                  FILTER_CRITERIA
 110          *                  PRINT_AREA
 111          *                  ROW_HEADER
 112          *
 113          */
 114         boolean bResult = true;
 115         int types[] = { 0,
 116                         NamedRangeFlag.COLUMN_HEADER,
 117                         NamedRangeFlag.FILTER_CRITERIA,
 118                         NamedRangeFlag.PRINT_AREA,
 119                         NamedRangeFlag.ROW_HEADER
 120                       };
 121
 122         Random rnd = new Random();
 123         type = types[rnd.nextInt(5)];
 124
 125         oObj.setType(type);
 126         log.println("The type was set to " + type);
 127
 128         tRes.tested("setType()", bResult);
 129     }
 130
 131     /**
 132     * Test calls the method and compares returned value to value that was set
 133     * by method <code>setReferencePosition()</code>. <p>
 134     * Has <b> OK </b> status if all fields of values are equal. <p>
 135     * The following method tests are to be completed successfully before :
 136     * <ul>
 137     *  <li> <code> setReferencePosition() </code> : to have current reference
 138     *  position </li>
 139     * </ul>
 140     */
 141     public void _getReferencePosition() {
 142         requiredMethod("setReferencePosition()");
 143
 144         CellAddress rCA = oObj.getReferencePosition();
 145         log.println("getReferencePosition returned (" +
 146             rCA.Sheet + ", " +
 147             rCA.Column + ", " + rCA.Row + ")" );
 148
 149         boolean bResult = rCA.Sheet == CA.Sheet;
 150         bResult &= rCA.Column == CA.Column;
 151         bResult &= rCA.Row == CA.Row;
 152
 153         tRes.tested("getReferencePosition()", bResult);
 154     }
 155
 156     /**
 157     * Test creates and stores cell address and calls the method. <p>
 158     * Has <b> OK </b> status if the method successfully returns. <p>
 159     */
 160     public void _setReferencePosition() {
 161         CA = new CellAddress((short)0, 2, 3);
 162         oObj.setReferencePosition(CA);
 163         log.println("ReferencePosition was set to (" +
 164             CA.Sheet + ", " +
 165             CA.Column + ", " + CA.Row + ")");
 166
 167         tRes.tested("setReferencePosition()", true);
 168     }
 169
 170
 171     /**
 172     * Method make string of random content.
 173     * @return string of random content
 174     */
 175     String getRandomContent(String str) {
 176
 177         String gRS = "none";
 178         Random rnd = new Random();
 179
 180         StringTokenizer ST = new StringTokenizer(str, ";");
 181         int nr = rnd.nextInt(ST.countTokens());
 182         if (nr < 1) nr++;
 183
 184         for (int i = 1; i < nr + 1; i++)
 185             gRS = ST.nextToken();
 186
 187         return gRS;
 188
 189     }
 190
 191     /**
 192     * Forces object environment recreation.
 193     */
 194     @Override
 195     protected void after() {
 196         disposeEnvironment();
 197     }
 198
 199 }
 200
 201