File: OOoBean.java

package info (click to toggle)
libreoffice 1:6.1.5-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 2,699,584 kB
  • sloc: cpp: 4,078,558; xml: 324,485; java: 281,935; python: 48,236; ansic: 36,476; perl: 32,383; sh: 13,671; yacc: 10,820; makefile: 9,085; cs: 6,600; lex: 2,184; objc: 1,904; awk: 978; pascal: 949; asm: 866; php: 79; csh: 20; sed: 5
file content (1489 lines) | stat: -rw-r--r-- 54,141 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

package com.sun.star.comp.beans;

import com.sun.star.uno.UnoRuntime;

// @requirement FUNC.PERF.LRN/0.6
// @requirement FUNC.PERF.LOC/0.6
// @requirement FUNC.PERF.FIX/0.6
// @requirement FUNC.RES.OTH/0.2
// No other resources are needed yet.
/** This is the basic JavaBean for all OOo application modules.
    @since OOo 2.0.0
 */
public class OOoBean

    // @requirement FUNC.BEAN.VIEW/0.4
    extends java.awt.Container

    implements
        // @requirement FUNC.PER/0.2
        java.io.Externalizable
{
    // timeout values (milli secs)
    private int nOOoStartTimeOut = 60000;
    private int nOOoCallTimeOut =   3000;
    private int nOOoCheckCycle =    1000;

    // This member contains the connection to an OOo instance if established.
    private transient OfficeConnection      iConnection;
    private transient EventListener         xConnectionListener;

    // @requirement FUNC.BEAN.VIEW/0.4
    // @requirement FUNC.BEAN.EDIT/0.4
    // This member contains the OOo window if a connection is established.
    // It is a child of the OOoBean canvas.
    private OfficeWindow xFrameWindow;

    // application environment
    private transient com.sun.star.lang.XMultiServiceFactory xServiceFactory;
    private transient com.sun.star.frame.XDesktop xDesktop;

    // document and frame
    private transient Frame aFrame;
    private transient Controller aController;
    private transient OfficeDocument aDocument;

    // slot command execution environment
    private transient com.sun.star.util.XURLTransformer xURLTransformer;

    // properties
    private boolean bIgnoreVisibility = false; // to show even if already visible
    private boolean bMenuBarVisible = true;
    private boolean bStandardBarVisible = true;
    private boolean bToolBarVisible = true;
    private boolean bStatusBarVisible = true;


    // debugging method
    private void dbgPrint( String aMessage )
    {
    }

    // @requirement FUNC.PER/0.2
    // @internal
    /**
     */
    @Deprecated
    public void writeExternal( java.io.ObjectOutput aObjOut )
    {
        // TBD
    }

    // @requirement FUNC.PER/0.2
    // @internal
    /**
     */
    @Deprecated
    public void readExternal( java.io.ObjectInput aObjIn )
    {
        // TBD
    }

    /** Generic constructor of the OOoBean.

        Neither a connection is established nor any document loaded.
     */
    public OOoBean()
    {
        setLayout(new java.awt.BorderLayout());
    }

       // @requirement FUNC.CON.MULT/0.3
    /** Constructor for an OOoBean which uses a specific office connection.

        The connection must be established but no document is loaded.

        @throws NoConnectionException
            if the connection is not established.

        @deprecated Clients could use the getOOoConnection to obtain an OfficeConnection
        and use it as argument in a constructor for another OOoBean instance. Calling
        the dispose method of the OfficeConnection or the OOoBean's stopOOoConnection
        method would make all instances of OOoBean stop working.
     */
    public OOoBean( OfficeConnection iConnection )
        throws NoConnectionException
    {
        setLayout(new java.awt.BorderLayout());
        try { setOOoConnection( iConnection ); }
        catch ( HasConnectionException aExc )
        { /* impossible here */ }
    }

    /** Sets the timeout for methods which launch OOo in milli seconds.

        This method does not need a connection to an OOo instance.
     */
    public void setOOoStartTimeOut( int nMilliSecs )
    {
        nOOoStartTimeOut = nMilliSecs;
    }

    /** Sets the timeout for normal OOO methods calls in milli seconds.

        This method does not need a connection to an OOo instance.
     */
    public void setOOoCallTimeOut( int nMilliSecs )
    {
        nOOoCallTimeOut = nMilliSecs;
    }

    /** Sets the period length in milliseconds to check the OOo connection.

        This method does not need a connection to an OOo instance.
     */
    public void setOOoCheckCycle( int nMilliSecs )
    {
        nOOoCheckCycle = nMilliSecs;
    }

    // @internal
    /** Sets a connection to an OOo instance.
     */
    private synchronized void setOOoConnection(OfficeConnection iNewConnection)
            throws HasConnectionException, NoConnectionException {
        // the connection cannot be exchanged
        if (iConnection != null)
            throw new HasConnectionException();

        // is there a real connection, not just the proxy?
        com.sun.star.uno.XComponentContext xComponentContext = null;
        try {
            xComponentContext = iNewConnection.getComponentContext();
        } catch (java.lang.Throwable aExc) {
            throw new NoConnectionException(aExc);
        }
        if (xComponentContext == null)
            throw new NoConnectionException();

        // set the connection
        iConnection = iNewConnection;

        // get notified when connection dies
        if (xConnectionListener != null)
            xConnectionListener.end();
        xConnectionListener = this.new EventListener("setOOoConnection");
    }

    // @requirement FUNC.CON.STRT/0.4
    /** Starts a connection to an OOo instance which is launched if not running.

        @throws HasConnectionException
            if a connection was already established.

        @throws NoConnectionException
            if the specified connection cannot be established
     */
    public void startOOoConnection( String aConnectionURL )
        throws  java.net.MalformedURLException,
            HasConnectionException,
            NoConnectionException
    {
        // create a new connection from the given connection URL
        LocalOfficeConnection aConnection = new LocalOfficeConnection();
        aConnection.setUnoUrl( aConnectionURL );
        setOOoConnection( aConnection );
    }

    // @requirement FUNC.CON.CHK/0.7
    /** Returns true if this OOoBean is connected to an OOo instance,
        false otherwise.

        @deprecated This method is not useful in a multithreaded environment. Then
        all threads accessing the instance would have to be synchronized in order to
        make is method work. It is better to call OOoBean's methods and be prepared
        to catch a NoConnectionException.
     */
    public boolean isOOoConnected()
    {
        return iConnection != null;
    }

    // @requirement FUNC.CON.STOP/0.4
    /** Disconnects from the connected OOo instance.

        If there was no connection yet or anymore, this method can be called
        anyway.

        When the OOoBean is displayed in an applet by a web browser, then this
        method must be called from within java.applet.Applet.stop.
     */
    public synchronized void stopOOoConnection()
    {
        // clear OOo document, frame etc.
        clear();

        // cut the connection
        OfficeConnection iExConnection = iConnection;
        if ( iConnection != null )
        {
            if ( xConnectionListener != null )
            {
                xConnectionListener.end();
            }
            iConnection = null;
            iExConnection.dispose();
        }

    }

    // @requirement FUNC.CON.STOP/0.4 (via XComponent.dispose())
       // @requirement FUNC.CON.NTFY/0.4 (via XComponent.addEventListener())
    /** Returns a connection to an OOo instance.

        If no connection exists, a default connection will be created. An OfficeConnection
        can be used to register listeners of type com.sun.star.lang.EventListener,
        which are notified when the connection to the office dies. One should not call the
        dispose method, because this may result in receiving com.sun.star.lang.DisposedExceptions
        when calling {@link #stopOOoConnection stopOOoConnection} or other API methods. If other
        instances share the same connection then they will stop function properly, because
        they lose their connection as well. The recommended way to end the connection is by
        calling {@link #stopOOoConnection stopOOoConnection}.

        @throws NoConnectionException
            if no connection can be established

     */
    public synchronized OfficeConnection getOOoConnection()
        throws NoConnectionException
    {
        if ( iConnection == null )
        {
            try { setOOoConnection( new LocalOfficeConnection() ); }
            catch ( HasConnectionException aExc )
            { /* impossible here */ }
        }
        if ( iConnection.getComponentContext() == null )
            throw new NoConnectionException();
        return iConnection;
    }

    /** Returns the service factory used by this OOoBean instance.

        @throws NoConnectionException
            if no connection is established and no default connection can be established.
     */
    public synchronized com.sun.star.lang.XMultiServiceFactory getMultiServiceFactory()
        throws NoConnectionException
    {
        if ( xServiceFactory == null )
        {
            // avoid concurrent access from multiple threads
            final OfficeConnection iConn = getOOoConnection();

            Thread aConnectorThread = new Thread("getServiceManager") {
                @Override
                public void run()
                {
                    com.sun.star.lang.XMultiComponentFactory aFactory =
                        iConn.getComponentContext().getServiceManager();
                    xServiceFactory = UnoRuntime.queryInterface(
                        com.sun.star.lang.XMultiServiceFactory.class, aFactory );
                }
            };
            aConnectorThread.start();
            try { aConnectorThread.join(nOOoStartTimeOut); }
            catch ( InterruptedException aExc )
            { throw new NoConnectionException(aExc); }
            if ( xServiceFactory == null )
                throw new NoConnectionException();
        }

        return xServiceFactory;
    }

    /** Returns the XDesktop interface of the OOo instance used by this OOoBean.

        @throws NoConnectionException
            if no connection is established and no default connection can be established.
     */
    public synchronized com.sun.star.frame.XDesktop getOOoDesktop()
        throws NoConnectionException
    {
        if ( xDesktop == null )
        {
            try
            {
                Object aObject = getMultiServiceFactory().createInstance( "com.sun.star.frame.Desktop");
                xDesktop = UnoRuntime.queryInterface(
                        com.sun.star.frame.XDesktop.class, aObject );
            }
            catch ( com.sun.star.uno.Exception aExc )
            {} // TBD: what if no connection exists?
        }

        return xDesktop;
    }

    /** Resets this bean to an empty document.

       If a document is loaded and the content modified,
       the changes are dismissed.  Otherwise nothing happens.

       This method is intended to be overridden in derived classes.
       This implementation simply calls clear.

       @param bClearStateToo
           Not only the document content but also the state of the bean,
        like visibility of child components is cleared.

        @deprecated There is currently no way to dismiss changes, except for loading
        of the unchanged initial document. Furthermore it is unclear how derived classes
        handle this and what exactly their state is (e.g. what members make up their state).
        Calling this method on a derived class requires knowledge about their implementation.
        Therefore a deriving class should declare their own clearDocument if needed. Clients
        should call the clearDocument of the deriving class or {@link #clear} which discards
        the currently displayed document.
     */
    public synchronized void clearDocument( boolean bClearStateToo )
    {
        // TBD
        clear();
    }

    /** Resets the OOoBean to an empty status.

        Any loaded document is unloaded, no matter whether it is modified or not.
        After calling this method, the OOoBean has no office document and no frame
        anymore.  The connection will stay, though.

        This method works with or without an established connection.
     */
    public synchronized void clear()
    {
        dbgPrint( "clear()" );

        try
        {
            CallWatchThread aCallWatchThread =
                new CallWatchThread( nOOoCallTimeOut, "clear" );
            // By closing the frame we avoid that dialogs are displayed, for example when
            // the document is modified.
            com.sun.star.util.XCloseable xCloseable = UnoRuntime.queryInterface( com.sun.star.util.XCloseable.class, aFrame );
            if ( xCloseable != null )
            {
                try
                {
                    xCloseable.close(true);
                }
                catch (com.sun.star.util.CloseVetoException exc)
                { // a print job may be running
                }
            }

            aDocument = null;
            aFrame = null;

            // clear xFrameWindow
            if ( xFrameWindow != null )
            {
                try { releaseSystemWindow(); }
                catch ( NoConnectionException aExc )
                {} // ignore
                catch ( SystemWindowException aExc )
                {} // ignore
                remove( xFrameWindow.getAWTComponent() );
                xFrameWindow = null;
            }

            // clear xURTTransformer
            if ( xURLTransformer != null )
            {
                try
                {
                    com.sun.star.lang.XComponent xComp = UnoRuntime.queryInterface(
                        com.sun.star.lang.XComponent.class, xURLTransformer );
                    if ( xComp != null )
                        xComp.dispose();
                }
                catch ( java.lang.Throwable aExc )
                {} // ignore
                xURLTransformer = null;
            }

            xDesktop = null;
            xServiceFactory = null;

            aCallWatchThread.cancel();
        }
        catch ( InterruptedException aExc )
        { /* can be ignored */ }
    }

    // @requirement FUNC.PAR.LWP/0.4
    /** This method causes the office window to be displayed.

        If no document is loaded and the instance is added to a Java container that
        is showing, then this method needs not to be called. If later one of the methods
        {@link #loadFromURL loadFromURL}, {@link #loadFromStream loadFromStream1},
        or {@link #loadFromByteArray loadFromByteArray}
        is called, then the document is automatically displayed.

        Should one of the load methods have been called before the Java container
        was showing, then this method needs to be called after the container window
        was made visible (java.lang.Component.setVisible(true)).
        <p>
        Another scenario is that a OOoBean contains a document and is removed
        from a Java container and later added again. Then aquireSystemWindow needs
        to be called after the container window is displayed.
        <p>

        @throws SystemWindowException
            if no system window can be acquired.

        @throws NoConnectionException
            if the connection is not established.
     */
    public synchronized void aquireSystemWindow()
        throws
            SystemWindowException,

            // @requirement FUNC.CON.LOST/0.2
            NoConnectionException
    {
        if ( iConnection == null )
            throw new NoConnectionException();
        if ( !isShowing() )
            throw new SystemWindowException();

        if ( xFrameWindow != null )
            xFrameWindow.getAWTComponent().setVisible(true);
        doLayout();
    }

    // @requirement FUNC.PAR.RWL/0.4
    // @estimation 16h
    /** This method must be called when the OOoBean before the
        system window may be released by its parent AWT/Swing component.

        This is the case when java.awt.Component.isDisplayable() returns
        true.  This is definitely the case when the OOoBean is removed
        from its parent container.

        @throws SystemWindowException
            if system window is not acquired.

        @throws NoConnectionException
            if the connection is not established.

        @deprecated When Component.removeNotify of the parent window of the actual
        office window is called, then the actions are performed for which this method
        needed to be called previously.
     */
    public synchronized void releaseSystemWindow()
        throws
            SystemWindowException,

            // @requirement FUNC.CON.LOST/0.2
            NoConnectionException
 {
        if (iConnection == null)
            throw new NoConnectionException();

        try {
            xFrameWindow.getAWTComponent().setVisible(false);
        } catch (com.sun.star.lang.DisposedException aExc) {
            throw new NoConnectionException(aExc);
        }
    }

       // @requirement FUNC.BEAN.LOAD/0.4
       // @requirement FUNC.CON.AUTO/0.3
    /** Loads the bean from the given URL.

        If a document is already loaded and the content modified,
        the changes are dismissed.

        If no connection exists, a default connection is established.

        @throws IllegalArgumentException
            if either of the arguments is out of the specified range.

        @throws java.io.IOException
            if an IO error occurs reading the resource specified by the URL.

        @throws com.sun.star.comp.beans.NoConnectionException
            if no connection can be established.

        @throws com.sun.star.util.CloseVetoException
            if the currently displayed document cannot be closed because it is
            still be used, for example it is printed.
     */
    public void loadFromURL(
            final String aURL,
            final com.sun.star.beans.PropertyValue aArguments[] )
        throws
            // @requirement FUNC.CON.LOST/0.2
            NoConnectionException,
            java.io.IOException,
            com.sun.star.lang.IllegalArgumentException,
            com.sun.star.util.CloseVetoException
    {
        dbgPrint( "loadFromURL()" );
         // try loading
        try
        {
            boolean bLoaded = false;
            while ( !bLoaded )
            {
                // watch loading in a thread with a timeout (if OOo hangs)
                CallWatchThread aCallWatchThread =
                    new CallWatchThread( nOOoStartTimeOut, "loadFromURL" );

                try
                {
                    // get window from OOo on demand
                    if ( xFrameWindow == null )
                    {
                        // Establish the connection by request of the ServiceFactory.
                        getMultiServiceFactory();

                        // remove existing child windows
                        removeAll();

                        // Create the OfficeWindow.
                        xFrameWindow = getOOoConnection().createOfficeWindow(OOoBean.this);
                        add( xFrameWindow.getAWTComponent() );
                    }

                    // create the document frame from UNO window.
                    if ( aFrame == null )
                    {
                        // create the frame
                        com.sun.star.awt.XWindow xWindow =
                            UnoRuntime.queryInterface(
                        com.sun.star.awt.XWindow.class, xFrameWindow.getUNOWindowPeer());
                        Object xFrame = xServiceFactory.createInstance( "com.sun.star.frame.Frame");
                        aFrame = new Frame( UnoRuntime.queryInterface(
                                com.sun.star.frame.XFrame.class, xFrame ) );
                        aFrame.initialize( xWindow );
                        aFrame.setName( aFrame.toString() );

                        // register the frame at the desktop
                        com.sun.star.frame.XFrames xFrames =
                                UnoRuntime.queryInterface(
                                com.sun.star.frame.XFramesSupplier.class, getOOoDesktop() ).getFrames();
                        xFrames.append( aFrame );
                    }

                    // Initializes the slot command execution environment.
                    xURLTransformer = UnoRuntime.queryInterface(
                        com.sun.star.util.XURLTransformer.class,
                        xServiceFactory.createInstance( "com.sun.star.util.URLTransformer") );

                    try
                    {
                        UnoRuntime.queryInterface(com.sun.star.frame.XDispatchProvider.class, aFrame);
                    }
                    catch (Exception e)
                    {
                        /*ignore!*/
                    }

                    // get XComponentLoader from frame
                    com.sun.star.frame.XComponentLoader xLoader = UnoRuntime.queryInterface( com.sun.star.frame.XComponentLoader.class, aFrame );
                    if ( xLoader == null )
                    {
                        throw new java.lang.RuntimeException(
                            "com.sun.star.frame.Frame(" + aFrame +
                                ") without com.sun.star.frame.XComponentLoader" );
                    }

                    // Avoid dialog 'Document changed' while reloading
                    if ( aDocument != null )
                    {
                        try {
                            aDocument.setModified(false);
                        } catch (com.sun.star.beans.PropertyVetoException ep) {
                            // it doesn't make sense to throw the exception here. The interface does not
                            // offer a way to add/remove respective listeners.
                        } catch (com.sun.star.lang.DisposedException ed) {
                            // can be disposed if user closed document via UI
                        }

                        com.sun.star.frame.XController xOldController = null;
                        if ( aFrame != null )
                            xOldController = aFrame.getController();

                        try
                        {

                            if ( aFrame != null && xOldController != null )
                                if (!xOldController.suspend(true))
                                    throw new com.sun.star.util.CloseVetoException(
                                            "Document is still being used and cannot be closed.", this);

                        }
                        catch (java.lang.IllegalStateException exp)
                        {}
                    }

                    // load the document.
                    com.sun.star.beans.PropertyValue aArgs[] =
                        addArgument( aArguments, new com.sun.star.beans.PropertyValue(
                            "MacroExecutionMode", -1,
                            Short.valueOf( com.sun.star.document.MacroExecMode.USE_CONFIG ),
                            com.sun.star.beans.PropertyState.DIRECT_VALUE ) );

                    com.sun.star.lang.XComponent xComponent = xLoader.loadComponentFromURL(
                        aURL, "_self", 0, aArgs );

                    // nothing loaded?
                    if ( xComponent == null && aDocument != null )
                    {
                        // reactivate old document
                        if ( aFrame != null && aFrame.getController() != null )
                            aFrame.getController().suspend(false);
                        aDocument.setModified(true);

                        // throw exception
                        throw new java.io.IOException(
                            "Can not load a document: \"" + aURL + "\"");
                    }

                    // Get document's XModifiable interface if any.
                    aDocument = new OfficeDocument(
                        UnoRuntime.queryInterface(
                        com.sun.star.frame.XModel.class, xComponent ) );
                    bLoaded = true;
                }
                catch ( NoConnectionException aExc )
                {
                    // stop, clear and retry
                    stopOOoConnection();
                }
                catch ( com.sun.star.lang.DisposedException aExc )
                {
                    // stop, clear and retry
                    stopOOoConnection();
                }
                catch ( com.sun.star.uno.Exception aExc )
                {
                    // TDB: handling failure in createInstance
                    java.io.IOException ex2 = new java.io.IOException();
                    ex2.initCause(aExc);
                    throw ex2;
                }

                aCallWatchThread.cancel();
                if ( xServiceFactory == null )
                    throw new NoConnectionException();
            }
            if ( iConnection == null )
            {
                throw new NoConnectionException();
            }

            applyToolVisibilities();
        }
        catch ( InterruptedException aExc )
        {
            throw new NoConnectionException(aExc);
        }
    }

    /** Loads a document from a Java stream.

           See loadFromURL() for further information.
     */
    public void loadFromStream(
            final java.io.InputStream iInStream,
            final com.sun.star.beans.PropertyValue aArguments[] )
        throws
            // @requirement FUNC.CON.LOST/0.2
            NoConnectionException,
            java.io.IOException,
            com.sun.star.lang.IllegalArgumentException,
            com.sun.star.util.CloseVetoException
    {
        // wrap Java stream into UNO stream

                 // copy stream....
                 int s = 4096;
                 int r=0 ,n = 0;
                 byte[] buffer = new byte[s];
                 byte[] newBuffer = null;
                 while ((r = iInStream.read(buffer, n, buffer.length-n))>0) {
                     n += r;
                     if (iInStream.available() > buffer.length - n) {
                         newBuffer = new byte[buffer.length*2];
                         System.arraycopy(buffer, 0, newBuffer, 0, n);
                         buffer = newBuffer;
                     }
                }
                if (buffer.length != n) {
                    newBuffer = new byte[n];
                    System.arraycopy(buffer, 0, newBuffer, 0, n);
                    buffer = newBuffer;
                }
                com.sun.star.io.XInputStream xStream =
                    new com.sun.star.lib.uno.adapter.ByteArrayToXInputStreamAdapter(buffer);

        // add stream to arguments
        com.sun.star.beans.PropertyValue[] aExtendedArguments =
            addArgument( aArguments, new com.sun.star.beans.PropertyValue(
                "InputStream", -1, xStream, com.sun.star.beans.PropertyState.DIRECT_VALUE ) );

        // call normal load method
        loadFromURL( "private:stream", aExtendedArguments );
    }

    /** Loads a document from a byte array.

           See loadFromURL() for further information.
     */
    public void loadFromByteArray(
            final byte aInBuffer[],
            final com.sun.star.beans.PropertyValue aArguments[] )
        throws
            // @requirement FUNC.CON.LOST/0.2
            NoConnectionException,
            java.io.IOException,
            com.sun.star.lang.IllegalArgumentException,
            com.sun.star.util.CloseVetoException
    {
        // wrap byte array into UNO stream
        com.sun.star.io.XInputStream xStream =
                new com.sun.star.lib.uno.adapter.ByteArrayToXInputStreamAdapter(
                    aInBuffer );

        // add stream to arguments
        com.sun.star.beans.PropertyValue[] aExtendedArguments =
            addArgument( aArguments, new com.sun.star.beans.PropertyValue(
                "InputStream", -1, xStream, com.sun.star.beans.PropertyState.DIRECT_VALUE ) );

        // call normal load method
        loadFromURL( "private:stream", aExtendedArguments );
    }

    /** Stores a document to the given URL.
        <p>
        Due due a bug (50651) calling this method may cause the office to crash,
        when at the same time the office writes a backup of the document. This bug
        also affects {@link #storeToByteArray storeToByteArray} and
        {@link #storeToStream storeToStream}. The workaround
        is to start the office with the option --norestore, which disables the automatic
        backup and recovery mechanism. OOoBean offers currently no supported way of providing
        startup options for OOo. But it is possible to set a Java property when starting
        Java, which is examined by OOoBean:
        <pre>
            java -Dcom.sun.star.officebean.Options=--norestore  ...
        </pre>
        It is planned to offer a way of specifying startup options in a future version.
        The property can be used until then. When using this property only one option
        can be provided.

        @throws IllegalArgumentException
            if either of the arguments is out of the specified range.

        @throws java.io.IOException
            if an IO error occurs reading the resource specified by the URL.

        @throws com.sun.star.comp.beans.NoConnectionException
            if no connection is established.

        @throws NoDocumentException
            if no document is loaded
     */
    public void storeToURL(
            final String aURL,
            final com.sun.star.beans.PropertyValue aArguments[] )
        throws
            // @requirement FUNC.CON.LOST/0.2
            NoConnectionException,
            java.io.IOException,
            com.sun.star.lang.IllegalArgumentException,
            NoDocumentException
 {
        // no document available?
        if (aDocument == null)
            throw new NoDocumentException();

        try {
            // start runtime timeout
            CallWatchThread aCallWatchThread = new CallWatchThread(
                    nOOoCallTimeOut, "storeToURL");

            // store the document
            try {
                aDocument.storeToURL(aURL, aArguments);
            } catch (com.sun.star.io.IOException aExc) {
                java.io.IOException ex2 = new java.io.IOException();
                ex2.initCause(aExc);
                throw ex2;
            }

            // end runtime timeout
            aCallWatchThread.cancel();
        } catch (java.lang.InterruptedException aExc) {
            throw new NoConnectionException(aExc);
        }
    }

    /** Stores a document to a stream.

           See {@link #storeToURL storeToURL} for further information.
        @see #storeToURL storeToURL
     */
    public java.io.OutputStream storeToStream(
            java.io.OutputStream aOutStream,
            final com.sun.star.beans.PropertyValue aArguments[] )
        throws
            // @requirement FUNC.CON.LOST/0.2
            NoConnectionException,
            NoDocumentException,
            java.io.IOException,
            com.sun.star.lang.IllegalArgumentException

    {
        // wrap Java stream into UNO stream
        com.sun.star.lib.uno.adapter.OutputStreamToXOutputStreamAdapter aStream = new com.sun.star.lib.uno.adapter.OutputStreamToXOutputStreamAdapter(
                aOutStream);

        // add stream to arguments
        com.sun.star.beans.PropertyValue[] aExtendedArguments = addArgument(
                aArguments, new com.sun.star.beans.PropertyValue(
                        "OutputStream", -1, aStream,
                        com.sun.star.beans.PropertyState.DIRECT_VALUE));

        // call normal store method
        storeToURL("private:stream", aExtendedArguments);

        // get byte array from document stream
        try {
            aStream.closeOutput();
        } catch (com.sun.star.io.NotConnectedException aExc) { /* TDB */
        } catch (com.sun.star.io.BufferSizeExceededException aExc) { /* TDB */
        } catch (com.sun.star.io.IOException aExc) {
            java.io.IOException ex2 = new java.io.IOException();
            ex2.initCause(aExc);
            throw ex2;
        }
        return aOutStream;
    }

    /** Stores a document to a byte array.

           See {@link #storeToURL storeToURL} for further information.
        @see #storeToURL storeToURL
     */
    public byte[] storeToByteArray(
            byte aOutBuffer[],
            final com.sun.star.beans.PropertyValue aArguments[] )
        throws
            // @requirement FUNC.CON.LOST/0.2
            NoConnectionException,
            NoDocumentException,
            java.io.IOException,
            com.sun.star.lang.IllegalArgumentException
 {
        // wrap byte array into UNO stream
        com.sun.star.lib.uno.adapter.XOutputStreamToByteArrayAdapter aStream = new com.sun.star.lib.uno.adapter.XOutputStreamToByteArrayAdapter(
                aOutBuffer);

        // add stream to arguments
        com.sun.star.beans.PropertyValue[] aExtendedArguments = addArgument(
                aArguments, new com.sun.star.beans.PropertyValue(
                        "OutputStream", -1, aStream,
                        com.sun.star.beans.PropertyState.DIRECT_VALUE));

        // call normal store method
        storeToURL("private:stream", aExtendedArguments);

        // get byte array from document stream
        try {
            aStream.closeOutput();
        } catch (com.sun.star.io.NotConnectedException aExc) { /* TDB */
        } catch (com.sun.star.io.BufferSizeExceededException aExc) { /* TDB */
        } catch (com.sun.star.io.IOException ex1) {
            java.io.IOException ex2 = new java.io.IOException();
            ex2.initCause(ex1);
            throw ex2;
        }
        return aStream.getBuffer();
    }

    // @requirement FUNC.BEAN.PROG/0.5
    // @requirement API.SIM.SEAP/0.2
    /** returns the com::sun::star::frame::Frame
        of the bean.

        @return
            a Java class which implements all interfaces which the service
        com::sun::star::frame::Frame implements.
        Thus, methods can be called directly without queryInterface.
        This feature might be implemented by UNO or explicitly coded.

        @throws NoConnectionException
            if the connection is not established.
     */
    public Frame getFrame()

        throws
            NoConnectionException // @requirement FUNC.CON.LOST/0.2
    {
        if ( iConnection == null )
            throw new NoConnectionException();
        return aFrame;
    }

       // @requirement FUNC.BEAN.PROG/0.5
       // @requirement API.SIM.SEAP/0.2
    /** returns the com::sun::star::frame::Controller of the bean.

        @return
            a Java class which implements all interfaces which the service
        com::sun::star::frame::Controller implements.
        Thus, methods can be called directly without queryInterface.
        This feature might be implemented by UNO or explicitly coded.

        @throws NoConnectionException
            if the connection is not established.
     */
    public Controller getController()

        // @requirement FUNC.CON.LOST/0.2
        throws NoConnectionException
    {
        if ( iConnection == null )
            throw new NoConnectionException();
        if ( aController == null )
            aController = new Controller( aFrame.getController() );
        return aController;
    }

    // @requirement FUNC.BEAN.PROG/0.5
    // @requirement FUNC.BEAN.STOR/0.4
    // @requirement FUNC.BEAN.PRNT/0.4
    // @requirement API.SIM.SEAP/0.2
       /** returns the com::sun::star::document::OfficeDocument
        of the bean.

        @return
            a Java class which implements all interfaces which the service
        com::sun::star::document::OfficeDocument
        implements.
        Thus, methods can be called directly without queryInterface.
        This feature might be implemented by UNO or explicitly coded.

        @throws NoConnectionException
            if the connection is not established.
     */
    public OfficeDocument getDocument()

        // @requirement FUNC.CON.LOST/0.2
        throws NoConnectionException
    {
        if ( iConnection == null )
            throw new NoConnectionException();
        return aDocument;
    }

    /** Sets visibility of all tool bars known by this OOoBean version.

        Initially all tool bars are visible.  By hiding all tool bars
        utilizing this method, it is possible to turn just a subset of
        toolbars on afterwards, no matter whether all available tool
        bars are known or not.
        <p>
        If an older OOoBean instance is used with a newer OOo instance,
        some tool bars might not be affected by this method.
        <p>
        If no connection is established or no document is loaded,
        the setting is memorized until a document is loaded.  Same
        is valid when the connection dies within this function call.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. For example:
        <pre>
com.sun.star.beans.XPropertySet xPropSet =
  (com.sun.star.beans.XPropertySet) UnoRuntime.queryInterface(
    com.sun.star.beans.XPropertySet.class, aFrame );
com.sun.star.frame.XLayoutManager xLayoutManager =
  (com.sun.star.frame.XLayoutManager) UnoRuntime.queryInterface(
    com.sun.star.frame.XLayoutManager.class,
    xPropSet.getPropertyValue( "LayoutManager" ) );
xLayoutManager.showElement("private:resource/menubar/menubar");
        </pre>
     */
    public void setAllBarsVisible( boolean bVisible )
    {
        bIgnoreVisibility = true;
        setMenuBarVisible( bVisible );
        setStandardBarVisible( bVisible );
        setToolBarVisible( bVisible );
        setStatusBarVisible( bVisible );
        bIgnoreVisibility = false;
    }


    /** Applies all tool visibilities to the real thing.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible setAllBarsVisible}.
     */
    protected void applyToolVisibilities()
    {
        bIgnoreVisibility = true;
        setMenuBarVisible( bMenuBarVisible );
        setStandardBarVisible( bStandardBarVisible );
        setToolBarVisible( bToolBarVisible );
        setStatusBarVisible( bStatusBarVisible );
        bIgnoreVisibility = false;
    }

    /** Helper method to set tool bar visibilty.

         @param bNewValue
            If false, the tool bar is disabled,
            If true, the tool bar is visible.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
     */
    protected boolean setToolVisible( String aProperty, String aResourceURL,
        boolean bOldValue, boolean bNewValue )

        throws
            InterruptedException
    {
        // start runtime timeout
        CallWatchThread aCallWatchThread =
            new CallWatchThread( nOOoCallTimeOut, "setToolVisible" );

        // Does a frame exist?
        if ( aFrame != null )
        {
            if ( bIgnoreVisibility || bOldValue != bNewValue )
            {
                try
                {
                    com.sun.star.beans.XPropertySet xPropSet =
                            UnoRuntime.queryInterface(
                    com.sun.star.beans.XPropertySet.class, aFrame );
                    com.sun.star.frame.XLayoutManager xLayoutManager =
                            UnoRuntime.queryInterface(
                    com.sun.star.frame.XLayoutManager.class,
                    xPropSet.getPropertyValue( "LayoutManager" ) );
                    if ( bNewValue )
                        xLayoutManager.showElement( aResourceURL );
                    else
                        xLayoutManager.hideElement( aResourceURL );
                }
                catch (  com.sun.star.beans.UnknownPropertyException aExc )
                {
                    throw new RuntimeException( "not layout manager found", aExc );
                }
                catch (  com.sun.star.lang.WrappedTargetException aExc )
                {
                    throw new RuntimeException( "not layout manager found", aExc );
                }

                // notify change
                firePropertyChange( aProperty, Boolean.valueOf(bOldValue), Boolean.valueOf(bNewValue) );
           }
        }

        // end runtime timeout
        aCallWatchThread.cancel();

        // the new value will be stored by caller
        return bNewValue;
    }

    /** Sets the visibility of the menu bar.

        Initially the menu bar is visible.
        <p>
        If not connected or no document loaded, the value is stored
        and automatically applied to the document after it is loaded.
        Same is valid when the connection dies within this function call.

         @param bVisible
            If false, the menu bar is disabled,
            If true, the menu bar is visible.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
     */
    public void setMenuBarVisible(boolean bVisible)
    {
        try
        {
            bMenuBarVisible = setToolVisible( "MenuBarVisible",
                    "private:resource/menubar/menubar", bMenuBarVisible, bVisible );
        }
        catch ( InterruptedException aExc )
        {
            bMenuBarVisible = bVisible;
        }
    }

      /** Returns the visibility of the menu bar.

        This method works independently from a connection or loaded document.
        If no connection is established or no document is loaded,
        this method just returns a memorized status.

        @return
            True if the menu bar is visible,
            false if the menu bar is hidden.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
     */
    public boolean isMenuBarVisible()
    {
        return bMenuBarVisible;
    }

    /** Sets the main function bar visibilty.

        Initially the standard bar is visible.

        If not connected or no document loaded, the value is stored
        and automatically applied to the document after it is loaded.
        Same is valid when the connection dies within this function call.

         @param bVisible
            If false, the main function bar is disabled,
            If true, the main function bar is visible.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
     */
    public void setStandardBarVisible(boolean bVisible)
    {
        try
        {
            bStandardBarVisible = setToolVisible( "StandardBarVisible",
                    "private:resource/toolbar/standardbar", bStandardBarVisible, bVisible );
        }
        catch ( InterruptedException aExc )
        {
            bMenuBarVisible = bVisible;
        }
    }

      /** Returns the visibility of the main function bar.

           This method works independently from a connection or loaded document.
        If no connection is established or no document is loaded,
        this method just returns a memorized status.

        @return
            True if the main function bar is visible,
            false if the main function bar is hidden.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
    */
    public boolean isStandardBarVisible()
    {
        return bStandardBarVisible;
    }

    /** Sets the tool function bar visibilty.

        Initially the tool bar is visible.

        If not connected or no document loaded, the value is stored
        and automatically applied to the document after it is loaded.
        Same is valid when the connection dies within this function call.

         @param bVisible
            If false, the tool function bar is disabled,
            If true, the tool function bar is visible.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
     */
    public void setToolBarVisible(boolean bVisible)
    {
        try
        {
            bToolBarVisible = setToolVisible( "ToolBarVisible",
                    "private:resource/toolbar/toolbar", bToolBarVisible, bVisible );
        }
        catch ( InterruptedException aExc )
        {
            bMenuBarVisible = bVisible;
        }
    }

      /** Returns the visibility of the tool function bar.

           This method works independently from a connection or loaded document.
        If no connection is established or no document is loaded,
        this method just returns a memorized status.

        @return
            True if the tool function bar is visible,
            false if the tool function bar is hidden.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
     */
    public boolean isToolBarVisible()
    {
        return bToolBarVisible;
    }

    /** Sets the status function bar visibilty.

        Initially the status bar is visible.

        If not connected or no document loaded, the value is stored
        and automatically applied to the document after it is loaded.
        Same is valid when the connection dies within this function call.

         @param bVisible
            If false, the status function bar is disabled,
            If true, the status function bar is visible.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
     */
    public void setStatusBarVisible(boolean bVisible)
    {
        try
        {
            bStatusBarVisible = setToolVisible( "StatusBarVisible",
                    "private:resource/statusbar/statusbar", bStatusBarVisible, bVisible );
        }
        catch ( InterruptedException aExc )
        {
            bMenuBarVisible = bVisible;
        }
    }

      /**   Returns the visibility of the status function bar.

           This method works independently from a connection or loaded document.
        If no connection is established or no document is loaded,
        this method just returns a memorized status.

        @return
            True if the status function bar is visible,
            false if the status function bar is hidden.

        @deprecated Clients should use the service com.sun.star.frame.LayoutManager,
        which can be obtained from a frame, to control toolbars. See also
        {@link #setAllBarsVisible}.
     */
    public boolean isStatusBarVisible()
    {
        return bStatusBarVisible;
    }


    // Helper Methods / Internal Methods


    @Deprecated
    @Override
    public void paint( java.awt.Graphics aGraphics )
    {
    }

    /** Adds a single argument to an array of arguments.

        If the argument by its name is already in aArguments
        it is exchanged and aArguments is returned.
        <p>
        If the argument by its name is not yet in aArguments,
        a new array is created, aArgument added and the new
        array returned.
    */
    protected com.sun.star.beans.PropertyValue[] addArgument(
                com.sun.star.beans.PropertyValue aArguments[],
                final com.sun.star.beans.PropertyValue aArgument )
    {
        // get number of current arguments
        int nNumArgs = 0;
        if ( aArguments != null )
            nNumArgs = aArguments.length;

        // is new argument already set?
        for ( int n = 0; n < nNumArgs; ++n )
        {
            if ( aArguments[n].Name.equals(aArgument.Name) )
            {
                // substitute this argument
                aArguments[n] = aArgument;

                // return current array
                return aArguments;
            }
        }

        // create extended arguments
        com.sun.star.beans.PropertyValue[] aExtendedArguments =
            new com.sun.star.beans.PropertyValue[ nNumArgs + 1 ];

        // copy current arguments
        if (aArguments != null)
            System.arraycopy(aArguments, 0, aExtendedArguments, 0, nNumArgs);

        // add new argument
        aExtendedArguments[ nNumArgs ] = aArgument;

        // return new arguments
        return aExtendedArguments;
    }


    // Helper Classes

    // @internal
    /** Helper class to listen on the connection to learn when it dies.

     */
    private class EventListener
        extends Thread
        implements
            com.sun.star.frame.XTerminateListener
    {
        String aTag;

        EventListener( String aTag )
            throws NoConnectionException
        {
            // init members
            this.aTag = aTag;

            // listen on a dying connection
            iConnection.addEventListener( this );

            // listen on a terminating OOo
            getOOoDesktop().addTerminateListener( this );

            // start this thread as a daemon
            setDaemon( true );
            start();
        }

        public void end()
        {
            // do not listen on a dying connection anymore
            try {
                iConnection.removeEventListener( this );
            }
            catch ( Throwable aExc ) {}

            // do not listen on a terminating OOo anymore
            try {
                getOOoDesktop().removeTerminateListener( this );
            }
            catch ( Throwable aExc ) {}

            // stop thread
            this.interrupt();
        }

        /// gets called when the connection dies
        public void disposing( /*IN*/ com.sun.star.lang.EventObject Source )
        {
            // empty the OOoBean and cut the connection
            stopOOoConnection();
        }

        /// gets called when the user wants to terminate OOo
           public void queryTermination( /*IN*/ com.sun.star.lang.EventObject Event )
            throws com.sun.star.frame.TerminationVetoException
        {
            // disallow termination of OOo while a OOoBean exists
            throw new com.sun.star.frame.TerminationVetoException();
        }

        /// gets called when OOo terminates
        public void notifyTermination( /*IN*/ com.sun.star.lang.EventObject Event )
        {
            // empty the OOoBean and cut the connection
            stopOOoConnection();
        }

        /// watching the connection
        @Override
        public void run()
        {
            dbgPrint( "EventListener(" + aTag + ").run()" );

            // remote call might hang => watch try
            CallWatchThread aCallWatchThread =
                new CallWatchThread( nOOoCallTimeOut, "EventListener(" + aTag + ")" );

            // continue to trying to connect the OOo instance
            long n = 0;
            while ( !isInterrupted()
                    && iConnection != null
                    && iConnection.getComponentContext() != null )
            {
                dbgPrint( "EventListener(" + aTag + ").running() #" + ++n );

                // still alive?
                try
                {
                    // an arbitrary (but cheap) call into OOo
                    iConnection.getComponentContext().getServiceManager();

                    // call successfully performed, restart watch for next loop
                    try
                    {
                        aCallWatchThread.restart();
                    }
                    catch ( InterruptedException aExc )
                    {
                        // ignore late interrupt
                    }
                }
                catch ( java.lang.RuntimeException aExc )
                {
                    // hung
                    OfficeConnection iDeadConn = iConnection;
                    iConnection = null;
                    iDeadConn.dispose();
                }

                // sleep
                try {
                        sleep(nOOoCheckCycle);
                }
                catch ( InterruptedException aExc )
                {
                    dbgPrint("EventListener(" + aTag + ") interrupted.");
                    // thread can be ended by EvendListener.end();
                    break;
                }
            }
        }
    }

}