qadevOOo/runner/util/DesktopTools.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: DesktopTools.java,v $
  10  * $Revision: 1.10.8.2 $
  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 util;
  31
  32 import com.sun.star.awt.Rectangle;
  33 import com.sun.star.awt.WindowDescriptor;
  34 import com.sun.star.awt.XToolkit;
  35 import com.sun.star.awt.XWindowPeer;
  36 import com.sun.star.awt.XTopWindow;
  37 import com.sun.star.beans.PropertyValue;
  38 import com.sun.star.beans.XPropertySet;
  39 import com.sun.star.container.XEnumeration;
  40 import com.sun.star.container.XNameReplace;
  41 import com.sun.star.frame.XComponentLoader;
  42 import com.sun.star.frame.XDesktop;
  43 import com.sun.star.frame.XFrame;
  44 import com.sun.star.frame.XModel;
  45 import com.sun.star.lang.XComponent;
  46 import com.sun.star.lang.XMultiServiceFactory;
  47 import com.sun.star.lang.XServiceInfo;
  48 import com.sun.star.uno.UnoRuntime;
  49
  50 // access the implementations via names
  51 import com.sun.star.uno.XInterface;
  52 import com.sun.star.util.XCloseable;
  53 import com.sun.star.util.XModifiable;
  54 import com.sun.star.view.XViewSettingsSupplier;
  55 import helper.ConfigHelper;
  56 import java.util.Vector;
  57 import lib.StatusException;
  58
  59 /**
  60  * contains helper methods for the Desktop
  61  */
  62 public class DesktopTools
  63 {
  64
  65     /**
  66      * Queries the XComponentLoader
  67      *
  68      * @param xMSF the MultiServiceFactory
  69      * @return the gained XComponentLoader
  70      */
  71     public static XComponentLoader getCLoader(XMultiServiceFactory xMSF)
  72     {
  73         XDesktop oDesktop = (XDesktop) UnoRuntime.queryInterface(
  74                 XDesktop.class, createDesktop(xMSF));
  75
  76         XComponentLoader oCLoader = (XComponentLoader) UnoRuntime.queryInterface(
  77                 XComponentLoader.class, oDesktop);
  78
  79         return oCLoader;
  80     } // finish getCLoader
  81
  82     /**
  83      * Creates an Instance of the Desktop service
  84      *
  85      * @param xMSF the MultiServiceFactory
  86      * @return the gained Object
  87      */
  88     public static Object createDesktop(XMultiServiceFactory xMSF)
  89     {
  90         Object oInterface;
  91
  92         try
  93         {
  94             oInterface = xMSF.createInstance("com.sun.star.comp.framework.Desktop");
  95         }
  96         catch (com.sun.star.uno.Exception e)
  97         {
  98             throw new IllegalArgumentException("Desktop Service not available");
  99         }
 100
 101         return oInterface;
 102     } //finish createDesktop
 103
 104     /**
 105      * returns a XEnumeration containing all components containing on the desktop
 106      * @param xMSF the XMultiServiceFactory
 107      * @return XEnumeration of all components on the desktop
 108      */
 109     public static XEnumeration getAllComponents(XMultiServiceFactory xMSF)
 110     {
 111         XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(
 112                 XDesktop.class, createDesktop(xMSF));
 113         return xDesktop.getComponents().createEnumeration();
 114     }
 115
 116     /**
 117      * returns the current component on the desktop
 118      * @param xMSF the XMultiServiceFactory
 119      * @return XComponent of the current component on the desktop
 120      */
 121     public static XComponent getCurrentComponent(XMultiServiceFactory xMSF)
 122     {
 123         XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(
 124                 XDesktop.class, createDesktop(xMSF));
 125         return xDesktop.getCurrentComponent();
 126     }
 127
 128     /**
 129      * returns the current component on the desktop
 130      * @param xMSF the XMultiServiceFactory
 131      * @return XComponent of the current component on the desktop
 132      */
 133     public static XFrame getCurrentFrame(XMultiServiceFactory xMSF)
 134     {
 135         XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(
 136                 XDesktop.class, createDesktop(xMSF));
 137         return xDesktop.getCurrentFrame();
 138     }
 139
 140     /**
 141      * returns an object arrary of all open documents
 142      * @param xMSF the MultiServiceFactory
 143      * @return returns an Array of document kinds like ["swriter"]
 144      */
 145     /**
 146      * returns an array of all open documents
 147      * @param xMSF the XMultiSerivceFactory
 148      * @return returns an array of all open documents
 149      */
 150     public static Object[] getAllOpenDocuments(XMultiServiceFactory xMSF)
 151     {
 152         Vector components = new Vector();
 153         XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(
 154                 XDesktop.class, createDesktop(xMSF));
 155
 156         XEnumeration allComp = getAllComponents(xMSF);
 157
 158         while (allComp.hasMoreElements())
 159         {
 160             try
 161             {
 162                 XComponent xComponent = (XComponent) UnoRuntime.queryInterface(
 163                         XComponent.class, allComp.nextElement());
 164
 165                 if (getDocumentType(xComponent) != null)
 166                 {
 167                     components.add(xComponent);
 168                 }
 169
 170             }
 171             catch (com.sun.star.container.NoSuchElementException e)
 172             {
 173             }
 174             catch (com.sun.star.lang.WrappedTargetException e)
 175             {
 176             }
 177         }
 178         return components.toArray();
 179     }
 180
 181     /**
 182      * Returns the document type for the given XComponent of an document
 183      * @param xComponent the document to query for its type
 184      * @return possible:
 185      * <ul>
 186      * <li>swriter</li>
 187      * <li>scalc</li>
 188      * <li>sdraw</li>
 189      * <li>smath</li>
 190      * </ul>
 191      * or <CODE>null</CODE>
 192      */
 193     public static String getDocumentType(XComponent xComponent)
 194     {
 195         XServiceInfo sInfo = (XServiceInfo) UnoRuntime.queryInterface(
 196                 XServiceInfo.class, xComponent);
 197
 198         if (sInfo == null)
 199         {
 200             return "";
 201         }
 202         else if (sInfo.supportsService("com.sun.star.sheet.SpreadsheetDocument"))
 203         {
 204             return "scalc";
 205         }
 206         else if (sInfo.supportsService("com.sun.star.text.TextDocument"))
 207         {
 208             return "swriter";
 209         }
 210         else if (sInfo.supportsService("com.sun.star.drawing.DrawingDocument"))
 211         {
 212             return "sdraw";
 213         }
 214         else if (sInfo.supportsService("com.sun.star.presentation.PresentationDocument"))
 215         {
 216             return "simpress";
 217         }
 218         else if (sInfo.supportsService("com.sun.star.formula.FormulaProperties"))
 219         {
 220             return "smath";
 221         }
 222         else
 223         {
 224             return null;
 225         }
 226     }
 227
 228     /**
 229      * Opens a new document of a given kind
 230      * with arguments
 231      * @return the XComponent Interface of the document
 232      * @param kind the kind of document to load.<br>
 233      * possible:
 234      * <ul>
 235      * <li>swriter</li>
 236      * <li>scalc</li>
 237      * <li>sdaw</li>
 238      * <li>smath</li>
 239      * </ul>
 240      * @param Args arguments which passed to the document to load
 241      * @param xMSF the MultiServiceFactory
 242      */
 243     public static XComponent openNewDoc(XMultiServiceFactory xMSF, String kind,
 244             PropertyValue[] Args)
 245     {
 246         XComponent oDoc = null;
 247
 248         try
 249         {
 250             oDoc = getCLoader(xMSF).loadComponentFromURL("private:factory/" + kind,
 251                     "_blank", 0, Args);
 252         }
 253         catch (com.sun.star.uno.Exception e)
 254         {
 255             throw new IllegalArgumentException("Document could not be opened");
 256         }
 257
 258         return oDoc;
 259     } //finish openNewDoc
 260
 261     /**
 262      * loads a document of from a given url
 263      * with arguments
 264      * @return the XComponent Interface of the document
 265      * @param url the URL of the document to load.
 266      * @param Args arguments which passed to the document to load
 267      * @param xMSF the MultiServiceFactory
 268      */
 269     public static XComponent loadDoc(XMultiServiceFactory xMSF, String url,
 270             PropertyValue[] Args)
 271     {
 272         XComponent oDoc = null;
 273         if (Args == null)
 274         {
 275             Args = new PropertyValue[0];
 276         }
 277         try
 278         {
 279             oDoc = getCLoader(xMSF).loadComponentFromURL(url, "_blank", 0, Args);
 280         }
 281         catch (com.sun.star.uno.Exception e)
 282         {
 283             throw new IllegalArgumentException("Document could not be loaded");
 284         }
 285
 286         bringWindowToFront(oDoc);
 287         return oDoc;
 288     } //finish openNewDoc
 289
 290     /**
 291      * closes a given document
 292      * @param DocumentToClose the document to close
 293      */
 294     public static void closeDoc(XInterface DocumentToClose)
 295     {
 296         if (DocumentToClose == null)
 297         {
 298             return;
 299         }
 300
 301         String kd = System.getProperty("KeepDocument");
 302         if (kd != null)
 303         {
 304             System.out.println("The property 'KeepDocument' is set and so the document won't be disposed");
 305             return;
 306         }
 307         XModifiable modified = (XModifiable) UnoRuntime.queryInterface(XModifiable.class, DocumentToClose);
 308         XCloseable closer = (XCloseable) UnoRuntime.queryInterface(XCloseable.class, DocumentToClose);
 309
 310         try
 311         {
 312             if (modified != null)
 313             {
 314                 modified.setModified(false);
 315             }
 316             closer.close(true);
 317         }
 318         catch (com.sun.star.util.CloseVetoException e)
 319         {
 320             // e.printStackTrace();
 321             System.out.println("Couldn't close document");
 322         }
 323         catch (com.sun.star.lang.DisposedException e)
 324         {
 325             // e.printStackTrace();
 326             System.out.println("Couldn't close document");
 327         }
 328         catch (java.lang.NullPointerException e)
 329         {
 330             // e.printStackTrace();
 331             System.out.println("Couldn't close document");
 332         }
 333         catch (com.sun.star.beans.PropertyVetoException e)
 334         {
 335             // e.printStackTrace();
 336             System.out.println("Couldn't close document");
 337         }
 338     }
 339
 340     /**
 341      * Creates a floating XWindow with the size of X=500 Y=100 width=400 height=600
 342      * @param xMSF the MultiServiceFactory
 343      * @throws lib.StatusException if it is not possible to create a floating window a lib.StatusException was thrown
 344      * @return a floating XWindow
 345      */
 346     public static XWindowPeer createFloatingWindow(XMultiServiceFactory xMSF)
 347             throws StatusException
 348     {
 349         return createFloatingWindow(xMSF, 500, 100, 400, 600);
 350     }
 351
 352     /**
 353      * Creates a floating XWindow on the given position and size.
 354      * @return a floating XWindow
 355      * @param X the X-Postion of the floating XWindow
 356      * @param Y the Y-Postion of the floating XWindow
 357      * @param width the width of the floating XWindow
 358      * @param height the height of the floating XWindow
 359      * @param xMSF the MultiServiceFactory
 360      * @throws lib.StatusException if it is not possible to create a floating window a lib.StatusException was thrown
 361      */
 362     public static XWindowPeer createFloatingWindow(XMultiServiceFactory xMSF, int X, int Y, int width, int height)
 363             throws StatusException
 364     {
 365
 366         XInterface oObj = null;
 367
 368         try
 369         {
 370             oObj = (XInterface) xMSF.createInstance("com.sun.star.awt.Toolkit");
 371         }
 372         catch (com.sun.star.uno.Exception e)
 373         {
 374             throw new StatusException("Couldn't get toolkit", e);
 375         }
 376
 377         XToolkit tk = (XToolkit) UnoRuntime.queryInterface(
 378                 XToolkit.class, oObj);
 379
 380         WindowDescriptor descriptor = new com.sun.star.awt.WindowDescriptor();
 381
 382         descriptor.Type = com.sun.star.awt.WindowClass.TOP;
 383         descriptor.WindowServiceName = "modelessdialog";
 384         descriptor.ParentIndex = -1;
 385
 386         Rectangle bounds = new com.sun.star.awt.Rectangle();
 387         bounds.X = X;
 388         bounds.Y = Y;
 389         bounds.Width = width;
 390         bounds.Height = height;
 391
 392         descriptor.Bounds = bounds;
 393         descriptor.WindowAttributes = (com.sun.star.awt.WindowAttribute.BORDER +
 394                 com.sun.star.awt.WindowAttribute.MOVEABLE +
 395                 com.sun.star.awt.WindowAttribute.SIZEABLE +
 396                 com.sun.star.awt.WindowAttribute.CLOSEABLE +
 397                 com.sun.star.awt.VclWindowPeerAttribute.CLIPCHILDREN);
 398
 399         XWindowPeer xWindow = null;
 400
 401         try
 402         {
 403             xWindow = tk.createWindow(descriptor);
 404         }
 405         catch (com.sun.star.lang.IllegalArgumentException e)
 406         {
 407             throw new StatusException("Could not create window", e);
 408         }
 409
 410         return xWindow;
 411
 412     }
 413
 414     /**
 415      * zoom to have a view over the hole page
 416      * @param xDoc the document to zoom
 417      */
 418     public static void zoomToEntirePage(XInterface xDoc)
 419     {
 420         try
 421         {
 422             XModel xMod = (XModel) UnoRuntime.queryInterface(XModel.class, xDoc);
 423             XInterface oCont = xMod.getCurrentController();
 424             XViewSettingsSupplier oVSSupp = (XViewSettingsSupplier) UnoRuntime.queryInterface(XViewSettingsSupplier.class, oCont);
 425
 426             XInterface oViewSettings = oVSSupp.getViewSettings();
 427             XPropertySet oViewProp = (XPropertySet) UnoRuntime.queryInterface(XPropertySet.class, oViewSettings);
 428             oViewProp.setPropertyValue("ZoomType",
 429                     new Short(com.sun.star.view.DocumentZoomType.ENTIRE_PAGE));
 430
 431             utils.shortWait(5000);
 432         }
 433         catch (Exception e)
 434         {
 435             System.out.println("Could not zoom to entire page: " + e.toString());
 436         }
 437
 438     }
 439
 440     /**
 441      * This function docks the Stylist onto the right side of the window.</p>
 442      * Note:<P>
 443      * Since the svt.viewoptions cache the view configuration at start up
 444      * the chage of the docking will be effective at a restart.
 445      * @param xMSF the XMultiServiceFactory
 446      */
 447     public static void dockStylist(XMultiServiceFactory xMSF)
 448     {
 449         // prepare Window-Settings
 450         try
 451         {
 452             ConfigHelper aConfig = new ConfigHelper(xMSF,
 453                     "org.openoffice.Office.Views", false);
 454
 455             // Is node "5539" (slot-id for navigator) available? If not, insert it
 456             XNameReplace x5539 = aConfig.getOrInsertGroup("Windows", "5539");
 457
 458             aConfig.updateGroupProperty(
 459                     "Windows", "5539", "WindowState", "952,180,244,349;1;0,0,0,0;");
 460
 461             aConfig.insertOrUpdateExtensibleGroupProperty(
 462                     "Windows", "5539", "UserData", "Data", "V2,V,0,AL:(5,16,0/0/244/349,244;610)");
 463
 464             // Is node "SplitWindow2" available? If not, instert it.
 465             aConfig.getOrInsertGroup("Windows", "SplitWindow2");
 466
 467             aConfig.insertOrUpdateExtensibleGroupProperty(
 468                     "Windows", "SplitWindow2", "UserData", "UserItem", "V1,2,1,0,5539");
 469
 470             aConfig.flush();
 471             aConfig = null;
 472
 473         }
 474         catch (com.sun.star.uno.Exception e)
 475         {
 476             e.printStackTrace();
 477         }
 478     }
 479
 480     /**
 481      * Due to typo deprecated
 482      * @param xModel
 483      * @deprecated
 484      */
 485     @Deprecated
 486     public static void bringWindowToFromt(XModel xModel)
 487     {
 488         bringWindowToFront(xModel);
 489     }
 490
 491     /**
 492      * This function brings a document to the front.<P>
 493      * NOTE: it is not possible to change the window order of your Window-Manager!!
 494      * Only the order of Office documents are changeable.
 495      * @param xModel the XModel of the document to bring to top
 496      */
 497     public static void bringWindowToFront(XModel xModel)
 498     {
 499         // System.out.println("DEBUG: bring to front xModel");
 500
 501         XTopWindow xTopWindow =
 502                 (XTopWindow) UnoRuntime.queryInterface(
 503                 XTopWindow.class,
 504                 xModel.getCurrentController().getFrame().getContainerWindow());
 505
 506         xTopWindow.toFront();
 507     }
 508
 509     public static void bringWindowToFront(XComponent xComponent)
 510     {
 511         // System.out.println("DEBUG: bring to front xComponent");
 512         XModel xModel = (XModel) UnoRuntime.queryInterface(XModel.class, xComponent);
 513         if (xModel != null)
 514         {
 515             bringWindowToFront(xModel);
 516         }
 517     }
 518 }