com.spss.psapi.extensions.ui.spi

Interface ActionHandler



  • public interface ActionHandler
    Defines the functionality associated with an action handler. A single handler is constructed for each extension object window. The implementing class must declare a no-argument constructor. For action listeners associated with actions defined on the main window, the path of the implementing class is specified in the "actionHandler" attribute of the extension-wide UserInterface element in the extension.xml file. For action listeners associated with nodes and outputs, the path of the implementing class is specified in the "actionHandler" attribute of the relevant UserInterface element in the extension.xml file. However, new extensions that need a different handler for each node or output should implement the ExtensionObjectUIDelegate instead of this interface.
    Since:
    PSAPI 11.1
    Version:
    1.0
    Author:
    Julian Clinton
    See Also:
    ExtensionObjectUIDelegate
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void handleAction(java.lang.String actionId, NativeWindowHandle windowHandle, ManagedSession managedSession)
      Invoked when an extension-defined menu option or tool bar tool is invoked.
    • Method Detail

      • handleAction

        void handleAction(java.lang.String actionId,
                        NativeWindowHandle windowHandle,
                        ManagedSession managedSession)
        Invoked when an extension-defined menu option or tool bar tool is invoked. The handler is passed the action ID, the owner window and the managed session. For actions defined on extension objects (such as extension nodes, document- and model outputs), the window handle will be an instance of ExtensionObjectWindowHandle which may be used to access the underlying extension object.
        Parameters:
        actionId - the action identifier defined by the extension
        windowHandle - the handle of the window through which the action was invoked
        managedSession - the ManagedSession

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.