/*************************************************************************
*
* 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: _XFrameLoader.java,v $
* $Revision: 1.5 $
*
* 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.frame;
import lib.MultiMethodTest;
import lib.Status;
import lib.StatusException;
import util.SOfficeFactory;
import com.sun.star.beans.PropertyValue;
import com.sun.star.frame.XDesktop;
import com.sun.star.frame.XFrame;
import com.sun.star.frame.XFrameLoader;
import com.sun.star.frame.XLoadEventListener;
import com.sun.star.lang.EventObject;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.uno.UnoRuntime;
/**
* Testing <code>com.sun.star.frame.XFrameLoader</code>
* interface methods :
* <ul>
* <li><code> load()</code></li>
* <li><code> cancel()</code></li>
* </ul> <p>
* This test needs the following object relations :
* <ul>
* <li> <code>'FrameLoader.URL'</code> (of type <code>String</code>):
* an url or component to be loaded </li>
* <li> <code>'FrameLoader.Frame'</code> <b>(optional)</b>
* (of type <code>com.sun.star.frame.XFrame</code>):
* a target frame where component to be loaded. If this
* relation is ommited then a text document created and its
* frame is used. </li>
* <li> <code>'FrameLoader.args'</code> <b>(optional)</b>
* (of type <code>Object[]</code>):
* necessary arguuments for loading a component. If ommited
* then zero length array is passed as parameter</li>
* <ul> <p>
* Test is <b> NOT </b> multithread compilant. <p>
* @see com.sun.star.frame.XFrameLoader
*/
public class _XFrameLoader extends MultiMethodTest {
public XFrameLoader oObj = null; // oObj filled by MultiMethodTest
private String url = null ;
private XFrame frame = null ;
private PropertyValue[] args = new PropertyValue[0] ;
/**
* Implemetation of load listener which geristers all it's calls.
*/
protected class TestListener implements XLoadEventListener {
public boolean finished = false ;
public boolean cancelled = false ;
public void loadFinished(XFrameLoader l) {
finished = true ;
}
public void loadCancelled(XFrameLoader l) {
cancelled = true ;
}
public void disposing(EventObject e) {}
}
TestListener listener = new TestListener() ;
XComponent frameSup = null ;
/**
* Retrieves all relations. If optional ones are not found
* creates their default values. <p>
* @throws StatusException If one of required relations not found.
*/
public void before() {
url = (String) tEnv.getObjRelation("FrameLoader.URL") ;
frame = (XFrame) tEnv.getObjRelation("FrameLoader.Frame") ;
if (frame == null) {
SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() );
try {
log.println( "creating a textdocument" );
frameSup = SOF.createTextDoc( null );
Object oDsk = ((XMultiServiceFactory)tParam.getMSF())
.createInstance("com.sun.star.frame.Desktop") ;
XDesktop dsk = (XDesktop)
UnoRuntime.queryInterface(XDesktop.class, oDsk) ;
shortWait() ;
frame = dsk.getCurrentFrame() ;
} catch ( com.sun.star.uno.Exception e ) {
// Some exception occures.FAILED
e.printStackTrace( log );
throw new StatusException( "Couldn't create a frame.", e );
}
}
Object args = tEnv.getObjRelation("FrameLoader.args") ;
if (args != null) this.args = (PropertyValue[]) args ;
if (url == null /*|| frame == null*/) {
throw new StatusException
(Status.failed("Some relations not found")) ;
}
}
private boolean loaded = false ;
/**
* Firts <code>cancel</code> method test is called.
* If in that test loaing process was interrupted by
* <code>cancel</code> call then <code>load</code> test
* executes. It loads a component, waits some moment to
* listener have a chance to be called and then checks
* if the load listener was called. <p>
* Has <b>OK</b> status if <code>cancel</code> method test
* didn't interrupt loading and it was successfull, or
* if in this method it loads successfull and listener's
* <code>finished</code> method was called.
* The following method tests are to be executed before :
* <ul>
* <li> <code> cancel() </code> </li>
* </ul>
*/
public void _load() {
executeMethod("cancel()") ;
if (!loaded) {
oObj.load(frame, url, args, listener) ;
shortWait();
loaded = listener.finished ;
}
tRes.tested("load()", loaded) ;
}
/**
* Starts to load a component and then immediatly tries to
* cancel the process. <p>
* Has <b>OK</b> status if the process was cancelled or
* finished (appropriate listener methods were called).
*/
public void _cancel() {
boolean result = true ;
oObj.load(frame, url, args, listener) ;
oObj.cancel() ;
shortWait();
if (listener.cancelled) {
log.println("Loading was canceled.") ;
}
if (listener.finished) {
log.println("Loading was finished.") ;
loaded = true ;
}
if (!listener.cancelled && !listener.finished) {
log.println("Loading was not canceled and not finished") ;
result = false ;
}
tRes.tested("cancel()", result) ;
}
public void after() {
if (frameSup != null) frameSup.dispose() ;
frame.dispose();
}
private void shortWait() {
try {
Thread.sleep(5000);
}
catch (InterruptedException ex) {
}
}
}