com.sun.star.frame.XDesktop Java Examples

/**
 * Returns desktop service of the application.
 * 
 * @return desktop service of the application
 * 
 * @throws OfficeApplicationException if the desktop service is not available
 * 
 * @author Andreas Bröker
 */
public IDesktopService getDesktopService() throws OfficeApplicationException {
  try {
    if (officeConnection == null)
      throw new OfficeApplicationException("Application is not active.");

    if (desktopService == null) {
      Object service = officeConnection.createService("com.sun.star.frame.Desktop");
      XDesktop desktop = (XDesktop) UnoRuntime.queryInterface(XDesktop.class, service);
      desktopService = new DesktopService(desktop, officeConnection);
    }
    return desktopService;
  }
  catch (Exception exception) {
    OfficeApplicationException officeApplicationException = new OfficeApplicationException(exception.getMessage());
    officeApplicationException.initCause(exception);
    throw officeApplicationException;
  }
}
 

/**
 * Returns current documents of an application.
 * 
 * @return documents of an application
 * 
 * @throws DocumentException if the documents cannot be provided
 * 
 * @author Markus Krüger
 * @date 11.11.2008
 */
public static IDocument[] getCurrentDocuments(IServiceProvider serviceProvider)
    throws DocumentException {
  try {
    if (serviceProvider == null)
      return new IDocument[0];
    Object desktop = serviceProvider.createService("com.sun.star.frame.Desktop"); //$NON-NLS-1$
    XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(XDesktop.class, desktop);
    XEnumeration aktComponents = xDesktop.getComponents().createEnumeration();
    List arrayList = new ArrayList();
    while (aktComponents.hasMoreElements()) {
      Any a = (Any) aktComponents.nextElement();
      arrayList.add(DocumentLoader.getDocument((XComponent) a.getObject(), serviceProvider, null));
    }
    IDocument[] documents = new IDocument[arrayList.size()];
    documents = (IDocument[]) arrayList.toArray(documents);
    return documents;
  }
  catch (Exception exception) {
    throw new DocumentException(exception);
  }
}
 

/**
 * Returns current number of documents of an application.
 * 
 * @param serviceProvider the serviceProvider to be used
 * 
 * @return number documents of an application
 * 
 * @author Markus Krüger
 * @date 11.11.2008
 */
public static int getCurrentDocumentCount(IServiceProvider serviceProvider)
    throws DocumentException {
  try {
    int i = 0;
    if (serviceProvider == null)
      return i;
    Object desktop = serviceProvider.createService("com.sun.star.frame.Desktop"); //$NON-NLS-1$
    XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(XDesktop.class, desktop);
    XEnumeration aktComponents = xDesktop.getComponents().createEnumeration();
    while (aktComponents.hasMoreElements()) {
      aktComponents.nextElement();
      i++;
    }
    return i;
  }
  catch (Exception exception) {
    throw new DocumentException(exception);
  }
}
 

private void doStopProcess() {
	try {
		XDesktop desktop = OfficeUtils.cast(XDesktop.class, connection.getService(OfficeUtils.SERVICE_DESKTOP));
		desktop.terminate();
	} catch (DisposedException disposedException) {
		// expected
	} catch (Exception exception) {
		// in case we can't get hold of the desktop
		doTerminateProcess();
	}
	doEnsureProcessExited();
}
 

private void doStopProcess() {
	try {
		XDesktop desktop = OfficeUtils.cast(XDesktop.class, connection.getService(OfficeUtils.SERVICE_DESKTOP));
		desktop.terminate();
	} catch (DisposedException disposedException) {
		// expected
	} catch (Exception exception) {
		// in case we can't get hold of the desktop
		doTerminateProcess();
	}
	doEnsureProcessExited();
}
 

/** Returns the curerent XDesktop */
public static XDesktop getCurrentDesktop(XComponentContext xContext) {
	XMultiComponentFactory xMCF = (XMultiComponentFactory) UnoRuntime.queryInterface(XMultiComponentFactory.class,
			xContext.getServiceManager());
       Object desktop = null;
	try {
		desktop = xMCF.createInstanceWithContext("com.sun.star.frame.Desktop", xContext);
	} catch (Exception e) {
		return null;
	}
       return (XDesktop) UnoRuntime.queryInterface(com.sun.star.frame.XDesktop.class, desktop);
}
 

private void doStopProcess() {
	try {
		XDesktop desktop = OfficeUtils.cast(XDesktop.class, connection.getService(OfficeUtils.SERVICE_DESKTOP));
		desktop.terminate();
	} catch (DisposedException disposedException) {
		// expected
	} catch (Exception exception) {
		// in case we can't get hold of the desktop
		doTerminateProcess();
	}
	doEnsureProcessExited();
}
 

/**
 * Returns the XDesktop interface from the OpenOffice.org desktop service.
 * 
 * @param xMultiServiceFactory factory in order to construct the service
 * 
 * @return XDesktop interface from the OpenOffice.org desktop service
 * 
 * @throws Exception if any error occurs
 */
public static XDesktop getXDesktop(XMultiServiceFactory xMultiServiceFactory) throws Exception {
	Object service = xMultiServiceFactory.createInstance("com.sun.star.frame.Desktop");
	if(service != null) {
		return (XDesktop)UnoRuntime.queryInterface(XDesktop.class, service);
	}
	else {
		return null;
	}
}
 

/**
 * Returns the XDesktop interface from the OpenOffice.org desktop service.
 * 
 * @param componentContext component context to be used
 * 
 * @return XDesktop interface from the OpenOffice.org desktop service
 * 
 * @throws Exception if any error occurs
 */
public static XDesktop getXDesktop(XComponentContext componentContext) throws Exception {
	Object service = componentContext.getServiceManager().createInstanceWithContext("com.sun.star.frame.Desktop", componentContext);
	if(service != null) {
		return (XDesktop)UnoRuntime.queryInterface(XDesktop.class, service);
	}
	else {
		return null;
	}
}
 

/**
 * Disconnects from an OOo server using the connection string from the
 * previous connect.
 * 
 * If there has been no previous connect, the disconnects does nothing.
 * 
 * If there has been a previous connect, disconnect tries to terminate
 * the OOo server and kills the OOo server process the connect started.
 */
public void disconnect() {

    if (oooConnectionString == null)
        return;

    // call office to terminate itself
    try {
        // get local context
        XComponentContext xLocalContext = getLocalContext();

        // create a URL resolver
        XUnoUrlResolver xUrlResolver = UnoUrlResolver.create(xLocalContext);

        // get remote context
        XComponentContext xRemoteContext = getRemoteContext(xUrlResolver);

        // get desktop to terminate office
        Object desktop = xRemoteContext.getServiceManager().createInstanceWithContext("com.sun.star.frame.Desktop",xRemoteContext);
        XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(XDesktop.class, desktop);
        xDesktop.terminate();
    }
    catch (Exception e) {
        // Bad luck, unable to terminate office
    }

    oooServer.kill();
    oooConnectionString = null;
}
 

/**
 * Gets the current component.
 * @return the current component
 * @throws Exception
 *             the exception
 */
public static XComponent getCurrentComponent() throws Exception {
	XComponentContext xRemoteContext = com.sun.star.comp.helper.Bootstrap.createInitialComponentContext(null);
	// XComponentContext xRemoteContext =
	// com.sun.star.comp.helper.Bootstrap.bootstrap();

	XMultiComponentFactory xRemoteServiceManager = xRemoteContext.getServiceManager();

	Object desktop = xRemoteServiceManager.createInstanceWithContext("com.sun.star.frame.Desktop", xRemoteContext); //$NON-NLS-1$

	XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(XDesktop.class, desktop);

	XComponent currentComponent = xDesktop.getCurrentComponent();

	return currentComponent;
}
 

/**
 * Gets the current component.
 * @return the current component
 * @throws Exception
 *             the exception
 */
public static XComponent getCurrentComponent() throws Exception {
	XComponentContext xRemoteContext = com.sun.star.comp.helper.Bootstrap.createInitialComponentContext(null);
	// XComponentContext xRemoteContext =
	// com.sun.star.comp.helper.Bootstrap.bootstrap();

	XMultiComponentFactory xRemoteServiceManager = xRemoteContext.getServiceManager();

	Object desktop = xRemoteServiceManager.createInstanceWithContext("com.sun.star.frame.Desktop", xRemoteContext); //$NON-NLS-1$

	XDesktop xDesktop = (XDesktop) UnoRuntime.queryInterface(XDesktop.class, desktop);

	XComponent currentComponent = xDesktop.getCurrentComponent();

	return currentComponent;
}
 

protected XDesktop createDesktop() throws com.sun.star.uno.Exception {
    Object o = xComponentContext.getServiceManager().createInstanceWithContext(
            "com.sun.star.frame.Desktop", xComponentContext);
    return as(XDesktop.class, o);
}
 

/**
 * Constructs new DesktopService.
 * 
 * @param xDesktop OpenOffice.org XDesktop interface to be used
 * @param officeConnection connection to OpenOffice.org to be used
 * @param preventTermination indicates if the termination should be prevented
 * 
 * @throws IllegalArgumentException if the submitted OpenOffice.org XDesktop interface or the connection to OpenOffice.org
 * is not valid
 * 
 * @author Markus Krüger
 */
public DesktopService(XDesktop xDesktop, IOfficeConnection officeConnection, boolean preventTermination) throws IllegalArgumentException {
  if(xDesktop == null)
    throw new IllegalArgumentException("The submitted OpenOffice.org XDesktop interface is not valid.");
  this.xDesktop = xDesktop;
  
  if(officeConnection == null)
    throw new IllegalArgumentException("The submitted connection to OpenOffice.org is not valid.");
  this.officeConnection = officeConnection; 
  if(preventTermination)
    activateTerminationPrevention();
}
 

/**
 * Constructs new DesktopService.
 * 
 * @param xDesktop OpenOffice.org XDesktop interface to be used
 * @param officeConnection connection to OpenOffice.org to be used
 * 
 * @throws IllegalArgumentException if the submitted OpenOffice.org XDesktop interface or the connection to OpenOffice.org
 * is not valid
 * 
 * @author Andreas Bröker
 * @author Markus Krüger
 */
public DesktopService(XDesktop xDesktop, IOfficeConnection officeConnection) throws IllegalArgumentException {
  this(xDesktop,officeConnection,false);
}