odk/examples/DevelopersGuide/Forms/DocumentBasedExample.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 import com.sun.star.uno.UnoRuntime;
  19 import com.sun.star.uno.XComponentContext;
  20 import com.sun.star.util.XCloseable;
  21
  22 public abstract class DocumentBasedExample implements com.sun.star.lang.XEventListener
  23 {
  24     /// the initial remote context from the office
  25     protected XComponentContext       m_xCtx;
  26     /// our current test document
  27     protected DocumentHelper          m_document;
  28     protected FormLayer               m_formLayer;
  29     private DocumentType            m_documentType;
  30
  31     /** Creates a new instance of DocumentBasedExample */
  32     public DocumentBasedExample( DocumentType documentType )
  33     {
  34         bootstrapUNO();
  35         m_documentType = documentType;
  36     }
  37
  38     /* ------------------------------------------------------------------ */
  39     private void bootstrapUNO()
  40     {
  41         try
  42         {
  43             /*
  44             final XComponentContext componentContext = com.sun.star.comp.helper.Bootstrap.
  45                 createInitialComponentContext( null );
  46             final XMultiComponentFactory localServiceManager = componentContext.getServiceManager();
  47
  48             final XUnoUrlResolver urlResolver = (XUnoUrlResolver) UnoRuntime.queryInterface(
  49                 XUnoUrlResolver.class, localServiceManager.createInstanceWithContext(
  50                     "com.sun.star.bridge.UnoUrlResolver", componentContext) );
  51
  52             final String connectStr = "uno:pipe,name=<pipename>;urp;StarOffice.ComponentContext";
  53             final Object initialObject = urlResolver.resolve( connectStr );
  54
  55             m_xCtx = (XComponentContext)UnoRuntime.queryInterface( XComponentContext.class,
  56                 initialObject );
  57             */
  58
  59             // get the remote office component context
  60             m_xCtx = com.sun.star.comp.helper.Bootstrap.bootstrap();
  61             System.out.println("Connected to a running office ...");
  62         }
  63         catch (java.lang.Exception e)
  64         {
  65             e.printStackTrace( System.err );
  66             System.exit(1);
  67         }
  68     }
  69
  70     /* ------------------------------------------------------------------ */
  71     /** main method for running the sample
  72      */
  73     public void run( String argv[] )
  74     {
  75         try
  76         {
  77             // collect whatever parameters were given
  78             collectParameters( argv );
  79
  80             // prepare our sample document
  81             prepareDocument();
  82
  83             // switch the document view's form layer to alive mode
  84             m_document.getCurrentView().toggleFormDesignMode();
  85             onFormsAlive();
  86
  87             // grab the focus to the first control
  88             m_document.getCurrentView().grabControlFocus();
  89
  90
  91             // wait for the user to confirm that we can exit
  92             if ( waitForUserInput() )
  93             {
  94                 // clean up
  95                 cleanUp();
  96             }
  97
  98             // if waitForUserInput returns false, the user closed the document manually - no need to do a clean up
  99             // then
 100         }
 101         catch(com.sun.star.uno.Exception e)
 102         {
 103             System.out.println(e);
 104             e.printStackTrace();
 105         }
 106         catch(java.lang.Exception e)
 107         {
 108             System.out.println(e);
 109             e.printStackTrace();
 110         }
 111
 112         System.exit(0);
 113     }
 114
 115     /* ------------------------------------------------------------------ */
 116     /** collect the RuntimeArguments
 117     */
 118     private void collectParameters(String argv[])
 119     {
 120         // not interested in. Derived classes may want to use it.
 121     }
 122
 123     /* ------------------------------------------------------------------ */
 124     /** prepares a new document to work with
 125      */
 126     protected void prepareDocument() throws com.sun.star.uno.Exception, java.lang.Exception
 127     {
 128         m_document = DocumentHelper.blankDocument(m_xCtx, m_documentType);
 129         m_document.getDocument( ).addEventListener( this );
 130         m_formLayer = new FormLayer( m_document );
 131     }
 132
 133     /* ------------------------------------------------------------------ */
 134     /** called when the form layer has been switched to alive mode
 135     */
 136     protected void onFormsAlive()
 137     {
 138     }
 139
 140     /* ------------------------------------------------------------------ */
 141     /** performs any cleanup before exiting the program
 142     */
 143     protected void cleanUp( ) throws java.lang.Exception
 144     {
 145         // do not listen at the document any longer
 146         m_document.getDocument().removeEventListener( this );
 147
 148         // close the document
 149         closeDocument();
 150     }
 151
 152     /* ------------------------------------------------------------------ */
 153     /** closes our document, if we have an open one
 154      */
 155     private void closeDocument()
 156     {
 157         try
 158         {
 159             // close our document
 160             if ( m_document != null )
 161             {
 162                 XCloseable closeDoc = UnoRuntime.queryInterface( XCloseable.class,
 163                                            m_document.getDocument() );
 164                 if (closeDoc != null)
 165                     closeDoc.close( true );
 166                 else
 167                     m_document.getDocument().dispose();
 168             }
 169         }
 170         catch ( com.sun.star.uno.Exception e )
 171         {
 172             e.printStackTrace( System.err );
 173         }
 174     }
 175
 176     /* ------------------------------------------------------------------ */
 177     /* internal methods                                                   */
 178     /* ------------------------------------------------------------------ */
 179     /** waits for the user to press a key (on the console where she started
 180         the java program) or the document to be closed by the user.
 181
 182         @return <TRUE/> if the user pressed a key on the console,
 183                 <FALSE/> if she closed the document
 184     */
 185     protected boolean waitForUserInput() throws java.lang.Exception
 186     {
 187         synchronized (this)
 188         {
 189             WaitForInput aWait = new WaitForInput( this );
 190             aWait.start();
 191             wait();
 192
 193             // if the waiter thread is done, the user pressed enter
 194             boolean bKeyPressed = aWait.isDone();
 195             if ( !bKeyPressed )
 196                 aWait.interrupt();
 197
 198             return bKeyPressed;
 199         }
 200     }
 201
 202     /* ------------------------------------------------------------------ */
 203     /* XEventListener overridables                                        */
 204     /* ------------------------------------------------------------------ */
 205     public void disposing( com.sun.star.lang.EventObject eventObject )
 206     {
 207         if ( m_document.getDocument().equals( eventObject.Source ) )
 208     {
 209             // notify ourself that we can stop waiting for user input
 210             synchronized (this)
 211             {
 212                 notify();
 213             }
 214         }
 215     }
 216 }