/*
* 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.XDispatch;
import com.sun.star.util.URL;
import lib.MultiMethodTest;
import lib.Status;
import lib.StatusException;
import com.sun.star.frame.XNotifyingDispatch;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.frame.DispatchResultEvent;
/**
* Testing com.sun.star.frame.XDispatch
* interface methods :
*
*
dispatch()
*
addStatusListener()
*
removeStatusListener()
*
* This test needs the following object relations :
*
*
'XDispatch.URL' (of type com.sun.star.util.URL
* ): URL for passing to dispatch() method.
*
* @see com.sun.star.frame.XDispatch
* @see com.sun.star.frame.XNotifyingDispatch
* @see ifc.frame._XDispatch
* @see ifc.frame._XNotifyingDispatch
*/
public class _XDispatch extends MultiMethodTest {
public XDispatch oObj = null;
/**
* Listener implementation which sets flags on appropriate method calls
*/
protected class TestStatusListener implements
com.sun.star.frame.XStatusListener {
public boolean disposingCalled = false ;
public boolean statusChangedCalled = false ;
private java.io.PrintWriter log = null ;
public TestStatusListener(java.io.PrintWriter log) {
this.log = log ;
}
public void disposing(com.sun.star.lang.EventObject e) {
disposingCalled = true ;
log.println(" disposing was called.") ;
}
public void statusChanged(com.sun.star.frame.FeatureStateEvent e) {
statusChangedCalled = true ;
log.println(" statusChanged was called.") ;
log.println(" FeatureURL = '" + e.FeatureURL + "'");
log.println(" FeatureDescriptor = '" + e.FeatureDescriptor + "'");
log.println(" IsEnabled = " + e.IsEnabled);
log.println(" Requery = " + e.Requery);
log.println(" State = '" + e.State.toString() + "'");
}
}
/**
* Listener implementation which sets flags on appropriate method calls
*/
protected class TestNotificationListener implements
com.sun.star.frame.XDispatchResultListener {
public boolean disposingCalled = false ;
public boolean finishedDispatch = false ;
private java.io.PrintWriter log = null ;
public TestNotificationListener(java.io.PrintWriter log) {
this.log = log ;
}
public void disposing(com.sun.star.lang.EventObject e) {
disposingCalled = true ;
log.println(" disposing was called.") ;
}
public void dispatchFinished( DispatchResultEvent e) {
finishedDispatch = true ;
log.println(" dispatchFinished was called.") ;
}
}
TestStatusListener listener = null ;
TestNotificationListener notificationListener = null;
URL url = null ;
/**
* Not all implementations could call the
* com.sun.star.frame.XStatusListener. For this purposes the
* com.sun.star.frame.XDispatchWithNotification was designed.
* If com.sun.star.frame.XStatusListener was not called and
* com.sun.star.frame.XStatusListener is present, it was used
* to check listeners.
*/
private boolean checkXDispatchWithNotification()
{
XNotifyingDispatch xND = UnoRuntime.queryInterface(XNotifyingDispatch.class, oObj);
if ( xND != null) {
log.println(" XNotifyingDispatch found:");
PropertyValue[] arguments = (PropertyValue[])
tEnv.getObjRelation("XNotifyingDispatchArgument");
notificationListener = new TestNotificationListener(log) ;
xND.dispatchWithNotification(url, arguments, notificationListener);
try {
Thread.sleep(200);
}
catch(java.lang.InterruptedException e) {}
log.println(" Listener called: "+ notificationListener.finishedDispatch);
return notificationListener.finishedDispatch;
} else {
return false;
}
}
/**
* Retrieves object relations and creates new listeners.
* @throws StatusException If one of relations not found.
*/
@Override
public void before() {
listener = new TestStatusListener(log) ;
url = (URL) tEnv.getObjRelation("XDispatch.URL") ;
if (url == null) throw new StatusException
(Status.failed("Relation not found.")) ;
}
/**
* Calls the method using URL from relation.
* Has OK status if one listener (not removed) is called, and
* another (removed) is not.
* The following method tests are to be completed successfully before :
*
*
addStatusListener :
* to check that the listener is called
*
*
*/
public void _dispatch() {
requiredMethod("addStatusListener()") ;
boolean result = true ;
oObj.dispatch(url, new PropertyValue[0]) ;
try {
Thread.sleep(200);
}
catch(java.lang.InterruptedException e) {}
log.println("Listener called: "+ listener.statusChangedCalled);
result = listener.statusChangedCalled;
if (result == false) {
result = checkXDispatchWithNotification();
}
tRes.tested("dispatch()", result) ;
}
/**
* Adds two listeners.
* Has OK status if no runtime exceptions occurred.
*/
public void _addStatusListener() {
boolean result = true ;
oObj.addStatusListener(listener, url) ;
tRes.tested("addStatusListener()", result) ;
}
/**
* Removes the listener added before.
* Has OK status if the dispatch call doesn't call the listener.
* The following method tests are to be completed successfully before :
*