/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: LocalOfficeWindow.java,v $
*
* $Revision: 1.7 $
*
* last change: $Author: vg $ $Date: 2007/08/30 13:58:11 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
package com.sun.star.comp.beans;
import java.awt.Component;
import java.awt.Canvas;
import com.sun.star.lang.EventObject;
import com.sun.star.lang.SystemDependent;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XEventListener;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.lang.XMultiComponentFactory;
import com.sun.star.awt.Rectangle;
import com.sun.star.awt.XWindow;
import com.sun.star.awt.XWindowPeer;
import com.sun.star.awt.XVclWindowPeer;
import com.sun.star.awt.XToolkit;
import com.sun.star.awt.WindowDescriptor;
import com.sun.star.awt.WindowAttribute;
import com.sun.star.awt.WindowClass;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XComponentContext;
import com.sun.star.uno.Exception;
import com.sun.star.uno.Any;
import com.sun.star.uno.Type;
import com.sun.star.beans.NamedValue;
/**
* This class represents a local office window.
*
* @since OOo 2.0.0
*/
public class LocalOfficeWindow
extends java.awt.Canvas
implements OfficeWindow, XEventListener
{
private transient OfficeConnection mConnection;
private transient XWindowPeer mParentProxy;
private transient XWindowPeer mWindow;
private boolean bPeer = false;
/**
* Construnctor.
*
* @param connection The office connection object the window
* belongs to.
*/
protected LocalOfficeWindow(OfficeConnection connection)
{
mConnection = connection;
mConnection.addEventListener((XEventListener)this);
}
/**
* Retrives an AWT component object associated with the OfficeWindow.
*
* @return The AWT component object associated with the OfficeWindow.
*/
public Component getAWTComponent()
{
return this;
}
/**
* Retrives an UNO XWindowPeer object associated with the OfficeWindow.
*
* @return The UNO XWindowPeer object associated with the OfficeWindow.
*/
public XWindowPeer getUNOWindowPeer()
{
if (mWindow == null)
createUNOWindowPeer();
return mWindow;
}
/**
* Receives a notification about the connection has been closed.
* This method has to set the connection to <code>null</code>.
*
* @source The event object.
*/
public void disposing(EventObject source)
{
// the window will be disposed by the framework
mWindow = null;
mConnection = null;
}
/**
* Returns an AWT toolkit.
*/
private XToolkit queryAWTToolkit()
throws com.sun.star.uno.Exception
{
// Create a UNO toolkit.
XMultiComponentFactory compfactory;
XComponentContext xContext = mConnection.getComponentContext();
if ( xContext != null )
{
compfactory = mConnection.getComponentContext().getServiceManager();
XMultiServiceFactory factory;
factory = (XMultiServiceFactory)UnoRuntime.queryInterface(
XMultiServiceFactory.class, compfactory);
Object object = factory.createInstance( "com.sun.star.awt.Toolkit");
return (XToolkit)UnoRuntime.queryInterface(XToolkit.class, object);
}
else
return null;
}
/// called when system parent is available, reparents the bean window
private synchronized void aquireSystemWindow()
{
if ( !bPeer )
{
// set real parent
XVclWindowPeer xVclWindowPeer = (XVclWindowPeer)UnoRuntime.queryInterface(
XVclWindowPeer.class, mWindow);
xVclWindowPeer.setProperty( "PluginParent", getWrappedWindowHandle());
bPeer = true;
// show document window
XWindow aWindow = (XWindow)UnoRuntime.queryInterface(XWindow.class, mWindow);
aWindow.setVisible( true );
}
}
/// called when system parent is about to die, reparents the bean window
private synchronized void releaseSystemWindow()
{
if ( bPeer )
{
// hide document window
XWindow aWindow = (XWindow)UnoRuntime.queryInterface(XWindow.class, mWindow);
aWindow.setVisible( false );
// set null parent
XVclWindowPeer xVclWindowPeer = (XVclWindowPeer)UnoRuntime.queryInterface(
XVclWindowPeer.class, mWindow);
xVclWindowPeer.setProperty( "PluginParent", new Long(0) );
bPeer = false;
}
}
/// Overriding java.awt.Component.setVisible() due to Java bug (no showing event).
public void setVisible( boolean b )
{
super.setVisible(b);
// Java-Bug: componentShown() is never called :-(
// is still at least in Java 1.4.1_02
if ( b )
aquireSystemWindow();
else
releaseSystemWindow();
}
/** Factory method for a UNO AWT toolkit window as a child of this Java window.
*
*/
private synchronized XWindowPeer createUNOWindowPeer()
{
try
{
// get this windows native window type
int type = getNativeWindowSystemType();
// Java AWT windows only have a system window when showing.
XWindowPeer parentPeer;
if ( isShowing() )
{
// create direct parent relationship
//setVisible( true );
parentPeer = new JavaWindowPeerFake(getWrappedWindowHandle(), type);
bPeer = true;
}
else
{
// no parent yet
parentPeer = null;
bPeer = false;
}
// create native window (mWindow)
Rectangle aRect = new Rectangle( 0, 0, 20, 20 );
WindowDescriptor desc = new WindowDescriptor();
desc.Type = WindowClass.TOP;
desc.Parent = parentPeer;
desc.Bounds = aRect;
desc.WindowServiceName = "workwindow";
desc.WindowAttributes = (type == SystemDependent.SYSTEM_WIN32)
? WindowAttribute.SHOW : 0;
mWindow = queryAWTToolkit().createWindow(desc);
// set initial visibility
XWindow aWindow = (XWindow)UnoRuntime.queryInterface(XWindow.class, mWindow);
aWindow.setVisible( bPeer );
}
catch (com.sun.star.uno.Exception exp) {
}
return mWindow;
}
/** We make sure that the office window is notified that the parent
* will be removed.
*/
public void removeNotify()
{
try {
releaseSystemWindow();
} catch (java.lang.Exception e) {
System.err.println("LocaleOfficeWindow.removeNotify: Exception in releaseSystemWindow.");
System.err.println(e.getMessage());
e.printStackTrace(System.err);
}
super.removeNotify();
}
/**
* Retrives a platform dependant system window identifier.
*
* @return The system window identifier.
*/
private native long getNativeWindow();
/**
* Retrives a platform dependant system window type.
*
* @return The system window type.
*/
private native int getNativeWindowSystemType();
/**
Returns an Any containing a sequences of com.sun.star.beans.NamedValue. One NamedValue
contains the name "WINDOW" and the value is a Long representing the window handle.
The second NamedValue has the name "XEMBED" and the value is true, when the XEmbed
protocol shall be used fore embedding the native Window.
*/
protected Any getWrappedWindowHandle()
{
NamedValue window = new NamedValue(
"WINDOW", new Any(new Type(Long.class), new Long(getNativeWindow())));
NamedValue xembed = new NamedValue(
"XEMBED", new Any(new Type(Boolean.class), new Boolean(false)));
if (getNativeWindowSystemType() == SystemDependent.SYSTEM_XWINDOW )
{
String vendor = System.getProperty("java.vendor");
if (vendor.equals("Sun Microsystems Inc.")
&& Boolean.valueOf(System.getProperty("sun.awt.xembedserver")).booleanValue())
{
xembed = new NamedValue(
"XEMBED",
new Any(new Type(Boolean.class), new Boolean(true)));
}
}
return new Any(
new Type("[]com.sun.star.beans.NamedValue"),
new NamedValue[] {window, xembed});
}
}