com.spss.psapi.extensions.ui.spi

Interface ExtensionObjectFrame



  • public interface ExtensionObjectFrame
    Defines the functionality associated with extension object frame windows i.e. windows used to display with model or document outputs. The implementing class must declare a no-argument constructor. All methods are called from the Swing thread.
    Since:
    PSAPI 11.1
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void disposeFrame()
      Called to notify the window that the object associated with the window is being deleted.
      void extensionObjectChanged()
      Called to notify the window that the underlying object has been modified in some way e.g. a change to a property or a container, the execution status, cache state etc.
      java.awt.Frame getFrame()
      Returns the frame window represented by this object.
      void helpRequested(java.awt.Component component)
      Called to notify the window that the user has requested help e.g. using the F1 key.
      void initFrame(ExtensionObject object, ManagedSession managedSession)
      Called when the window containing the object is being initialised.
      boolean synchronizeExtensionObject()
      Called to notify the window that a request has been made to save or store the object associated with this frame e.g. via a context menu.
    • Method Detail

      • getFrame

        java.awt.Frame getFrame()
        Returns the frame window represented by this object. It is expected that classes implementing this SPI will extend JFrame or Frame and so the method will simply return this.
        Returns:
        the window Frame
      • initFrame

        void initFrame(ExtensionObject object,
                     ManagedSession managedSession)
        Called when the window containing the object is being initialised. The window itself will already have been created and can be accessed through the window handle. This should be used to initialise the window contents. This is the first method to be called on this object. The extension object will be an instance of a PSAPI-defined interface -- either Processor, ModelOutput, DocumentOutput or InteractiveOutput.
        Parameters:
        object - the extension object
        managedSession - the ManagedSession
      • helpRequested

        void helpRequested(java.awt.Component component)
        Called to notify the window that the user has requested help e.g. using the F1 key. The component is the one which most recently had focus.
        Parameters:
        component - the component which most recently had focus
      • synchronizeExtensionObject

        boolean synchronizeExtensionObject()
        Called to notify the window that a request has been made to save or store the object associated with this frame e.g. via a context menu. This allows the frame to ensure the object is in a consistent state before it is saved. If this method returns true then the operation that triggered the synchronization will be called, otherwise the operation will be aborted. Calling this method may result in a call of extensionObjectChanged().
        Returns:
        true if the save should proceed, false if the save should be cancelled
        See Also:
        extensionObjectChanged()
      • extensionObjectChanged

        void extensionObjectChanged()
        Called to notify the window that the underlying object has been modified in some way e.g. a change to a property or a container, the execution status, cache state etc.
      • disposeFrame

        void disposeFrame()
        Called to notify the window that the object associated with the window is being deleted. This allows the frame to perform any tidy-up operations that are needed. This is the last method called on this object.

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.