1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package ifc.frame;
import com.sun.star.beans.PropertyValue;
import com.sun.star.frame.XDesktop;
import com.sun.star.frame.XDispatch;
import com.sun.star.frame.XDispatchProvider;
import com.sun.star.frame.XDispatchRecorder;
import com.sun.star.frame.XModel;
import com.sun.star.frame.XDispatchRecorderSupplier;
import com.sun.star.frame.XFrame;
import com.sun.star.lang.XComponent;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.util.URL;
import lib.MultiMethodTest;
import lib.StatusException;
import util.SOfficeFactory;
import util.utils;
/**
* Testing <code>com.sun.star.frame.XDispatchRecorderSupplier</code>
* interface methods:
* <ul>
* <li><code> setDispatchRecorder() </code></li>
* <li><code> getDispatchRecorder() </code></li>
* <li><code> dispatchAndRecord() </code></li>
* </ul><p>
* Test is <b> NOT </b> multithread compliant. <p>
* @see com.sun.star.frame.XDispatchRecorderSupplier
*/
public class _XDispatchRecorderSupplier extends MultiMethodTest {
public static XDispatchRecorderSupplier oObj = null;
XComponent xTextDoc = null;
XDispatchRecorder recorder = null;
/**
* Simple <code>XDispatchRecorder</code> implementation
* which method <code>getRecordedMacro</code> returns a fixed
* string.
*/
private static class MyRecorder implements XDispatchRecorder {
public void startRecording(XFrame p0) {}
public void recordDispatch(URL p0, PropertyValue[] p1) {}
public void recordDispatchAsComment(URL p0, PropertyValue[] p1) {}
public void endRecording(){}
public String getRecordedMacro() {
return "MyRecorder implementation";
}
}
/**
* Creates a new document which supplies a frame.
* Also a <code>com.sun.star.frame.Desktop</code>
* service created for obtaining document's frame.
*/
@Override
protected void before() throws Exception {
SOfficeFactory SOF = SOfficeFactory.getFactory(tParam.getMSF());
log.println( "creating a text document" );
xTextDoc = SOF.createTextDoc(null);
Object inst = tParam.getMSF().createInstance
("com.sun.star.frame.Desktop");
UnoRuntime.queryInterface(XDesktop.class, inst);
}
/**
* Creates an instance of <code>MyRecorder</code> and set if,
* then get the current recorder. Second case is setting
* recorder to null. Finally restores the old macro recorder. <p>
*
* Has <b>OK</b> status if in the first case custom recorder
* was successfully returned, and in second case current
* recorder is null.
*/
public void _setDispatchRecorder() {
requiredMethod("getDispatchRecorder()");
boolean res = true,
locRes = true;
log.print("Setting custom macro recorder ...");
oObj.setDispatchRecorder(new MyRecorder());
XDispatchRecorder rec = oObj.getDispatchRecorder();
locRes = rec != null &&
"MyRecorder implementation".equals(rec.getRecordedMacro());
if (locRes) log.println("OK");
else log.println("FAILED");
res &= locRes;
log.print("Setting null dispatch recorder ...");
oObj.setDispatchRecorder(null);
locRes = oObj.getDispatchRecorder() == null;
if (locRes) log.println("OK");
else log.println("FAILED");
res &= locRes;
log.println("Setting old macro recorder ...");
oObj.setDispatchRecorder(recorder);
tRes.tested("setDispatchRecorder()", res);
}
/**
* Just gets the current recorder and stores it.
*
* Has <b>OK</b> status.
*/
public void _getDispatchRecorder() {
recorder = oObj.getDispatchRecorder();
tRes.tested("getDispatchRecorder()", true);
}
/**
* First sets the current dispatch recorder to new
* <code>DispatchRecorder</code> instance if the current one
* is null. The a <code>Dispatch</code> instance is created
* which inserts some text into text document.
* A number of cases is checked :
* <ul>
* <li> A valid call : here the recorded macro must contain
* inserted string and URL </li>
* <li> Call with invalid URL : the macro recorded must not
* contain this URL </li>
* <li> Call with null dispatcher : checking for GPF </li>
* <li> Call with the current recorder set to null :
* checking for GPF </li>
* </ul>
*
* Has <b>OK</b> status if all cases are OK.
*/
public void _dispatchAndRecord() throws Exception {
requiredMethod("getDispatchRecorder()");
boolean res = true;
if (recorder == null) {
try {
Object inst = tParam.getMSF().createInstance
("com.sun.star.comp.framework.DispatchRecorder");
recorder = UnoRuntime.queryInterface
(XDispatchRecorder.class, inst);
oObj.setDispatchRecorder(recorder);
} catch (com.sun.star.uno.Exception e) {
throw new StatusException("Couldn't create recorder", e);
}
}
waitForEventIdle();
XModel model = UnoRuntime.queryInterface(XModel.class, xTextDoc);
XFrame fr = model.getCurrentController().getFrame();
XDispatchProvider xDispProv = UnoRuntime.queryInterface(XDispatchProvider.class, fr);
URL dispURL = utils.parseURL(tParam.getMSF(), ".uno:InsertText");
XDispatch xDisp = xDispProv.queryDispatch(dispURL,"",0);
PropertyValue[] args = new PropertyValue[1];
args[0] = new PropertyValue();
args[0].Name = "Text";
args[0].Value = "XDispatchRecorderSupplier";
log.print("Dispatching and recording ...");
oObj.dispatchAndRecord(dispURL, args, xDisp);
String macro = recorder.getRecordedMacro();
boolean locRes = macro != null &&
macro.indexOf("XDispatchRecorderSupplier")>-1 &&
macro.indexOf(".uno:InsertText")>-1;
if (locRes) log.println("OK");
else log.println("FAILED");
res &= locRes;
log.println("Recorder macro :\n" + macro);
log.print("Trying to set dispatch with null Dispatcher ...");
try {
oObj.dispatchAndRecord(dispURL, args, null);
log.println("OK");
} catch (java.lang.Exception e){
log.println("Exception is OK: " + e);
}
log.print("Trying to set dispatch recorder to null and record ...");
oObj.setDispatchRecorder(null);
try {
oObj.dispatchAndRecord(dispURL, args, xDisp);
log.println("OK");
} catch (java.lang.Exception e){
log.println("Exception is OK: " + e);
}
oObj.setDispatchRecorder(recorder);
tRes.tested("dispatchAndRecord()", res);
}
/**
* Disposes the document created in <code>before()</code>
*/
@Override
protected void after() {
xTextDoc.dispose();
}
}
|