OfficeConnection Interface

From Apache OpenOffice Wiki
Jump to: navigation, search

The interface contains the methods used to configure, initiate,and manage the connection to Apache OpenOffice. These methods are:

  public void setUnoUrl(String URL) throws
  public getComponentContext()
  public OfficeWindow createOfficeWindow(Container container)
  public void setContainerFactory(ContainerFactory containerFactory)

The client uses setUnoUrl() to specify to the Office Bean how it connects to the Apache OpenOffice process. See the section Configuring the Office Bean for a description of the syntax of the URL. A is thrown by the concrete implementation if the client passes a badly formed URL as an argument.

The method getComponentContext() gets an object that implements the interface from the Office Bean. This object is then used to obtain objects implementing the full Apache OpenOffice API from the backend Apache OpenOffice process.

A call to createOfficeWindow() requests a new OfficeWindow from the OfficeConnection. The client obtains the java.awt.Component from the OfficeWindow to plug into its UI. See the getAWTComponent() method below on how to obtain the Component from the OfficeWindow. The client provides java.awt.Container that indicates to the implementation what kind of OfficeWindow it is to create.

The method setContainerFactory() specifies to the Office Bean the factory object it uses to create Java AWT windows to display popup windows in the Java environment. This factory object implements the interface. See below for a definition of the ContainerFactory interface.

If the client does not implement its own ContainerFactory interface, the Office Bean uses its own default ContainerFactory creating instances of java.awt.Canvas.

Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages