Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 253 insertions, 0 deletions

diff --git a/odk/examples/DevelopersGuide/OfficeDev/ContextMenuInterceptor.java b/odk/examples/DevelopersGuide/OfficeDev/ContextMenuInterceptor.java
new file mode 100644
index 000000000..d73554972
--- /dev/null
+++ b/odk/examples/DevelopersGuide/OfficeDev/ContextMenuInterceptor.java
@@ -0,0 +1,253 @@
+/* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*************************************************************************
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  the BSD license.
+ *
+ *  Copyright 2000, 2010 Oracle and/or its affiliates.
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions
+ *  are met:
+ *  1. Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *  2. Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
+ *     contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+ *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+ *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *************************************************************************/
+
+import com.sun.star.beans.XPropertySet;
+import com.sun.star.ui.ActionTriggerSeparatorType;
+import com.sun.star.ui.ContextMenuInterceptorAction;
+import com.sun.star.ui.XContextMenuInterceptor;
+import com.sun.star.uno.UnoRuntime;
+
+public class ContextMenuInterceptor implements XContextMenuInterceptor {
+
+    /**
+     *Description of the Method
+     *
+     *@param  args  Description of Parameter
+     */
+    public static void main(String args[])
+    {
+        try {
+            OfficeConnect aConnect = OfficeConnect.createConnection();
+
+            com.sun.star.frame.XDesktop xDesktop =
+                aConnect.createRemoteInstance(
+                com.sun.star.frame.XDesktop.class,"com.sun.star.frame.Desktop");
+
+            // create a new test document
+            com.sun.star.frame.XComponentLoader xCompLoader =
+                UnoRuntime.queryInterface(
+                com.sun.star.frame.XComponentLoader.class, xDesktop);
+
+            com.sun.star.lang.XComponent xComponent =
+                xCompLoader.loadComponentFromURL("private:factory/swriter",
+                    "_blank", 0, new com.sun.star.beans.PropertyValue[0]);
+
+            // initialize the test document
+            com.sun.star.frame.XFrame xFrame = null;
+            {
+            com.sun.star.text.XTextDocument xDoc =UnoRuntime.queryInterface(com.sun.star.text.XTextDocument.class,
+                                      xComponent);
+
+            String infoMsg = "All context menus of the created document frame contains now a 'Help' entry with the submenus 'Content', 'Help on Help' and 'Tips'.\n\nPress 'Return' in the shell to remove the context menu interceptor and finish the example!";
+            xDoc.getText().setString(infoMsg);
+
+            // ensure that the document content is optimal visible
+            com.sun.star.frame.XModel xModel =
+                UnoRuntime.queryInterface(
+                com.sun.star.frame.XModel.class, xDoc);
+            // get the frame for later usage
+            xFrame = xModel.getCurrentController().getFrame();
+
+            com.sun.star.view.XViewSettingsSupplier xViewSettings =
+                UnoRuntime.queryInterface(
+                com.sun.star.view.XViewSettingsSupplier.class, xModel.getCurrentController());
+            xViewSettings.getViewSettings().setPropertyValue(
+                "ZoomType", Short.valueOf((short)0));
+            }
+            // test document will be closed later
+
+            // reuse the frame
+            com.sun.star.frame.XController xController = xFrame.getController();
+            if ( xController != null ) {
+                com.sun.star.ui.XContextMenuInterception xContextMenuInterception =
+                    UnoRuntime.queryInterface(
+                    com.sun.star.ui.XContextMenuInterception.class, xController );
+                if( xContextMenuInterception != null ) {
+                    ContextMenuInterceptor aContextMenuInterceptor = new ContextMenuInterceptor();
+                    com.sun.star.ui.XContextMenuInterceptor xContextMenuInterceptor =
+                        UnoRuntime.queryInterface(
+                        com.sun.star.ui.XContextMenuInterceptor.class, aContextMenuInterceptor );
+                    xContextMenuInterception.registerContextMenuInterceptor( xContextMenuInterceptor );
+
+                    System.out.println( "\n ... all context menus of the created document frame contains now a 'Help' entry with the\n     submenus 'Content', 'Help on Help' and 'Tips'.\n\nPress 'Return' to remove the context menu interceptor and finish the example!");
+
+                    java.io.BufferedReader reader
+                        = new java.io.BufferedReader(new java.io.InputStreamReader(System.in));
+                    reader.read();
+
+                    xContextMenuInterception.releaseContextMenuInterceptor(
+                        xContextMenuInterceptor );
+                    System.out.println( " ... context menu interceptor removed!" );
+                }
+            }
+
+            // close test document
+            com.sun.star.util.XCloseable xCloseable = UnoRuntime.queryInterface(com.sun.star.util.XCloseable.class,
+                                      xComponent );
+
+            if (xCloseable != null ) {
+                xCloseable.close(false);
+            } else
+            {
+                xComponent.dispose();
+            }
+        }
+        catch ( com.sun.star.uno.RuntimeException ex ) {
+            // something strange has happened!
+            System.out.println( " Sample caught exception! " + ex );
+            System.exit(1);
+        }
+        catch ( java.lang.Exception ex ) {
+            // catch java exceptions and do something useful
+            System.out.println( " Sample caught exception! " + ex );
+            System.exit(1);
+        }
+
+        System.out.println(" ... exit!\n");
+        System.exit( 0 );
+    }
+
+    /**
+     *Description of the Method
+     */
+    public ContextMenuInterceptorAction notifyContextMenuExecute(
+             com.sun.star.ui.ContextMenuExecuteEvent aEvent ) throws RuntimeException {
+
+        try {
+
+            // Retrieve context menu container and query for service factory to
+            // create sub menus, menu entries and separators
+            com.sun.star.container.XIndexContainer xContextMenu = aEvent.ActionTriggerContainer;
+            com.sun.star.lang.XMultiServiceFactory xMenuElementFactory =
+                UnoRuntime.queryInterface(
+            com.sun.star.lang.XMultiServiceFactory.class, xContextMenu );
+            if ( xMenuElementFactory != null ) {
+                // create root menu entry and sub menu
+                com.sun.star.beans.XPropertySet xRootMenuEntry =
+                    UnoRuntime.queryInterface(
+                    com.sun.star.beans.XPropertySet.class,
+                    xMenuElementFactory.createInstance( "com.sun.star.ui.ActionTrigger" ));
+
+                // create a line separator for our new help sub menu
+                com.sun.star.beans.XPropertySet xSeparator =
+                    UnoRuntime.queryInterface(
+                    com.sun.star.beans.XPropertySet.class,
+                    xMenuElementFactory.createInstance( "com.sun.star.ui.ActionTriggerSeparator" ));
+
+                Short aSeparatorType = Short.valueOf( ActionTriggerSeparatorType.LINE );
+                xSeparator.setPropertyValue( "SeparatorType", aSeparatorType );
+
+                // query sub menu for index container to get access
+                com.sun.star.container.XIndexContainer xSubMenuContainer =
+                    UnoRuntime.queryInterface(
+                    com.sun.star.container.XIndexContainer.class,
+                        xMenuElementFactory.createInstance(
+                            "com.sun.star.ui.ActionTriggerContainer" ));
+
+                // initialize root menu entry
+                xRootMenuEntry.setPropertyValue( "Text", "Help");
+                xRootMenuEntry.setPropertyValue( "CommandURL", "slot:5410");
+                xRootMenuEntry.setPropertyValue( "HelpURL", "5410");
+                xRootMenuEntry.setPropertyValue( "SubContainer", xSubMenuContainer );
+
+                // create menu entries for the new sub menu
+
+                // initialize help/content menu entry
+                XPropertySet xMenuEntry = UnoRuntime.queryInterface(
+                                              XPropertySet.class, xMenuElementFactory.createInstance(
+                                                  "com.sun.star.ui.ActionTrigger" ));
+
+                xMenuEntry.setPropertyValue( "Text", "Content" );
+                xMenuEntry.setPropertyValue( "CommandURL", "slot:5401" );
+                xMenuEntry.setPropertyValue( "HelpURL", "5401" );
+
+                // insert menu entry to sub menu
+                xSubMenuContainer.insertByIndex( 0, xMenuEntry );
+
+                // initialize help/help on help
+                xMenuEntry = UnoRuntime.queryInterface(
+                                 com.sun.star.beans.XPropertySet.class,
+                                     xMenuElementFactory.createInstance(
+                                         "com.sun.star.ui.ActionTrigger" ));
+                xMenuEntry.setPropertyValue("Text", "Help on Help");
+                xMenuEntry.setPropertyValue("CommandURL", "slot:5400");
+                xMenuEntry.setPropertyValue("HelpURL", "5400");
+
+                // insert menu entry to sub menu
+                xSubMenuContainer.insertByIndex( 1, xMenuEntry );
+
+                // initialize help/tips
+                xMenuEntry = UnoRuntime.queryInterface(
+                                 com.sun.star.beans.XPropertySet.class,
+                                     xMenuElementFactory.createInstance(
+                                         "com.sun.star.ui.ActionTrigger" ));
+                xMenuEntry.setPropertyValue( "Text", "Tips" );
+                xMenuEntry.setPropertyValue( "CommandURL", "slot:5404" );
+                xMenuEntry.setPropertyValue( "HelpURL", "5404" );
+
+                // insert menu entry to sub menu
+                xSubMenuContainer.insertByIndex( 2, xMenuEntry );
+
+                // add separator into the given context menu
+                xContextMenu.insertByIndex( 0, xSeparator );
+
+                // add new sub menu into the given context menu
+                xContextMenu.insertByIndex( 0, xRootMenuEntry );
+
+                // The controller should execute the modified context menu and stop notifying other
+                // interceptors.
+                return com.sun.star.ui.ContextMenuInterceptorAction.EXECUTE_MODIFIED;
+            }
+        }
+        catch ( com.sun.star.beans.UnknownPropertyException ex ) {
+            // do something useful
+            // we used an unknown property
+        }
+        catch ( com.sun.star.lang.IndexOutOfBoundsException ex ) {
+            // do something useful
+            // we used an invalid index for accessing a container
+        }
+        catch ( com.sun.star.uno.Exception ex ) {
+            // something strange has happened!
+        }
+        catch ( java.lang.Exception ex ) {
+            // catch java exceptions and something useful
+        }
+
+        return com.sun.star.ui.ContextMenuInterceptorAction.IGNORED;
+    }
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */