odk/examples/DevelopersGuide/Forms/DocumentBasedExample.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: DocumentBasedExample.java,v $
  10  * $Revision: 1.4 $
  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 package org.openoffice.sdk.forms;
  31
  32 import com.sun.star.bridge.XUnoUrlResolver;
  33 import com.sun.star.lang.XMultiComponentFactory;
  34 import com.sun.star.uno.UnoRuntime;
  35 import com.sun.star.uno.XComponentContext;
  36 import com.sun.star.util.XCloseable;
  37
  38 public abstract class DocumentBasedExample implements com.sun.star.lang.XEventListener
  39 {
  40     /// the intial remote context from the office
  41     protected XComponentContext       m_xCtx;
  42     /// our current test document
  43     protected DocumentHelper          m_document;
  44     protected FormLayer               m_formLayer;
  45     protected DocumentType            m_documentType;
  46
  47     /** Creates a new instance of DocumentBasedExample */
  48     public DocumentBasedExample( DocumentType documentType )
  49     {
  50         bootstrapUNO();
  51         m_documentType = documentType;
  52     }
  53
  54     /* ------------------------------------------------------------------ */
  55     private void bootstrapUNO()
  56     {
  57         try
  58         {
  59             /*
  60             final XComponentContext componentContext = com.sun.star.comp.helper.Bootstrap.
  61                 createInitialComponentContext( null );
  62             final XMultiComponentFactory localServiceManager = componentContext.getServiceManager();
  63
  64             final XUnoUrlResolver urlResolver = (XUnoUrlResolver) UnoRuntime.queryInterface(
  65                 XUnoUrlResolver.class, localServiceManager.createInstanceWithContext(
  66                     "com.sun.star.bridge.UnoUrlResolver", componentContext) );
  67
  68             final String connectStr = "uno:pipe,name=<pipename>;urp;StarOffice.ComponentContext";
  69             final Object initialObject = urlResolver.resolve( connectStr );
  70
  71             m_xCtx = (XComponentContext)UnoRuntime.queryInterface( XComponentContext.class,
  72                 initialObject );
  73             */
  74
  75             // get the remote office component context
  76             m_xCtx = com.sun.star.comp.helper.Bootstrap.bootstrap();
  77             System.out.println("Connected to a running office ...");
  78         }
  79         catch (java.lang.Exception e)
  80         {
  81             e.printStackTrace( System.err );
  82             System.exit(1);
  83         }
  84     }
  85
  86     /* ------------------------------------------------------------------ */
  87     /** main method for running the sample
  88      */
  89     public void run( String argv[] )
  90     {
  91         try
  92         {
  93             // collect whatever parameters were given
  94             collectParameters( argv );
  95
  96             // prepare our sample document
  97             prepareDocument();
  98
  99             // switch the document view's form layer to alive mode
 100             m_document.getCurrentView().toggleFormDesignMode();
 101             onFormsAlive();
 102
 103             // grab the focus to the first control
 104             m_document.getCurrentView().grabControlFocus();
 105
 106             // ----------------------------------------------
 107             // wait for the user to confirm that we can exit
 108             if ( waitForUserInput() )
 109             {
 110                 // clean up
 111                 cleanUp();
 112             }
 113
 114             // if waitForUserInput returns false, the user closed the document manually - no need to do a clean up
 115             // then
 116         }
 117         catch(com.sun.star.uno.Exception e)
 118         {
 119             System.out.println(e);
 120             e.printStackTrace();
 121         }
 122         catch(java.lang.Exception e)
 123         {
 124             System.out.println(e);
 125             e.printStackTrace();
 126         }
 127
 128         System.exit(0);
 129     }
 130
 131     /* ------------------------------------------------------------------ */
 132     /** collect the RuntimeArguments
 133     */
 134     protected void collectParameters(String argv[])
 135     {
 136         // not interested in. Derived classes may want to use it.
 137     }
 138
 139     /* ------------------------------------------------------------------ */
 140     /** prepares a new document to work with
 141      */
 142     protected void prepareDocument() throws com.sun.star.uno.Exception, java.lang.Exception
 143     {
 144         m_document = DocumentHelper.blankDocument(m_xCtx, m_documentType);
 145         m_document.getDocument( ).addEventListener( this );
 146         m_formLayer = new FormLayer( m_document );
 147     }
 148
 149     /* ------------------------------------------------------------------ */
 150     /** called when the form layer has been switched to alive mode
 151     */
 152     protected void onFormsAlive()
 153     {
 154     }
 155
 156     /* ------------------------------------------------------------------ */
 157     /** performs any cleanup before exiting the program
 158     */
 159     protected void cleanUp( ) throws java.lang.Exception
 160     {
 161         // do not listen at the document any longer
 162         m_document.getDocument().removeEventListener( this );
 163
 164         // close the document
 165         closeDocument();
 166     }
 167
 168     /* ------------------------------------------------------------------ */
 169     /** closes our document, if we have an open one
 170      */
 171     private void closeDocument()
 172     {
 173         try
 174         {
 175             // close our document
 176             if ( m_document != null )
 177             {
 178                 XCloseable closeDoc = (XCloseable)
 179                     UnoRuntime.queryInterface( XCloseable.class,
 180                                                m_document.getDocument() );
 181                 if (closeDoc != null)
 182                     closeDoc.close( true );
 183                 else
 184                     m_document.getDocument().dispose();
 185             }
 186         }
 187         catch ( com.sun.star.uno.Exception e )
 188         {
 189             e.printStackTrace( System.out );
 190         }
 191     }
 192
 193     /* ------------------------------------------------------------------ */
 194     /* internal methods                                                   */
 195     /* ------------------------------------------------------------------ */
 196     /** waits for the user to press a key (on the console where she started
 197         the java program) or the document to be closed by the user.
 198
 199         @return <TRUE/> if the user pressed a key on the console,
 200                 <FALSE/> if she closed the document
 201     */
 202     protected boolean waitForUserInput() throws java.lang.Exception
 203     {
 204         synchronized (this)
 205         {
 206             WaitForInput aWait = new WaitForInput( this );
 207             aWait.start();
 208             wait();
 209
 210             // if the waiter thread is done, the user pressed enter
 211             boolean bKeyPressed = aWait.isDone();
 212             if ( !bKeyPressed )
 213                 aWait.interrupt();
 214
 215             return bKeyPressed;
 216         }
 217     }
 218
 219     /* ------------------------------------------------------------------ */
 220     /* XEventListener overridables                                        */
 221     /* ------------------------------------------------------------------ */
 222     public void disposing( com.sun.star.lang.EventObject eventObject )
 223     {
 224         if ( m_document.getDocument().equals( eventObject.Source ) )
 225     {
 226             // notify ourself that we can stop waiting for user input
 227             synchronized (this)
 228             {
 229                 notify();
 230             }
 231         }
 232     }
 233 }