qadevOOo/runner/helper/ContextMenuInterceptor.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ContextMenuInterceptor.java,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31
  32 package helper;
  33
  34 import com.sun.star.beans.UnknownPropertyException;
  35 import com.sun.star.beans.XPropertySet;
  36 import com.sun.star.container.XIndexContainer;
  37 import com.sun.star.lang.XMultiServiceFactory;
  38 import com.sun.star.ui.ActionTriggerSeparatorType;
  39 import com.sun.star.ui.ContextMenuInterceptorAction;
  40 import com.sun.star.ui.XContextMenuInterceptor;
  41 import com.sun.star.uno.UnoRuntime;
  42
  43 public class ContextMenuInterceptor implements XContextMenuInterceptor {
  44
  45     public ContextMenuInterceptorAction notifyContextMenuExecute(
  46             com.sun.star.ui.ContextMenuExecuteEvent aEvent ) throws RuntimeException {
  47         try {
  48             // Retrieve context menu container and query for service factory to
  49             // create sub menus, menu entries and separators
  50             XIndexContainer xContextMenu = aEvent.ActionTriggerContainer;
  51             XMultiServiceFactory xMenuElementFactory =
  52                     (XMultiServiceFactory)UnoRuntime.queryInterface(
  53                     XMultiServiceFactory.class, xContextMenu );
  54
  55             if ( xMenuElementFactory != null ) {
  56
  57                 // create root menu entry for sub menu and sub menu
  58                 XPropertySet xRootMenuEntry =
  59                         (XPropertySet)UnoRuntime.queryInterface(
  60                         XPropertySet.class,
  61                         xMenuElementFactory.createInstance("com.sun.star.ui.ActionTrigger" ));
  62
  63                 // create a line separator for our new help sub menu
  64                 XPropertySet xSeparator =
  65                         (XPropertySet)UnoRuntime.queryInterface(
  66                         XPropertySet.class,
  67                         xMenuElementFactory.createInstance("com.sun.star.ui.ActionTriggerSeparator" ) );
  68                 Short aSeparatorType = new Short( ActionTriggerSeparatorType.LINE );
  69                 xSeparator.setPropertyValue( "SeparatorType", (Object)aSeparatorType );
  70
  71                 // query sub menu for index container to get access
  72                 XIndexContainer xSubMenuContainer =
  73                         (XIndexContainer)UnoRuntime.queryInterface(
  74                         XIndexContainer.class,
  75                         xMenuElementFactory.createInstance("com.sun.star.ui.ActionTriggerContainer" ));
  76
  77                 // intialize root menu entry "Help"
  78                 xRootMenuEntry.setPropertyValue( "Text", new String( "Help" ));
  79                 xRootMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5410" ));
  80                 xRootMenuEntry.setPropertyValue( "HelpURL", new String( "5410" ));
  81                 xRootMenuEntry.setPropertyValue( "SubContainer", (Object)xSubMenuContainer );
  82
  83                 // create menu entries for the new sub menu
  84                 // intialize help/content menu entry
  85                 // entry "Content"
  86                 XPropertySet xMenuEntry = (XPropertySet)UnoRuntime.queryInterface(
  87                         XPropertySet.class, xMenuElementFactory.createInstance(
  88                         "com.sun.star.ui.ActionTrigger" ));
  89                 xMenuEntry.setPropertyValue( "Text", new String( "Content" ));
  90                 xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5401" ));
  91                 xMenuEntry.setPropertyValue( "HelpURL", new String( "5401" ));
  92
  93                 // insert menu entry to sub menu
  94                 xSubMenuContainer.insertByIndex( 0, (Object)xMenuEntry );
  95
  96                 // intialize help/help agent
  97                 // entry "Help Agent"
  98                 xMenuEntry = (XPropertySet)UnoRuntime.queryInterface(
  99                         XPropertySet.class,
 100                         xMenuElementFactory.createInstance("com.sun.star.ui.ActionTrigger" ));
 101                 xMenuEntry.setPropertyValue( "Text", new String( "Help Agent" ));
 102                 xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5962" ));
 103                 xMenuEntry.setPropertyValue( "HelpURL", new String( "5962" ));
 104
 105                 // insert menu entry to sub menu
 106                 xSubMenuContainer.insertByIndex( 1, (Object)xMenuEntry );
 107                 // intialize help/tips
 108                 // entry "Tips"
 109                 xMenuEntry = (XPropertySet)UnoRuntime.queryInterface(
 110                         XPropertySet.class,
 111                         xMenuElementFactory.createInstance("com.sun.star.ui.ActionTrigger" ));
 112                 xMenuEntry.setPropertyValue( "Text", new String( "Tips" ));
 113                 xMenuEntry.setPropertyValue( "CommandURL", new String( "slot:5404" ));
 114                 xMenuEntry.setPropertyValue( "HelpURL", new String( "5404" ));
 115
 116                 // insert menu entry to sub menu
 117                 xSubMenuContainer.insertByIndex( 2, (Object)xMenuEntry );
 118
 119                 // add separator into the given context menu
 120                 xContextMenu.insertByIndex( 1, (Object)xSeparator );
 121
 122                 // add new sub menu into the given context menu
 123                 xContextMenu.insertByIndex( 1, (Object)xRootMenuEntry );
 124
 125                 // The controller should execute the modified context menu and stop notifying other
 126                 // interceptors.
 127                 return ContextMenuInterceptorAction.EXECUTE_MODIFIED ;
 128             }
 129         } catch ( UnknownPropertyException ex ) {
 130             // do something useful
 131             // we used a unknown property
 132         } catch ( IndexOutOfBoundsException ex ) {
 133             // do something useful
 134             // we used an invalid index for accessing a container
 135         } catch ( Exception ex ) {
 136             // something strange has happend!
 137         } catch ( Throwable ex ) {
 138             // catch java exceptions and do something useful
 139         }
 140
 141         return ContextMenuInterceptorAction.IGNORED;
 142     }
 143 }