INTEGRATION: CWS dba203b (1.1.2); FILE ADDED

2006/03/28 13:09:57 fs 1.1.2.3: outsourced the factory to a more generic class
2006/03/28 06:22:20 fs 1.1.2.2: property label changed
2006/03/23 11:51:29 fs 1.1.2.1: a handler displaying the supported services, with support for live-link to the online documentation

1 files changed, 233 insertions, 0 deletions

diff --git a/extensions/qa/integration/extensions/ServicesHandler.java b/extensions/qa/integration/extensions/ServicesHandler.java
new file mode 100644
index 000000000000..4c469266486a
--- /dev/null
+++ b/extensions/qa/integration/extensions/ServicesHandler.java
@@ -0,0 +1,233 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: ServicesHandler.java,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2006-03-31 12:18:03 $
+ *
+ *  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 integration.extensions;
+
+import com.sun.star.lang.ClassNotFoundException;
+import com.sun.star.uno.*;
+import com.sun.star.beans.*;
+import com.sun.star.inspection.*;
+import com.sun.star.frame.*;
+import com.sun.star.lang.XServiceInfo;
+import com.sun.star.lang.XMultiServiceFactory;
+import com.sun.star.lang.XSingleComponentFactory;
+
+/**
+ *
+ * @author fs93730
+ */
+public class ServicesHandler implements XPropertyHandler
+{
+    private XComponentContext   m_context;
+    private String[]            m_supportedServices;
+
+    private class ClickHandler implements com.sun.star.awt.XActionListener
+    {
+        XComponentContext   m_context;
+        private String      m_serviceName;
+
+        public ClickHandler( XComponentContext _context, String _serviceName )
+        {
+            m_context = _context;
+            m_serviceName = _serviceName;
+        }
+
+        public void disposing(com.sun.star.lang.EventObject eventObject)
+        {
+            // not interested in
+        }
+
+        public void actionPerformed(com.sun.star.awt.ActionEvent actionEvent)
+        {
+            try
+            {
+                // translate the service name into a URL to dispatch
+                String documentationURL = "http://api.openoffice.org/docs/common/ref/" + m_serviceName.replace('.','/') + ".html";
+                System.out.println( documentationURL );
+
+                // the OpenHyperlink command, to be dispatched to the Desktop
+                com.sun.star.util.URL dispatchURL[] = { new com.sun.star.util.URL() };
+                dispatchURL[0].Complete = ".uno:OpenHyperlink";
+                com.sun.star.util.XURLTransformer transformer = (com.sun.star.util.XURLTransformer)UnoRuntime.queryInterface(
+                        com.sun.star.util.XURLTransformer.class,
+                        m_context.getServiceManager().createInstanceWithContext( "com.sun.star.util.URLTransformer", m_context ) );
+                transformer.parseStrict( dispatchURL );
+
+                // the dispatcher for the OpenHyperlink command
+                Frame desktop = new Frame(
+                        m_context.getServiceManager().createInstanceWithContext( "com.sun.star.frame.Desktop", m_context ) );
+                XDispatch dispatcher = desktop.queryDispatch(dispatchURL[0],"",0);
+
+                // the arguments for the OpenHyperlink command
+                PropertyValue dispatchArgs[] = new PropertyValue[] { new PropertyValue() };
+                dispatchArgs[0].Name = "URL";
+                dispatchArgs[0].Value = documentationURL;
+
+                dispatcher.dispatch(dispatchURL[0], dispatchArgs );
+            }
+            catch( com.sun.star.uno.Exception e )
+            {
+                e.printStackTrace( System.err );
+            }
+        }
+    }
+
+    /** Creates a new instance of ServicesHandler */
+    public ServicesHandler( XComponentContext _context )
+    {
+        m_context = _context;
+        m_supportedServices = new String[] { };
+    }
+
+    public void actuatingPropertyChanged(String _propertyName, Object _newValue, Object _oldValue, com.sun.star.inspection.XObjectInspectorUI _objectInspectorUI, boolean _firstTimeInit) throws com.sun.star.lang.NullPointerException
+    {
+        // not interested in
+    }
+
+    public void addEventListener(com.sun.star.lang.XEventListener _eventListener)
+    {
+        // ingnoring this
+    }
+
+    public void addPropertyChangeListener(com.sun.star.beans.XPropertyChangeListener _propertyChangeListener) throws com.sun.star.lang.NullPointerException
+    {
+        // ingnoring this
+    }
+
+    public Object convertToControlValue(String _propertyName, Object _propertyValue, com.sun.star.uno.Type type) throws com.sun.star.beans.UnknownPropertyException
+    {
+        return _propertyValue;
+    }
+
+    public Object convertToPropertyValue(String _propertyName, Object _controlValue) throws com.sun.star.beans.UnknownPropertyException
+    {
+        return _controlValue;
+    }
+
+    public void describePropertyLine(String _propertyName, com.sun.star.inspection.LineDescriptor[] _lineDescriptor, com.sun.star.inspection.XPropertyControlFactory _propertyControlFactory) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.NullPointerException
+    {
+        _lineDescriptor[0] = new LineDescriptor();
+        _lineDescriptor[0].Category = "Services";
+        _lineDescriptor[0].DisplayName = "supports service";
+        _lineDescriptor[0].HasPrimaryButton = _lineDescriptor[0].HasSecondaryButton = false;
+        _lineDescriptor[0].IndentLevel = 0;
+        try
+        {
+            XHyperlinkControl hyperlinkControl = (XHyperlinkControl)UnoRuntime.queryInterface(
+                    XHyperlinkControl.class, _propertyControlFactory.createPropertyControl( PropertyControlType.HyperlinkField, true ) );
+            hyperlinkControl.addActionListener( new ClickHandler( m_context,  _propertyName ) );
+
+            _lineDescriptor[0].Control = hyperlinkControl;
+        }
+        catch( com.sun.star.lang.IllegalArgumentException e )
+        {
+        }
+    }
+
+    public void dispose()
+    {
+        // nothing to do
+    }
+
+    public String[] getActuatingProperties()
+    {
+        // none
+        return new String[] { };
+    }
+
+    public com.sun.star.beans.PropertyState getPropertyState(String _propertyName) throws com.sun.star.beans.UnknownPropertyException
+    {
+        return com.sun.star.beans.PropertyState.DIRECT_VALUE;
+    }
+
+    public Object getPropertyValue(String _propertyName) throws com.sun.star.beans.UnknownPropertyException
+    {
+        return _propertyName;
+    }
+
+    public String[] getSupersededProperties()
+    {
+        return new String[] { "SupportedServiceNames" };
+        // we're used in conjunction with a GenericPropertyHandler, which (via inspection) finds
+        // a property SupportedServiceNames, resulting from the XServiceInfo.getSupportedServiceNames
+        // method. Since we handle those ourself, we supersede them.
+    }
+
+    public com.sun.star.beans.Property[] getSupportedProperties()
+    {
+        Property[] properties = new Property[ m_supportedServices.length ];
+        for ( int i=0; i<m_supportedServices.length; ++i )
+            properties[i] = new Property( m_supportedServices[i], 0, new Type( String.class ), (short)0 );
+        return properties;
+    }
+
+    public void inspect(Object _component) throws com.sun.star.lang.NullPointerException
+    {
+        XServiceInfo serviceInfo = (XServiceInfo)UnoRuntime.queryInterface( XServiceInfo.class, _component );
+        if ( serviceInfo != null )
+            m_supportedServices = serviceInfo.getSupportedServiceNames();
+    }
+
+    public boolean isComposable(String _propertyName) throws com.sun.star.beans.UnknownPropertyException
+    {
+        return true;
+    }
+
+    public com.sun.star.inspection.InteractiveSelectionResult onInteractivePropertySelection(String str, boolean param, Object[] obj, com.sun.star.inspection.XObjectInspectorUI xObjectInspectorUI) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.NullPointerException
+    {
+        return InteractiveSelectionResult.Cancelled;
+    }
+
+    public void removeEventListener(com.sun.star.lang.XEventListener _eventListener)
+    {
+        // ignoring this
+    }
+
+    public void removePropertyChangeListener(com.sun.star.beans.XPropertyChangeListener _propertyChangeListener)
+    {
+        // ignoring this
+    }
+
+    public void setPropertyValue(String str, Object obj) throws com.sun.star.beans.UnknownPropertyException
+    {
+        // we declared our properties as readonly
+        throw new java.lang.RuntimeException();
+    }
+
+    public boolean suspend(boolean param)
+    {
+        return true;
+    }
+}