| /************************************************************** | |
| * | |
| * Licensed to the Apache Software Foundation (ASF) under one | |
| * or more contributor license agreements. See the NOTICE file | |
| * distributed with this work for additional information | |
| * regarding copyright ownership. The ASF licenses this file | |
| * to you under the Apache License, Version 2.0 (the | |
| * "License"); you may not use this file except in compliance | |
| * with the License. You may obtain a copy of the License at | |
| * | |
| * http://www.apache.org/licenses/LICENSE-2.0 | |
| * | |
| * Unless required by applicable law or agreed to in writing, | |
| * software distributed under the License is distributed on an | |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| * KIND, either express or implied. See the License for the | |
| * specific language governing permissions and limitations | |
| * under the License. | |
| * | |
| *************************************************************/ | |
| 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 | |
| *@since | |
| */ | |
| public static void main(String args[]) | |
| { | |
| try { | |
| OfficeConnect aConnect = OfficeConnect.createConnection(); | |
| com.sun.star.frame.XDesktop xDesktop = | |
| (com.sun.star.frame.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 = new String("All context menus of the created document frame contains now a 'Help' entry with the submenus 'Content', 'Help Agent' 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", new Short((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 Agent' 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 | |
| * | |
| *@param args Description of Parameter | |
| *@since | |
| */ | |
| 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 = new Short( ActionTriggerSeparatorType.LINE ); | |
| xSeparator.setPropertyValue( "SeparatorType", (Object)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", new String( "Help" )); | |
| xRootMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5410" )); | |
| xRootMenuEntry.setPropertyValue( "HelpURL", new String( "5410" )); | |
| xRootMenuEntry.setPropertyValue( "SubContainer", (Object)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", new String( "Content" )); | |
| xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5401" )); | |
| xMenuEntry.setPropertyValue( "HelpURL", new String( "5401" )); | |
| // insert menu entry to sub menu | |
| xSubMenuContainer.insertByIndex( 0, (Object)xMenuEntry ); | |
| // initialize help/help agent | |
| xMenuEntry = UnoRuntime.queryInterface( | |
| com.sun.star.beans.XPropertySet.class, | |
| xMenuElementFactory.createInstance( | |
| "com.sun.star.ui.ActionTrigger" )); | |
| xMenuEntry.setPropertyValue( "Text", new String( "Help Agent" )); | |
| xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5962" )); | |
| xMenuEntry.setPropertyValue( "HelpURL", new String( "5962" )); | |
| // insert menu entry to sub menu | |
| xSubMenuContainer.insertByIndex( 1, (Object)xMenuEntry ); | |
| // initialize help/tips | |
| xMenuEntry = UnoRuntime.queryInterface( | |
| com.sun.star.beans.XPropertySet.class, | |
| xMenuElementFactory.createInstance( | |
| "com.sun.star.ui.ActionTrigger" )); | |
| xMenuEntry.setPropertyValue( "Text", new String( "Tips" )); | |
| xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5404" )); | |
| xMenuEntry.setPropertyValue( "HelpURL", new String( "5404" )); | |
| // insert menu entry to sub menu | |
| xSubMenuContainer.insertByIndex( 2, (Object)xMenuEntry ); | |
| // add separator into the given context menu | |
| xContextMenu.insertByIndex( 0, (Object)xSeparator ); | |
| // add new sub menu into the given context menu | |
| xContextMenu.insertByIndex( 0, (Object)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 a 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; | |
| } | |
| } |