/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: _XSubmit.java,v $
* $Revision: 1.4 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
package ifc.form;
import lib.MultiMethodTest;
import com.sun.star.awt.MouseEvent;
import com.sun.star.awt.XControl;
import com.sun.star.beans.XPropertySet;
import com.sun.star.form.XSubmit;
import com.sun.star.form.XSubmitListener;
import com.sun.star.lang.EventObject;
import com.sun.star.uno.UnoRuntime;
/**
* Testing <code>com.sun.star.form.XSubmit</code>
* interface methods :
* <ul>
* <li><code> submit()</code></li>
* <li><code> addSubmitListener()</code></li>
* <li><code> removeSubmitListener()</code></li>
* </ul> <p>
*
* This test needs the following object relations :
* <ul>
* <li> <code>'XSubmit.Control'</code> <b>optional</b>
* (of type <code>com.sun.star.awt.XControl</code>):
* is used to pass as parameters to <code>submit</code>
* method. <code>null</code> is passed if the relation
* is not found.</li>
* <ul> <p>
*
* Other <b> prerequicity </b> is the object must have
* <code>TargetURL</code> property. <p>
*
* Short description : test adds two listeners, call
* <code> submit </code> method and cecks if both listeners
* were called. Then one listener is removed and after
* <code> submit </code> method call it must not be called. <p>
*
* Test is <b> NOT </b> multithread compilant. <p>
* @see com.sun.star.form.XSubmit
*/
public class _XSubmit extends MultiMethodTest {
public static XSubmit oObj = null;
public class MySubmitListener implements XSubmitListener {
public int called = 0 ;
public void disposing ( EventObject oEvent ) {
}
public boolean approveSubmit( EventObject oEvent ) {
called += 1;
System.out.println("Listener called");
return true;
}
}
MySubmitListener listener1 = new MySubmitListener();
MySubmitListener listener2 = new MySubmitListener();
/**
* Just adds two submit listeners. <p>
* Status of this method test is defined in <code>
* submit </code> method test.
*/
public void _addSubmitListener() {
log.println("Testing addSubmitListener ...");
oObj.addSubmitListener( listener1 );
oObj.addSubmitListener( listener2 );
}
/**
* Before submision tries to set 'TargetURL' property
* of component to some value assuming that component
* supports <code>com.sun.star.form.HTMLForm</code>
* service.
* Then calls the <code> submit </code> method and checks
* if listener removed were not called, and other was
* called only once.<p>
*
* Has <b> OK </b> status for <code>submit</code> if
* listener was called at least ones, for
* <code>addSubmitListener</code> method if the remaining
* listener was called only once, for
* <code>removeSubmitListener</code> method if the removed
* listener was not called. <p>
*
* The following method tests are to be completed successfully before :
* <ul>
* <li> <code> removeSubmitListener </code> : to have one listener
* added and other removed.</li>
* </ul>
*/
public void _submit() {
executeMethod("removeSubmitListener()");
log.println("Testing submit() ...");
XControl cntrl = (XControl) tEnv.getObjRelation("XSubmit.Control") ;
XPropertySet xPS = (XPropertySet) UnoRuntime.queryInterface
(XPropertySet.class, oObj) ;
if (xPS != null) {
try {
xPS.setPropertyValue("TargetURL", "someserver");
} catch (com.sun.star.lang.WrappedTargetException e) {
e.printStackTrace(log);
} catch (com.sun.star.lang.IllegalArgumentException e) {
e.printStackTrace(log);
} catch (com.sun.star.beans.PropertyVetoException e) {
e.printStackTrace(log);
} catch (com.sun.star.beans.UnknownPropertyException e) {
e.printStackTrace(log);
}
} else {
log.println("!!! The tested compoennt doesn't support XPropertySet ");
}
oObj.submit(cntrl, new MouseEvent());
shortWait();
log.println("Listener1 called " + listener1.called + " times");
log.println("Listener2 called " + listener2.called + " times");
tRes.tested("addSubmitListener()", listener2.called == 1);
tRes.tested("removeSubmitListener()", listener1.called == 0);
tRes.tested("submit()", listener2.called > 0);
oObj.removeSubmitListener(listener2);
}
/**
* Just removes one of submit listeners. <p>
* Status of this method test is defined in <code>
* submit </code> method test.
* The following method tests are to be completed successfully before :
* <ul>
* <li> <code> removeSubmitListener </code> : to have listeners added</li>
* </ul>
*/
public void _removeSubmitListener() {
requiredMethod("addSubmitListener()");
oObj.removeSubmitListener(listener1);
}
/**
* Sleeps for 0.2 sec. to allow StarOffice to react on <code>
* reset</code> call.
*/
private void shortWait() {
try {
Thread.sleep(200) ;
} catch (InterruptedException e) {
log.println("While waiting :" + e) ;
}
}
/**
* Forces environment recreation.
*/
protected void after() {
disposeEnvironment();
}
}