qadevOOo/runner/util/SOfficeFactory.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 package util;
  19
  20 import java.util.HashMap;
  21 // access the implementations via names
  22 import com.sun.star.uno.XInterface;
  23 import com.sun.star.lang.XMultiServiceFactory;
  24
  25 import com.sun.star.uno.UnoRuntime;
  26 // staroffice interfaces to provide desktop and componentloader
  27 // and components i.e. spreadsheets, writerdocs etc.
  28 import com.sun.star.frame.XDesktop;
  29 import com.sun.star.frame.XComponentLoader;
  30 import com.sun.star.lang.XComponent;
  31 // name - value pair
  32 import com.sun.star.beans.PropertyValue;
  33 import com.sun.star.beans.PropertyState;
  34
  35 // additional classes required for testcase
  36 import com.sun.star.sheet.*;
  37 import com.sun.star.text.*;
  38 import com.sun.star.container.*;
  39 import com.sun.star.chart.*;
  40 import com.sun.star.drawing.*;
  41
  42 public class SOfficeFactory {
  43
  44     private static HashMap<String, SOfficeFactory> lookup = new HashMap<String, SOfficeFactory>(10);
  45     private final XComponentLoader oCLoader;
  46
  47     private SOfficeFactory(XMultiServiceFactory xMSF) {
  48         // get XInterface of Desktop service
  49         Object oInterface;
  50         try {
  51             oInterface = xMSF.createInstance("com.sun.star.frame.Desktop");
  52         } catch (com.sun.star.uno.Exception e) {
  53             throw new IllegalArgumentException("Desktop Service not available", e);
  54         }
  55
  56         // query the desktop interface and then it's componentloader
  57         XDesktop oDesktop = UnoRuntime.queryInterface(
  58             XDesktop.class, oInterface);
  59
  60         oCLoader = UnoRuntime.queryInterface(
  61             XComponentLoader.class, oDesktop);
  62     }
  63
  64     public static SOfficeFactory getFactory(XMultiServiceFactory xMSF) {
  65
  66         SOfficeFactory soFactory = lookup.get(Integer.toString(xMSF.hashCode()));
  67
  68         if (soFactory == null) {
  69             soFactory = new SOfficeFactory(xMSF);
  70             lookup.put(Integer.toString(xMSF.hashCode()), soFactory);
  71         }
  72
  73         return soFactory;
  74     }
  75
  76     // *********************************************************
  77     // Document creation. The documents needed are created here.
  78     // *********************************************************
  79     /**
  80      * method which opens a new TextDocument
  81      *
  82      * @see XTextDocument
  83      */
  84     public XTextDocument createTextDoc(String frameName)
  85         throws com.sun.star.uno.Exception {
  86
  87         XComponent oDoc = openDoc("swriter", frameName);
  88
  89         if (oDoc != null) {
  90             DesktopTools.bringWindowToFront(oDoc);
  91             return UnoRuntime.queryInterface(XTextDocument.class, oDoc);
  92         } else {
  93             return null;
  94         }
  95
  96     } // finished createTextDoc
  97
  98
  99
 100     /**
 101      * method which opens a new SpreadsheetDocument
 102      *
 103      * @see XSpreadsheetDocument
 104      */
 105     public XSpreadsheetDocument createCalcDoc(String frameName)
 106         throws com.sun.star.uno.Exception {
 107
 108         XComponent oDoc = openDoc("scalc", frameName);
 109
 110         if (oDoc != null) {
 111             DesktopTools.bringWindowToFront(oDoc);
 112             return UnoRuntime.queryInterface(XSpreadsheetDocument.class, oDoc);
 113         } else {
 114             return null;
 115         }
 116     } // finished createCalcDoc
 117
 118
 119
 120     /**
 121      * method which opens a new DrawDocument
 122      */
 123     public XComponent createDrawDoc(String frameName)
 124         throws com.sun.star.uno.Exception {
 125
 126         return openDoc("sdraw", frameName);
 127     } // finished createDrawDoc
 128
 129
 130
 131     /**
 132      * method which opens a new ImpressDocument
 133      */
 134     public XComponent createImpressDoc(String frameName)
 135         throws com.sun.star.uno.Exception {
 136
 137         return openDoc("simpress", frameName);
 138     } // finished createImpressDoc
 139
 140
 141
 142     /**
 143      * method which opens a new MathDocument
 144      */
 145     public XComponent createMathDoc(String frameName)
 146         throws com.sun.star.uno.Exception {
 147
 148         return openDoc("smath", frameName);
 149     } // finished createMathDoc
 150
 151
 152
 153     /**
 154      * method which opens a new ChartDocument
 155      *
 156      * @see XChartDocument
 157      */
 158     public XChartDocument createChartDoc()
 159         throws com.sun.star.uno.Exception {
 160
 161         XComponent oDoc = loadDocument("private:factory/schart");
 162
 163         if (oDoc != null) {
 164             DesktopTools.bringWindowToFront(oDoc);
 165             XChartDocument xChartDoc = UnoRuntime.queryInterface(XChartDocument.class, oDoc);
 166             // Create a default chart which many chart tests rely on.
 167             com.sun.star.chart2.XChartDocument xCD2 =
 168                 UnoRuntime.queryInterface(com.sun.star.chart2.XChartDocument.class, oDoc);
 169             xCD2.createDefaultChart();
 170             return xChartDoc;
 171         } else {
 172             return null;
 173         }
 174
 175     } // finished createChartDoc
 176
 177     /**
 178      * creates a simple TextTable defaulted to 2 rows and 2 columns
 179      */
 180     public static XTextTable createTextTable(XTextDocument xTextDoc)
 181     {
 182
 183         TableDsc tDsc = new TableDsc();
 184         InstCreator instCreate = new InstCreator(xTextDoc, tDsc);
 185
 186         XTextTable oTable = (XTextTable) instCreate.getInstance();
 187         return oTable;
 188     }
 189
 190     /**
 191      * creates a TextTable with a specified count of rows and columns
 192      */
 193     public static XTextTable createTextTable(XTextDocument xTextDoc,
 194         int rows, int columns)
 195     {
 196
 197         TableDsc tDsc = new TableDsc(rows, columns);
 198         InstCreator instCreate = new InstCreator(xTextDoc, tDsc);
 199
 200         XTextTable oTable = (XTextTable) instCreate.getInstance();
 201         return oTable;
 202     }
 203
 204
 205
 206     /**
 207      * creates a simple TextFrame
 208      * ... to be continued
 209      */
 210     public static XTextFrame createTextFrame(XTextDocument xTextDoc,
 211         int height, int width) {
 212
 213         FrameDsc tDsc = new FrameDsc(height, width);
 214         InstCreator instCreate = new InstCreator(xTextDoc, tDsc);
 215
 216         XTextFrame oFrame = (XTextFrame) instCreate.getInstance();
 217         return oFrame;
 218     }
 219
 220
 221
 222     public static void insertTextContent(XTextDocument xTextDoc,
 223         XTextContent xCont)
 224         throws com.sun.star.lang.IllegalArgumentException {
 225         XText xText = xTextDoc.getText();
 226         XText oText = UnoRuntime.queryInterface(
 227             XText.class, xText);
 228
 229         XTextCursor oCursor = oText.createTextCursor();
 230         oText.insertTextContent(oCursor, xCont, false);
 231     }
 232
 233     public static com.sun.star.table.XCell getFirstTableCell(
 234         XTextContent oTable) {
 235
 236         String CellNames[] = ((XTextTable) oTable).getCellNames();
 237
 238         com.sun.star.table.XCell oCell = ((XTextTable) oTable).getCellByName(
 239             CellNames[0]);
 240         return oCell;
 241
 242     }
 243
 244     /**
 245      * the method createBookmark
 246      */
 247     public static XTextContent createBookmark(XTextDocument xTextDoc)
 248     {
 249
 250         BookmarkDsc tDsc = new BookmarkDsc();
 251         InstCreator instCreate = new InstCreator(xTextDoc, tDsc);
 252
 253         XTextContent oBookmark = (XTextContent) instCreate.getInstance();
 254         return oBookmark;
 255
 256     } /// finish createBookmark
 257
 258
 259
 260
 261
 262     /**
 263      * the method create Index
 264      */
 265     public static XTextContent createIndex(XTextDocument xTextDoc, String kind)
 266         throws com.sun.star.uno.Exception {
 267
 268         XMultiServiceFactory oDocMSF = UnoRuntime.queryInterface(XMultiServiceFactory.class,
 269             xTextDoc);
 270
 271         Object oInt = oDocMSF.createInstance(kind);
 272
 273         XTextContent xTC = UnoRuntime.queryInterface(XDocumentIndex.class, oInt);
 274
 275         return xTC;
 276
 277     }
 278
 279     public static XSpreadsheet createSpreadsheet(XSpreadsheetDocument oDoc)
 280         throws com.sun.star.uno.Exception {
 281
 282         XMultiServiceFactory oDocMSF = UnoRuntime.queryInterface(XMultiServiceFactory.class, oDoc);
 283
 284         Object oInt = oDocMSF.createInstance(
 285             "com.sun.star.sheet.Spreadsheet");
 286
 287         XSpreadsheet oSpreadsheet = UnoRuntime.queryInterface(XSpreadsheet.class, oInt);
 288
 289         return oSpreadsheet;
 290     }
 291
 292     public static XIndexAccess getTableCollection(XTextDocument oDoc) {
 293
 294         XTextTablesSupplier oTTS = UnoRuntime.queryInterface(XTextTablesSupplier.class, oDoc);
 295
 296         XNameAccess oNA = oTTS.getTextTables();
 297         XIndexAccess oIA = UnoRuntime.queryInterface(XIndexAccess.class, oNA);
 298
 299         return oIA;
 300     }
 301
 302
 303
 304     public XShape createShape(XComponent oDoc, int height, int width, int x, int y, String kind) {
 305         //possible values for kind are 'Ellipse', 'Line' and 'Rectangle'
 306
 307         ShapeDsc sDsc = new ShapeDsc(height, width, x, y, kind);
 308         InstCreator instCreate = new InstCreator(oDoc, sDsc);
 309
 310         XShape oShape = (XShape) instCreate.getInstance();
 311
 312         return oShape;
 313
 314     }
 315
 316     /**
 317      * creates a Diagram as specified in kind
 318      */
 319     public XDiagram createDiagram(XComponent oDoc, String kind) {
 320         XInterface oInterface = null;
 321         XDiagram oDiagram = null;
 322
 323         //get LineDiagram
 324         XMultiServiceFactory oDocMSF = UnoRuntime.queryInterface(XMultiServiceFactory.class, oDoc);
 325
 326         try {
 327             oInterface = (XInterface) oDocMSF.createInstance("com.sun.star.chart." + kind);
 328             oDiagram = UnoRuntime.queryInterface(XDiagram.class, oInterface);
 329         } catch (Exception e) {
 330             // Some exception occurs.FAILED
 331             System.out.println("Couldn't create " + kind + "-Diagram " + e);
 332         }
 333         return oDiagram;
 334     }
 335
 336     /**
 337      * creates a control instance as specified in kind
 338      */
 339     public XInterface createControl(XComponent oDoc, String kind) {
 340
 341         XInterface oControl = null;
 342
 343         XMultiServiceFactory oDocMSF = UnoRuntime.queryInterface(XMultiServiceFactory.class, oDoc);
 344
 345         try {
 346             oControl = (XInterface) oDocMSF.createInstance("com.sun.star.form.component." + kind);
 347         } catch (Exception e) {
 348             // Some exception occurs.FAILED
 349             System.out.println("Couldn't create instance " + kind + ": " + e);
 350         }
 351         return oControl;
 352     }
 353
 354     /**
 355      * create an Instance as specified in kind
 356      */
 357     public Object createInstance(XComponent oDoc, String kind) {
 358
 359         Object oInstance = null;
 360
 361         XMultiServiceFactory oDocMSF = UnoRuntime.queryInterface(XMultiServiceFactory.class, oDoc);
 362
 363         try {
 364             oInstance = oDocMSF.createInstance(kind);
 365         } catch (Exception e) {
 366             // Some exception occurs.FAILED
 367             System.out.println("Couldn't create instance " + kind + ": " + e);
 368         }
 369         return oInstance;
 370     }
 371
 372
 373
 374     public XComponent loadDocument(String fileName)
 375         throws com.sun.star.lang.IllegalArgumentException,
 376         com.sun.star.io.IOException,
 377         com.sun.star.uno.Exception {
 378
 379         // that noargs thing for load attributes
 380         PropertyValue[] szEmptyArgs = new PropertyValue[0];
 381         String frameName = "_blank";
 382
 383         XComponent oDoc = oCLoader.loadComponentFromURL(
 384             fileName, frameName, 0, szEmptyArgs);
 385
 386         if (oDoc == null) {
 387             return null;
 388         }
 389         DesktopTools.bringWindowToFront(oDoc);
 390         return oDoc;
 391     }
 392
 393     public XComponent loadDocument(String fileName, PropertyValue[] Args)
 394         throws com.sun.star.lang.IllegalArgumentException,
 395         com.sun.star.io.IOException,
 396         com.sun.star.uno.Exception {
 397
 398         // that noargs thing for load attributes
 399         String frameName = "_blank";
 400
 401         XComponent oDoc = oCLoader.loadComponentFromURL(
 402             fileName, frameName, 0, Args);
 403
 404         if (oDoc == null) {
 405             return null;
 406         }
 407         DesktopTools.bringWindowToFront(oDoc);
 408
 409         return oDoc;
 410     }
 411
 412     public XComponent openDoc(String kind, String frameName)
 413         throws com.sun.star.lang.IllegalArgumentException,
 414         com.sun.star.io.IOException,
 415         com.sun.star.uno.Exception {
 416
 417         // that noargs thing for load attributes
 418         PropertyValue[] Args = null;
 419         if (kind.equals("simpress")) {
 420             Args = new PropertyValue[1];
 421             PropertyValue Arg = new PropertyValue();
 422             Arg.Name = "OpenFlags";
 423             Arg.Value = "S";
 424             Arg.Handle = -1;
 425             Arg.State = PropertyState.DEFAULT_VALUE;
 426             Args[0] = Arg;
 427         } else {
 428             Args = new PropertyValue[0];
 429         }
 430
 431         if (frameName == null) {
 432             frameName = "_blank";
 433         }
 434         // load a blank a doc
 435         XComponent oDoc = oCLoader.loadComponentFromURL("private:factory/" + kind, frameName, 40, Args);
 436         DesktopTools.bringWindowToFront(oDoc);
 437
 438         return oDoc;
 439
 440     } // finished openDoc
 441
 442
 443 }