org.omegat.gui.main

Interface IMainWindow

All Known Implementing Classes:

ConsoleWindow, MainWindow

public interface IMainWindow

Interface for access to main window functionality.

Method Summary

Modifier and Type	Method and Description
void	addDockable(com.vlsolutions.swing.docking.Dockable pane) Add new dockable pane into application frame.
void	displayErrorRB(java.lang.Throwable ex, java.lang.String errorKey, java.lang.Object... params) Display error.
void	displayWarningRB(java.lang.String warningKey, java.lang.Object... params) Display warning.
void	displayWarningRB(java.lang.String warningKey, java.lang.String supercedesKey, java.lang.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.
java.awt.Font	getApplicationFont() Get main application font.
javax.swing.JFrame	getApplicationFrame() Get application frame.
java.awt.Cursor	getCursor() Retrieves current cursor of window
IMainMenu	getMainMenu() Retrieve main manu instance.
void	lockUI() Lock UI for long-term operations.
void	setCursor(java.awt.Cursor cursor) Sets cursor of window
int	showConfirmDialog(java.lang.Object message, java.lang.String title, int optionType, int messageType) shows a confirm dialog.
void	showErrorDialogRB(java.lang.String title, java.lang.String message, java.lang.Object... args) Show message in an ErrorDialog
void	showLengthMessage(java.lang.String messageText) Show message in length label.
void	showLockInsertMessage(java.lang.String messageText, java.lang.String toolTip) Show message indicating the state of the Lock cursor and Insert/overwrite mode
void	showMessageDialog(java.lang.String message) Shows message to user
void	showProgressMessage(java.lang.String messageText) Show message in progress bar.
void	showStatusMessageRB(java.lang.String messageKey, java.lang.Object... params) Show message in status bar from resource bundle by key.
void	showTimedStatusMessageRB(java.lang.String messageKey, java.lang.Object... params) Same as showStatusMessageRB(String, Object...) but this will clear the message after ten seconds.
void	unlockUI() Unlock UI after locking.

Method Detail

getApplicationFrame

javax.swing.JFrame getApplicationFrame()

Get application frame.

lockUI

void lockUI()

Lock UI for long-term operations.

unlockUI

void unlockUI()

Unlock UI after locking.

getApplicationFont

java.awt.Font getApplicationFont()

Get main application font.

showStatusMessageRB

void showStatusMessageRB(java.lang.String messageKey,
                         java.lang.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(java.lang.String messageKey,
                              java.lang.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(java.lang.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(java.lang.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(java.lang.String messageText,
                           java.lang.String toolTip)

Show message indicating the state of the Lock cursor and Insert/overwrite mode

Parameters:

messageText - message text

displayWarningRB

void displayWarningRB(java.lang.String warningKey,
                      java.lang.Object... params)

Display warning.

Parameters:

warningKey - warning message key in resource bundle

params - warning text parameters

displayWarningRB

void displayWarningRB(java.lang.String warningKey,
                      java.lang.String supercedesKey,
                      java.lang.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(java.lang.Throwable ex,
                    java.lang.String errorKey,
                    java.lang.Object... params)

Display error.

Parameters:

ex - exception to show

errorKey - error message key in resource bundle

params - error text parameters

showErrorDialogRB

void showErrorDialogRB(java.lang.String title,
                       java.lang.String message,
                       java.lang.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(java.lang.Object message,
                      java.lang.String title,
                      int optionType,
                      int messageType)
               throws java.awt.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:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

showMessageDialog

void showMessageDialog(java.lang.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(java.awt.Cursor cursor)

Sets cursor of window

Parameters:

cursor - the new cursor

getCursor

java.awt.Cursor getCursor()

Retrieves current cursor of window

Returns:

the current cursor

getMainMenu

IMainMenu getMainMenu()

Retrieve main manu instance.