/*************************************************************************
*
* 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: _XSynchronousFrameLoader.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.XSynchronousFrameLoader;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.util.URL;
import com.sun.star.util.XURLTransformer;
/**
* Testing <code>com.sun.star.frame.XSynchronousFrameLoader</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 of 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>
* <ul> <p>
*
* @see com.sun.star.frame.XSynchronousFrameLoader
*/
public class _XSynchronousFrameLoader extends MultiMethodTest {
public XSynchronousFrameLoader oObj = null; // oObj filled by MultiMethodTest
private String url = null ;
private XFrame frame = null ;
private XComponent frameSup = null ;
private PropertyValue[] descr = null;
/**
* Retrieves all relations. If optional relation
* <code>FrameLoader.Frame</code> not found
* creates a new document and otains its frame for loading. <p>
*
* Also <code>MediaDescriptor</code> is created using
* URL from <code>FrameLoader.URL</code> relation.
*
* @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 (url == null) {
throw new StatusException(Status.failed("Some relations not found")) ;
}
SOfficeFactory SOF = SOfficeFactory.getFactory(
(XMultiServiceFactory)tParam.getMSF() );
XURLTransformer xURLTrans = null;
// if frame is not contained in relations the writer frmame will be used.
if (frame == null) {
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) ;
frame = dsk.getCurrentFrame() ;
Object o = (
(XMultiServiceFactory)tParam.getMSF()).createInstance
("com.sun.star.util.URLTransformer") ;
xURLTrans = (XURLTransformer) UnoRuntime.queryInterface
(XURLTransformer.class, o) ;
} catch ( com.sun.star.uno.Exception e ) {
// Some exception occures.FAILED
e.printStackTrace( log );
throw new StatusException( "Couldn't create a document.", e );
}
}
URL[] urlS = new URL[1];
urlS[0] = new URL();
urlS[0].Complete = url;
boolean res = xURLTrans.parseStrict(urlS);
log.println("Parsing URL '" + url + "': " + res);
descr = new PropertyValue[1] ;
descr[0] = new PropertyValue();
descr[0].Name = "URL" ;
descr[0].Value = urlS[0] ;
}
/**
* Tries to load component to a frame. <p>
* Has <b> OK </b> status if <code>true</code> is returned.
*/
public void _load() {
boolean result = oObj.load(descr, frame) ;
tRes.tested("load()", result) ;
}
/**
* Tries to load component to a frame in separate thread to
* avoid blocking of the current thread and imediately
* cancels loading. <p>
*
* Has <b> OK </b> status if <code>flase</code> is returned,
* i.e. loading was not completed.
*/
public void _cancel() {
requiredMethod("load()") ;
final boolean[] result = new boolean[1] ;
(new Thread() {
public void run() {
result[0] = oObj.load(descr, frame);
}
}).start();
oObj.cancel() ;
try {
Thread.sleep(1000);
} catch (InterruptedException ex) {}
tRes.tested("cancel()", !result[0]) ;
}
/**
* Disposes document if it was created for frame supplying.
*/
protected void after() {
if (frameSup != null) {
frameSup.dispose();
}
}
}