Package xal.extension.application

Interface XalDocumentView

All Superinterfaces:
RootPaneContainer
All Known Implementing Classes:
AcceleratorWindow, DefaultAcceleratorWindow, DefaultXalWindow, XalInternalWindow, XalWindow
public interface XalDocumentView extends RootPaneContainer
Interface of XAL windows.

  • Method Details

    • showWindow

      void showWindow()
      Show this window. Make it visible (de-iconify if necessary) and bring it to the front.

    • hideWindow

      void hideWindow()
      Iconify this window.

    • getLocation

      Point getLocation()
      get the view's location

    • getLocationOnScreen

      Point getLocationOnScreen()
      get the view's location relative to the screen

    • setLocation

      void setLocation(Point location)
      set the view's location

    • setVisible

      void setVisible(boolean state)
      set the view's visibility

    • isVisible

      boolean isVisible()
      determine the view's visibility

    • getJMenuBar

      JMenuBar getJMenuBar()
      get the view's menu bar

    • setJMenuBar

      void setJMenuBar(JMenuBar menuBar)

    • getToolBar

      JToolBar getToolBar()
      Get the toolbar associated with this window.
      Returns:
      This window's toolbar or null if none was added.

    • captureAsImage

      void captureAsImage()
      Capture the window as an image.

    • displayConfirmDialog

      int displayConfirmDialog(String title, String message)
      Display a confirmation dialog with a title and message
      Parameters:
      title - The title of the dialog
      message - The message to display
      Returns:
      YES_OPTION or NO_OPTION

    • displayWarning

      void displayWarning(String aTitle, String message)
      Display a warning dialog box and provide an audible alert.
      Parameters:
      aTitle - Title of the warning dialog box.
      message - The warning message to appear in the warning dialog box.

    • displayWarning

      void displayWarning(Exception exception)
      Display a warning dialog box showing information about an exception that has been thrown and provide an audible alert.
      Parameters:
      exception - The exception whose description is being displayed.

    • displayWarning

      void displayWarning(String aTitle, String prefix, Exception exception)
      Display a warning dialog box with information about the exception and provide an audible alert. This method allows clarification about the consequences of the exception (e.g. "Save Failed:").
      Parameters:
      aTitle - Title of the warning dialog box.
      prefix - Text that should appear in the dialog box before the exception messasge.
      exception - The exception about which the warning dialog is displayed.

    • displayError

      void displayError(String aTitle, String message)
      Display an error dialog box and provide an audible alert.
      Parameters:
      aTitle - Title of the warning dialog box.
      message - The warning message to appear in the warning dialog box.

    • displayError

      void displayError(Exception exception)
      Display an error dialog box with information about the exception and provide an audible alert.
      Parameters:
      exception - The exception about which the warning dialog is displayed.

    • displayError

      void displayError(String aTitle, String prefix, Exception exception)
      Display an error dialog box with information about the exception and provide an audible alert. This method allows clarification about the consequences of the exception (e.g. "Save Failed:").
      Parameters:
      aTitle - Title of the warning dialog box.
      prefix - Text that should appear in the dialog box before the exception messasge.
      exception - The exception about which the warning dialog is displayed.