Package org.omegat.gui.main

Interface IMainWindow

All Known Implementing Classes:
ConsoleWindow, MainWindow
public interface IMainWindow
Interface for access to main window functionality.

  • Method Details

    • getApplicationFrame

      JFrame getApplicationFrame()
      Get application frame.

    • lockUI

      void lockUI()
      Lock UI for long-term operations.

    • unlockUI

      void unlockUI()
      Unlock UI after locking.

    • getApplicationFont

      Font getApplicationFont()
      Get main application font.

    • showStatusMessageRB

      void showStatusMessageRB(@Nullable @Nullable String messageKey, Object... params)
      Show message in status bar from resource bundle by key.
      Parameters:
      messageKey - message key in resource bundle
      params - message parameters for formatting

    • showTimedStatusMessageRB

      void showTimedStatusMessageRB(String messageKey, Object... params)
      Same as showStatusMessageRB(String, Object...) but this will clear the message after ten seconds.
      Parameters:
      messageKey - message key in resource bundle
      params - message parameters for formatting

    • showProgressMessage

      void showProgressMessage(String messageText)
      Show message in progress bar. Progress bar shows the translation progress: nr. of segments/words etc translated/to do.
      Parameters:
      messageText - message text

    • showLengthMessage

      void showLengthMessage(String messageText)
      Show message in length label. Length label shows length (in nr of characters) of current segment
      Parameters:
      messageText - message text

    • showLockInsertMessage

      void showLockInsertMessage(String messageText, String toolTip)
      Show message indicating the state of the Lock cursor and Insert/overwrite mode
      Parameters:
      messageText - message text

    • displayWarningRB

      void displayWarningRB(String warningKey, Object... params)
      Display warning.
      Parameters:
      warningKey - warning message key in resource bundle
      params - warning text parameters

    • displayWarningRB

      void displayWarningRB(String warningKey, String supercedesKey, Object... params)
      Same as displayWarningRB(String, Object...) but this will close the previous dialog if the dialog is still open and the supplied supercedesKey matches the previous dialog's key.
      Parameters:
      warningKey - warning message key in resource bundle
      supercedesKey - the key of the warning dialog to close, if still open
      params - warning text parameters

    • displayErrorRB

      void displayErrorRB(Throwable ex, String errorKey, Object... params)
      Display error.
      Parameters:
      ex - exception to show
      errorKey - error message key in resource bundle
      params - error text parameters

    • showErrorDialogRB

      void showErrorDialogRB(String title, String message, Object... args)
      Show message in an ErrorDialog
      Parameters:
      message - message key in resource bundle of message that is to be displayed
      args - arguments of the resource bundle message
      title - title of dialog. message key in resource bundle of title that is to be displayed

    • showConfirmDialog

      int showConfirmDialog(Object message, String title, int optionType, int messageType) throws HeadlessException
      shows a confirm dialog. For a GUI main window, this can be implemented as JOptionPane.showConfirmDialog
      Parameters:
      message - the Object to display
      title - the title string for the dialog (can be null)
      optionType - an integer designating the JOptionPane options available on the dialog: YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION
      messageType - an integer designating the kind of message this is; primarily used to determine the icon from the pluggable Look and Feel: (JOptionPane ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE
      Returns:
      an integer indicating the option selected by the user
      Throws:
      HeadlessException - if GraphicsEnvironment.isHeadless returns true

    • showMessageDialog

      void showMessageDialog(String message)
      Shows message to user
      Parameters:
      message - the message to show

    • addDockable

      void addDockable(com.vlsolutions.swing.docking.Dockable pane)
      Add new dockable pane into application frame. This method called on application startup.
      Parameters:
      pane - dockable pane

    • setCursor

      void setCursor(Cursor cursor)
      Sets cursor of window
      Parameters:
      cursor - the new cursor

    • getCursor

      Cursor getCursor()
      Retrieves current cursor of window
      Returns:
      the current cursor

    • getSelectedText

      default String getSelectedText()

    • getMainMenu

      IMainMenu getMainMenu()
      Retrieve main manu instance.

    • getDesktop

      com.vlsolutions.swing.docking.DockingDesktop getDesktop()
      Retrieve main docking desktop.

    • resetDesktopLayout

      default void resetDesktopLayout()
      Restores the main window layout to the default values.

    • saveDesktopLayout

      default void saveDesktopLayout()
      Save the main window layout.