bean/com/sun/star/comp/beans/OfficeConnection.java

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