com.spss.psapi.extensions.ui.spi

Interface ExtensionObjectPanel



  • public interface ExtensionObjectPanel
    Defines the functionality associated with extension object panels. The implementing class must declare a no-argument constructor.
    Since:
    PSAPI 11.1
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void controlValuesApplied()
      Called to notify the panel that property control values should be applied back to the underlying object e.g. when the "OK" or "Apply" buttons have been pressed.
      void controlValuesReset()
      Called to notify the panel that property control values have been reset from the underlying object e.g. when the "Cancel" or "Reset" buttons have been pressed.
      void disposePanel()
      Called to notify the panel that the window which contains the component browser is being destroyed.
      void extensionObjectChanged()
      Called to notify the panel 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.lang.Object getHelpReference()
      Returns the help reference for this panel.
      javax.swing.JComponent getPrintableComponent()
      Returns the UI object that will be rendered in order to print the component.
      javax.swing.JComponent getUIComponent()
      Returns the UI object that will be used to display the extension component which will be added to the window.
      void initPanel(java.lang.String panelId, ExtensionObjectWindowHandle windowHandle, ManagedSession managedSession)
      Called after the panel has been created but before the panel has been added to the window or the window has been displayed.
      boolean isPrintable()
      Returns true if the panel contains a printable component, false otherwise.
    • Method Detail

      • initPanel

        void initPanel(java.lang.String panelId,
                     ExtensionObjectWindowHandle windowHandle,
                     ManagedSession managedSession)
        Called after the panel has been created but before the panel has been added to the window or the window has been displayed. This is the first method called on this object and should be used to initialise the panel components with the supplied extension object.
        Parameters:
        panelId - the id of the panel declared in the spec file
        windowHandle - the handle of the window that will contain this panel
        managedSession - the ManagedSession
      • getUIComponent

        javax.swing.JComponent getUIComponent()
        Returns the UI object that will be used to display the extension component which will be added to the window. It is expected that classes implementing this SPI will extend JComponent and so this method will simply return this.
        Returns:
        the UI object
      • isPrintable

        boolean isPrintable()
        Returns true if the panel contains a printable component, false otherwise. This allows the owner dialog to know whether printing options should be enabled.
        Returns:
        true if the panel contains a printable component
        See Also:
        getPrintableComponent()
      • getPrintableComponent

        javax.swing.JComponent getPrintableComponent()
        Returns the UI object that will be rendered in order to print the component. An implementation should return null if printing is not supported. This is called if the user invokes a Print or Print Preview operation.
        Returns:
        the UI object to be used for printing or null
        See Also:
        isPrintable()
      • getHelpReference

        java.lang.Object getHelpReference()
        Returns the help reference for this panel. An implementation should return null if there is no help associated with the panel.
        Returns:
        the help reference for this panel
      • controlValuesApplied

        void controlValuesApplied()
        Called to notify the panel that property control values should be applied back to the underlying object e.g. when the "OK" or "Apply" buttons have been pressed. This method is called before any system controls have applied their changes back to the object.

        While this method is active, no calls to extensionObjectChanged() will be made.

        See Also:
        extensionObjectChanged(), controlValuesReset()
      • controlValuesReset

        void controlValuesReset()
        Called to notify the panel that property control values have been reset from the underlying object e.g. when the "Cancel" or "Reset" buttons have been pressed.
        See Also:
        extensionObjectChanged(), controlValuesApplied()
      • extensionObjectChanged

        void extensionObjectChanged()
        Called to notify the panel 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. Note that any changes that would normally cause this method to be called are ignored if controlValuesApplied() has been called. This prevents unnecessary notification of changes that the panel already knows about.
        See Also:
        controlValuesApplied()
      • disposePanel

        void disposePanel()
        Called to notify the panel that the window which contains the component browser is being destroyed. This gives the browser an opportunity to free any resources than need to be freed explicitly. This is the last method called on this object.

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.