xref: /AOO41X/main/bean/com/sun/star/comp/beans/OfficeConnection.java (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir package com.sun.star.comp.beans;
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir import java.awt.Container;
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir import com.sun.star.lang.XComponent;
33*cdf0e10cSrcweir import com.sun.star.uno.XComponentContext;
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir /**
36*cdf0e10cSrcweir  * This abstract class reprecents a connection to the office
37*cdf0e10cSrcweir  * application.
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir     @deprecated
40*cdf0e10cSrcweir  */
41*cdf0e10cSrcweir public interface OfficeConnection
42*cdf0e10cSrcweir 	extends XComponent
43*cdf0e10cSrcweir {
44*cdf0e10cSrcweir 	/**
45*cdf0e10cSrcweir 	 * Sets a connection URL.
46*cdf0e10cSrcweir 	 *
47*cdf0e10cSrcweir 	 * @param url This is UNO URL which describes the type of a connection.
48*cdf0e10cSrcweir 	 */
49*cdf0e10cSrcweir 	void setUnoUrl(String url)
50*cdf0e10cSrcweir 		throws java.net.MalformedURLException;
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir 	/**
53*cdf0e10cSrcweir 	 * Sets an AWT container catory.
54*cdf0e10cSrcweir 	 *
55*cdf0e10cSrcweir 	 * @param containerFactory This is a application provided AWT container
56*cdf0e10cSrcweir 	 *	factory.
57*cdf0e10cSrcweir 	 */
58*cdf0e10cSrcweir 	void setContainerFactory(ContainerFactory containerFactory);
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir 	/**
61*cdf0e10cSrcweir 	 * Retrives the UNO component context.
62*cdf0e10cSrcweir 	 * Establishes a connection if necessary and initialises the
63*cdf0e10cSrcweir 	 * UNO service manager if it has not already been initialised.
64*cdf0e10cSrcweir 	 *
65*cdf0e10cSrcweir 	 * @return The office UNO component context.
66*cdf0e10cSrcweir 	 */
67*cdf0e10cSrcweir 	XComponentContext getComponentContext();
68*cdf0e10cSrcweir 
69*cdf0e10cSrcweir 	/**
70*cdf0e10cSrcweir 	 * Creates an office window.
71*cdf0e10cSrcweir 	 * The window is either a sub-class of java.awt.Canvas (local) or
72*cdf0e10cSrcweir 	 * java.awt.Container (RVP).
73*cdf0e10cSrcweir 	 *
74*cdf0e10cSrcweir 	 * This method does not add add the office window to its container.
75*cdf0e10cSrcweir 	 *
76*cdf0e10cSrcweir 	 * @param container This is an AWT container.
77*cdf0e10cSrcweir 	 * @return The office window instance.
78*cdf0e10cSrcweir 	 */
79*cdf0e10cSrcweir 	OfficeWindow createOfficeWindow(Container container);
80*cdf0e10cSrcweir }
81