1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski import com.sun.star.beans.XPropertySet; 25*b1cdbd2cSJim Jagielski import com.sun.star.ui.ActionTriggerSeparatorType; 26*b1cdbd2cSJim Jagielski import com.sun.star.ui.ContextMenuInterceptorAction; 27*b1cdbd2cSJim Jagielski import com.sun.star.ui.XContextMenuInterceptor; 28*b1cdbd2cSJim Jagielski import com.sun.star.uno.UnoRuntime; 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski public class ContextMenuInterceptor implements XContextMenuInterceptor { 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski /** 33*b1cdbd2cSJim Jagielski *Description of the Method 34*b1cdbd2cSJim Jagielski * 35*b1cdbd2cSJim Jagielski *@param args Description of Parameter 36*b1cdbd2cSJim Jagielski *@since 37*b1cdbd2cSJim Jagielski */ main(String args[])38*b1cdbd2cSJim Jagielski public static void main(String args[]) 39*b1cdbd2cSJim Jagielski { 40*b1cdbd2cSJim Jagielski try { 41*b1cdbd2cSJim Jagielski OfficeConnect aConnect = OfficeConnect.createConnection(); 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski com.sun.star.frame.XDesktop xDesktop = 44*b1cdbd2cSJim Jagielski (com.sun.star.frame.XDesktop)aConnect.createRemoteInstance( 45*b1cdbd2cSJim Jagielski com.sun.star.frame.XDesktop.class,"com.sun.star.frame.Desktop"); 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski // create a new test document 48*b1cdbd2cSJim Jagielski com.sun.star.frame.XComponentLoader xCompLoader = 49*b1cdbd2cSJim Jagielski (com.sun.star.frame.XComponentLoader)UnoRuntime.queryInterface( 50*b1cdbd2cSJim Jagielski com.sun.star.frame.XComponentLoader.class, xDesktop); 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski com.sun.star.lang.XComponent xComponent = 53*b1cdbd2cSJim Jagielski xCompLoader.loadComponentFromURL("private:factory/swriter", 54*b1cdbd2cSJim Jagielski "_blank", 0, new com.sun.star.beans.PropertyValue[0]); 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski // intialize the test document 57*b1cdbd2cSJim Jagielski com.sun.star.frame.XFrame xFrame = null; 58*b1cdbd2cSJim Jagielski { 59*b1cdbd2cSJim Jagielski com.sun.star.text.XTextDocument xDoc =(com.sun.star.text.XTextDocument) 60*b1cdbd2cSJim Jagielski UnoRuntime.queryInterface(com.sun.star.text.XTextDocument.class, 61*b1cdbd2cSJim Jagielski xComponent); 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski 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!"); 64*b1cdbd2cSJim Jagielski xDoc.getText().setString(infoMsg); 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski // ensure that the document content is optimal visible 67*b1cdbd2cSJim Jagielski com.sun.star.frame.XModel xModel = 68*b1cdbd2cSJim Jagielski (com.sun.star.frame.XModel)UnoRuntime.queryInterface( 69*b1cdbd2cSJim Jagielski com.sun.star.frame.XModel.class, xDoc); 70*b1cdbd2cSJim Jagielski // get the frame for later usage 71*b1cdbd2cSJim Jagielski xFrame = xModel.getCurrentController().getFrame(); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski com.sun.star.view.XViewSettingsSupplier xViewSettings = 74*b1cdbd2cSJim Jagielski (com.sun.star.view.XViewSettingsSupplier)UnoRuntime.queryInterface( 75*b1cdbd2cSJim Jagielski com.sun.star.view.XViewSettingsSupplier.class, xModel.getCurrentController()); 76*b1cdbd2cSJim Jagielski xViewSettings.getViewSettings().setPropertyValue( 77*b1cdbd2cSJim Jagielski "ZoomType", new Short((short)0)); 78*b1cdbd2cSJim Jagielski } 79*b1cdbd2cSJim Jagielski // test document will be closed later 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski // reuse the frame 82*b1cdbd2cSJim Jagielski com.sun.star.frame.XController xController = xFrame.getController(); 83*b1cdbd2cSJim Jagielski if ( xController != null ) { 84*b1cdbd2cSJim Jagielski com.sun.star.ui.XContextMenuInterception xContextMenuInterception = 85*b1cdbd2cSJim Jagielski (com.sun.star.ui.XContextMenuInterception)UnoRuntime.queryInterface( 86*b1cdbd2cSJim Jagielski com.sun.star.ui.XContextMenuInterception.class, xController ); 87*b1cdbd2cSJim Jagielski if( xContextMenuInterception != null ) { 88*b1cdbd2cSJim Jagielski ContextMenuInterceptor aContextMenuInterceptor = new ContextMenuInterceptor(); 89*b1cdbd2cSJim Jagielski com.sun.star.ui.XContextMenuInterceptor xContextMenuInterceptor = 90*b1cdbd2cSJim Jagielski (com.sun.star.ui.XContextMenuInterceptor)UnoRuntime.queryInterface( 91*b1cdbd2cSJim Jagielski com.sun.star.ui.XContextMenuInterceptor.class, aContextMenuInterceptor ); 92*b1cdbd2cSJim Jagielski xContextMenuInterception.registerContextMenuInterceptor( xContextMenuInterceptor ); 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski 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!"); 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski java.io.BufferedReader reader 97*b1cdbd2cSJim Jagielski = new java.io.BufferedReader(new java.io.InputStreamReader(System.in)); 98*b1cdbd2cSJim Jagielski reader.read(); 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski xContextMenuInterception.releaseContextMenuInterceptor( 101*b1cdbd2cSJim Jagielski xContextMenuInterceptor ); 102*b1cdbd2cSJim Jagielski System.out.println( " ... context menu interceptor removed!" ); 103*b1cdbd2cSJim Jagielski } 104*b1cdbd2cSJim Jagielski } 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski // close test document 107*b1cdbd2cSJim Jagielski com.sun.star.util.XCloseable xCloseable = (com.sun.star.util.XCloseable) 108*b1cdbd2cSJim Jagielski UnoRuntime.queryInterface(com.sun.star.util.XCloseable.class, 109*b1cdbd2cSJim Jagielski xComponent ); 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski if (xCloseable != null ) { 112*b1cdbd2cSJim Jagielski xCloseable.close(false); 113*b1cdbd2cSJim Jagielski } else 114*b1cdbd2cSJim Jagielski { 115*b1cdbd2cSJim Jagielski xComponent.dispose(); 116*b1cdbd2cSJim Jagielski } 117*b1cdbd2cSJim Jagielski } 118*b1cdbd2cSJim Jagielski catch ( com.sun.star.uno.RuntimeException ex ) { 119*b1cdbd2cSJim Jagielski // something strange has happend! 120*b1cdbd2cSJim Jagielski System.out.println( " Sample caught exception! " + ex ); 121*b1cdbd2cSJim Jagielski System.exit(1); 122*b1cdbd2cSJim Jagielski } 123*b1cdbd2cSJim Jagielski catch ( java.lang.Exception ex ) { 124*b1cdbd2cSJim Jagielski // catch java exceptions and do something useful 125*b1cdbd2cSJim Jagielski System.out.println( " Sample caught exception! " + ex ); 126*b1cdbd2cSJim Jagielski System.exit(1); 127*b1cdbd2cSJim Jagielski } 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski System.out.println(" ... exit!\n"); 130*b1cdbd2cSJim Jagielski System.exit( 0 ); 131*b1cdbd2cSJim Jagielski } 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski /** 134*b1cdbd2cSJim Jagielski *Description of the Method 135*b1cdbd2cSJim Jagielski * 136*b1cdbd2cSJim Jagielski *@param args Description of Parameter 137*b1cdbd2cSJim Jagielski *@since 138*b1cdbd2cSJim Jagielski */ notifyContextMenuExecute( com.sun.star.ui.ContextMenuExecuteEvent aEvent )139*b1cdbd2cSJim Jagielski public ContextMenuInterceptorAction notifyContextMenuExecute( 140*b1cdbd2cSJim Jagielski com.sun.star.ui.ContextMenuExecuteEvent aEvent ) throws RuntimeException { 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski try { 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski // Retrieve context menu container and query for service factory to 145*b1cdbd2cSJim Jagielski // create sub menus, menu entries and separators 146*b1cdbd2cSJim Jagielski com.sun.star.container.XIndexContainer xContextMenu = aEvent.ActionTriggerContainer; 147*b1cdbd2cSJim Jagielski com.sun.star.lang.XMultiServiceFactory xMenuElementFactory = 148*b1cdbd2cSJim Jagielski (com.sun.star.lang.XMultiServiceFactory)UnoRuntime.queryInterface( 149*b1cdbd2cSJim Jagielski com.sun.star.lang.XMultiServiceFactory.class, xContextMenu ); 150*b1cdbd2cSJim Jagielski if ( xMenuElementFactory != null ) { 151*b1cdbd2cSJim Jagielski // create root menu entry and sub menu 152*b1cdbd2cSJim Jagielski com.sun.star.beans.XPropertySet xRootMenuEntry = 153*b1cdbd2cSJim Jagielski (XPropertySet)UnoRuntime.queryInterface( 154*b1cdbd2cSJim Jagielski com.sun.star.beans.XPropertySet.class, 155*b1cdbd2cSJim Jagielski xMenuElementFactory.createInstance( "com.sun.star.ui.ActionTrigger" )); 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski // create a line separator for our new help sub menu 158*b1cdbd2cSJim Jagielski com.sun.star.beans.XPropertySet xSeparator = 159*b1cdbd2cSJim Jagielski (com.sun.star.beans.XPropertySet)UnoRuntime.queryInterface( 160*b1cdbd2cSJim Jagielski com.sun.star.beans.XPropertySet.class, 161*b1cdbd2cSJim Jagielski xMenuElementFactory.createInstance( "com.sun.star.ui.ActionTriggerSeparator" )); 162*b1cdbd2cSJim Jagielski 163*b1cdbd2cSJim Jagielski Short aSeparatorType = new Short( ActionTriggerSeparatorType.LINE ); 164*b1cdbd2cSJim Jagielski xSeparator.setPropertyValue( "SeparatorType", (Object)aSeparatorType ); 165*b1cdbd2cSJim Jagielski 166*b1cdbd2cSJim Jagielski // query sub menu for index container to get access 167*b1cdbd2cSJim Jagielski com.sun.star.container.XIndexContainer xSubMenuContainer = 168*b1cdbd2cSJim Jagielski (com.sun.star.container.XIndexContainer)UnoRuntime.queryInterface( 169*b1cdbd2cSJim Jagielski com.sun.star.container.XIndexContainer.class, 170*b1cdbd2cSJim Jagielski xMenuElementFactory.createInstance( 171*b1cdbd2cSJim Jagielski "com.sun.star.ui.ActionTriggerContainer" )); 172*b1cdbd2cSJim Jagielski 173*b1cdbd2cSJim Jagielski // intialize root menu entry 174*b1cdbd2cSJim Jagielski xRootMenuEntry.setPropertyValue( "Text", new String( "Help" )); 175*b1cdbd2cSJim Jagielski xRootMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5410" )); 176*b1cdbd2cSJim Jagielski xRootMenuEntry.setPropertyValue( "HelpURL", new String( "5410" )); 177*b1cdbd2cSJim Jagielski xRootMenuEntry.setPropertyValue( "SubContainer", (Object)xSubMenuContainer ); 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski // create menu entries for the new sub menu 180*b1cdbd2cSJim Jagielski 181*b1cdbd2cSJim Jagielski // intialize help/content menu entry 182*b1cdbd2cSJim Jagielski XPropertySet xMenuEntry = (XPropertySet)UnoRuntime.queryInterface( 183*b1cdbd2cSJim Jagielski XPropertySet.class, xMenuElementFactory.createInstance( 184*b1cdbd2cSJim Jagielski "com.sun.star.ui.ActionTrigger" )); 185*b1cdbd2cSJim Jagielski 186*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "Text", new String( "Content" )); 187*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5401" )); 188*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "HelpURL", new String( "5401" )); 189*b1cdbd2cSJim Jagielski 190*b1cdbd2cSJim Jagielski // insert menu entry to sub menu 191*b1cdbd2cSJim Jagielski xSubMenuContainer.insertByIndex( 0, (Object)xMenuEntry ); 192*b1cdbd2cSJim Jagielski 193*b1cdbd2cSJim Jagielski // intialize help/help agent 194*b1cdbd2cSJim Jagielski xMenuEntry = (com.sun.star.beans.XPropertySet)UnoRuntime.queryInterface( 195*b1cdbd2cSJim Jagielski com.sun.star.beans.XPropertySet.class, 196*b1cdbd2cSJim Jagielski xMenuElementFactory.createInstance( 197*b1cdbd2cSJim Jagielski "com.sun.star.ui.ActionTrigger" )); 198*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "Text", new String( "Help Agent" )); 199*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5962" )); 200*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "HelpURL", new String( "5962" )); 201*b1cdbd2cSJim Jagielski 202*b1cdbd2cSJim Jagielski // insert menu entry to sub menu 203*b1cdbd2cSJim Jagielski xSubMenuContainer.insertByIndex( 1, (Object)xMenuEntry ); 204*b1cdbd2cSJim Jagielski 205*b1cdbd2cSJim Jagielski // intialize help/tips 206*b1cdbd2cSJim Jagielski xMenuEntry = (com.sun.star.beans.XPropertySet)UnoRuntime.queryInterface( 207*b1cdbd2cSJim Jagielski com.sun.star.beans.XPropertySet.class, 208*b1cdbd2cSJim Jagielski xMenuElementFactory.createInstance( 209*b1cdbd2cSJim Jagielski "com.sun.star.ui.ActionTrigger" )); 210*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "Text", new String( "Tips" )); 211*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5404" )); 212*b1cdbd2cSJim Jagielski xMenuEntry.setPropertyValue( "HelpURL", new String( "5404" )); 213*b1cdbd2cSJim Jagielski 214*b1cdbd2cSJim Jagielski // insert menu entry to sub menu 215*b1cdbd2cSJim Jagielski xSubMenuContainer.insertByIndex( 2, (Object)xMenuEntry ); 216*b1cdbd2cSJim Jagielski 217*b1cdbd2cSJim Jagielski // add separator into the given context menu 218*b1cdbd2cSJim Jagielski xContextMenu.insertByIndex( 0, (Object)xSeparator ); 219*b1cdbd2cSJim Jagielski 220*b1cdbd2cSJim Jagielski // add new sub menu into the given context menu 221*b1cdbd2cSJim Jagielski xContextMenu.insertByIndex( 0, (Object)xRootMenuEntry ); 222*b1cdbd2cSJim Jagielski 223*b1cdbd2cSJim Jagielski // The controller should execute the modified context menu and stop notifying other 224*b1cdbd2cSJim Jagielski // interceptors. 225*b1cdbd2cSJim Jagielski return com.sun.star.ui.ContextMenuInterceptorAction.EXECUTE_MODIFIED; 226*b1cdbd2cSJim Jagielski } 227*b1cdbd2cSJim Jagielski } 228*b1cdbd2cSJim Jagielski catch ( com.sun.star.beans.UnknownPropertyException ex ) { 229*b1cdbd2cSJim Jagielski // do something useful 230*b1cdbd2cSJim Jagielski // we used a unknown property 231*b1cdbd2cSJim Jagielski } 232*b1cdbd2cSJim Jagielski catch ( com.sun.star.lang.IndexOutOfBoundsException ex ) { 233*b1cdbd2cSJim Jagielski // do something useful 234*b1cdbd2cSJim Jagielski // we used an invalid index for accessing a container 235*b1cdbd2cSJim Jagielski } 236*b1cdbd2cSJim Jagielski catch ( com.sun.star.uno.Exception ex ) { 237*b1cdbd2cSJim Jagielski // something strange has happend! 238*b1cdbd2cSJim Jagielski } 239*b1cdbd2cSJim Jagielski catch ( java.lang.Exception ex ) { 240*b1cdbd2cSJim Jagielski // catch java exceptions and something useful 241*b1cdbd2cSJim Jagielski } 242*b1cdbd2cSJim Jagielski 243*b1cdbd2cSJim Jagielski return com.sun.star.ui.ContextMenuInterceptorAction.IGNORED; 244*b1cdbd2cSJim Jagielski } 245*b1cdbd2cSJim Jagielski } 246