com.nomagic.magicdraw.core

Class GUILog

java.lang.Object

com.nomagic.magicdraw.core.GUILog

@OpenApiAll
public class GUILog
extends java.lang.Object

Utility class for displaying messages, questions, warnings and dialogs. It also used to output some text into Message Window.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GUILog.DefaultURLActionHandler Default implementation for URLActionHandler
static interface	GUILog.URLActionHandler An URL handler

Constructor Summary

Constructors

Constructor and Description
GUILog()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHyperlinkedText(java.lang.String text, java.util.Map<java.lang.String,java.lang.Runnable> callbacks) Display text with hyperlinks.
static java.util.Map<java.lang.String,java.lang.Runnable>	addURLCallBack(java.util.Map<java.lang.String,java.lang.Runnable> map, java.lang.String string, java.lang.String href) Adds callback to open href to the map.
void	clearLog() Clear message window.
void	clearMessageWindow() Clear message window.
static java.lang.String	createActionURL(NMAction action) An utility method to create URL to some action.
static java.lang.String	createActionURLWithText(NMAction action) An utility method to create URL to some action with
static java.lang.String	createActionURLWithText(NMAction action, java.lang.String text) An utility method to create URL to some action with
java.lang.String	getLoggedMessages() An utility method get all logged messages (This GUILog class provides a method to get the LogDialog, but the LogDialog is not part of the OpenAPI and therefore not accessible by code that will want to use it.)
void	log(Notification notification, boolean openWindow) Logs notification
void	log(java.lang.String msg) Writes message to message window.
void	log(java.lang.String msg, boolean open) Writes message to log window.
void	logNotification(java.lang.String title, java.lang.String text, HRefRunnable[] actions, NotificationSeverity severity, Notification.Context context) Logs notification
void	logNotification(java.lang.String title, java.lang.String text, NotificationSeverity severity, Notification.Context context) Logs notification
void	openLog() Opens message window.
void	openMessageWindow() Opens message window.
boolean	showCustomizedQuestion(java.lang.String msg, java.lang.String okLabelKey, java.lang.String cancelLabelKey, java.lang.String title, java.lang.String icon) Show customized Cancel/Ok question in a model dialog
void	showError(java.awt.Dialog parent, java.lang.String message, java.lang.Throwable exc) Method shows Error and stack trace dialog
void	showError(java.awt.Frame parent, java.lang.String msg) Method shows Error dialog.
void	showError(java.awt.Frame parent, java.lang.String msg, java.lang.String title) Shows error dialog
void	showError(java.awt.Frame parent, java.lang.String message, java.lang.Throwable exc) Method shows Error and stack trace dialog.
void	showError(java.lang.String msg) Shows the error dialog with given message
void	showError(java.lang.String message, java.lang.Throwable exc) Method shows Error and stack trace dialog
void	showErrorWithHelp(java.lang.String message, java.lang.String helpID) Shows the error dialog with given message.
int	showErrorWithRetry(java.lang.String message, java.lang.String title, java.lang.Throwable exp) Method shows Error and stack trace dialog with Submit, Export, Cancel and Retry buttons.
void	showHTMLMessage(java.lang.String msg, GUILog.URLActionHandler handler) Shows the message dialog with given message.
void	showHTMLMessage(java.lang.String msg, java.lang.String helpID, GUILog.URLActionHandler handler) Shows the message dialog with given message.
void	showHTMLMessage(java.lang.String msg, java.lang.String title, java.lang.String helpID, GUILog.URLActionHandler handler) Shows the message dialog with given message.
void	showHTMLMessage(java.lang.String msg, java.lang.String title, java.lang.String helpID, GUILog.URLActionHandler handler, java.lang.String icon) Shows the message dialog with given message.
void	showMessage(java.awt.Dialog parent, java.lang.String msg) Shows the message dialog with the given message.
void	showMessage(java.lang.String msg) Shows the message dialog with given message.
void	showMessage(java.lang.String msg, java.lang.String helpID) Shows the message dialog with the given message.
boolean	showMessage(java.lang.String msg, java.lang.String checkBoxMsg, boolean checkBoxValue) Shows the message dialog with given message.
void	showMessage(java.lang.String msg, java.lang.String title, java.lang.String helpID) Shows the message dialog with given message.
void	showMessage(java.lang.String msg, java.lang.String title, java.lang.String helpID, java.lang.String icon) Shows the message dialog with given message.
void	showMessageWithShowNextTime(java.lang.String msg, java.lang.String property_id) Shows the message dialog with given message and with label to show next time.
void	showOutOfMemoryError(java.lang.String message) Display out of memory error.
boolean	showQuestion(java.lang.String msg) Shows the yes-no dialog dialog with given message.
int	showQuestion(java.lang.String msg, boolean cancel) Shows the yes-no dialog dialog with given message.
int	showQuestion(java.lang.String msg, boolean cancel, java.lang.String dialogTitle) Shows the yes-no dialog with given message.
int	showQuestion(java.lang.String msg, boolean cancel, java.lang.String dialogTitle, java.lang.String defaultAction) Shows the yes-no dialog with given message.
boolean	showQuestion(java.lang.String msg, java.lang.String helpID) Shows the yes-no-help dialog dialog with given message.
int	showQuestion(java.lang.String msg, java.lang.String yesLabel, java.lang.String noLabel, java.lang.String cancelLabel, java.lang.String icon) Shows dialogs with given button text
int	showQuestion(java.lang.String msg, java.lang.String yesLabel, java.lang.String noLabel, java.lang.String cancelLabel, java.lang.String title, java.lang.String icon) Shows dialogs with given button text
int	showQuestionForAll(java.lang.String msg) Shows the yes-no-all dialog dialog with given message.
int	showQuestionForAll(java.lang.String msg, boolean cancel) Shows the yes-no-all dialog dialog with given message.
boolean	showQuestionOkCancel(java.lang.String msg) Shows the ok-cancel dialog dialog with given message.
boolean	showQuestionWithHelp(java.lang.String msg, java.lang.String notificationMsg, java.lang.String okLabelKey, java.lang.String title, java.lang.String helpID) Show customized Ok/Cancel/Help question in a modal dialog.
int	showRetryQuestion(java.lang.String msg) Shows the yes-no dialog dialog with given message
void	showWarning(java.lang.String msg) Shows the warning dialog with given message.
boolean	showWarning(java.lang.String msg, java.lang.String checkBoxMsg, boolean checkBoxValue) Shows the warning dialog with given message.
boolean	showWarningQuestion(java.lang.String msg, java.lang.String okLabelKey, java.lang.String title) Show customized Cancel/Ok question in a modal dialog.
boolean	showWarningQuestion(java.lang.String msg, java.lang.String okLabelKey, java.lang.String cancelLabelKey, java.lang.String title) Show customized Cancel/Ok question in a model dialog
boolean	showYesNoHelp(java.lang.String msg, java.lang.String helpID, java.lang.String title, java.lang.String icon) Shows the yes-no-help dialog with given message.
static java.lang.String	wrapForHeyperlinkText(java.lang.String text) Deprecated. Misspelled - use wrapForHyperlinkText(String)
static java.lang.String	wrapForHyperlinkText(java.lang.String str) Helper method to wrap given string into string suitable to use for hyperlinked log.
void	writeLogText(java.lang.String msg, boolean open) Writes message to log window.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GUILog

GUILog()

Method Detail

showError

public void showError(@CheckForNull
             java.awt.Frame parent,
             java.lang.String msg)

Method shows Error dialog.

Parameters:

parent - parent of error dialog

msg - Error message

showError

public void showError(@CheckForNull
             java.awt.Frame parent,
             java.lang.String msg,
             java.lang.String title)

Shows error dialog

Parameters:

parent - the parent of error dialog

msg - the error message

title - the dialog title

showError

public void showError(@CheckForNull
             java.awt.Frame parent,
             java.lang.String message,
             java.lang.Throwable exc)

Method shows Error and stack trace dialog.

Parameters:

parent - parent of error dialog

message - error message

exc - throwable provides stack trace to display

showError

public void showError(java.awt.Dialog parent,
             java.lang.String message,
             @CheckForNull
             java.lang.Throwable exc)

Method shows Error and stack trace dialog

Parameters:

parent - parent of error dialog

message - error message

exc - throwable provides stack trace to display

showError

public void showError(java.lang.String msg)

Shows the error dialog with given message

Parameters:

msg - error message

showError

public void showError(java.lang.String message,
             @CheckForNull
             java.lang.Throwable exc)

Method shows Error and stack trace dialog

Parameters:

message - error message.

exc - throwable provides stack trace to display

showErrorWithRetry

public int showErrorWithRetry(java.lang.String message,
                     java.lang.String title,
                     @Nonnull
                     java.lang.Throwable exp)

Method shows Error and stack trace dialog with Submit, Export, Cancel and Retry buttons. If Retry button is pressed then method returns DialogConstants.OK, if Cancel - DialogConstants.CANCEL.

Parameters:

message - error message

title - dialog title

exp - throwable provides stack trace to display

Returns:

pressed button identifier

showMessage

public void showMessage(java.lang.String msg)

Shows the message dialog with given message.

Parameters:

msg - message text

showHTMLMessage

public void showHTMLMessage(java.lang.String msg,
                   @CheckForNull
                   GUILog.URLActionHandler handler)

Shows the message dialog with given message.

Parameters:

msg - message text

handler - handler

showMessage

public void showMessage(java.lang.String msg,
               @CheckForNull
               java.lang.String helpID)

Shows the message dialog with the given message.

Parameters:

msg - message text

helpID - help item ID in help system

showHTMLMessage

public void showHTMLMessage(java.lang.String msg,
                   @CheckForNull
                   java.lang.String helpID,
                   @CheckForNull
                   GUILog.URLActionHandler handler)

Shows the message dialog with given message.

Parameters:

msg - message text.

helpID - help item ID in help system

handler - handler

showMessage

public void showMessage(java.lang.String msg,
               java.lang.String title,
               @CheckForNull
               java.lang.String helpID,
               java.lang.String icon)

Shows the message dialog with given message.

Parameters:

msg - message text

title - title of the dialog

helpID - help item ID in help system

icon - path to icon image (for example "/com/company/icon.gif")

showMessage

public void showMessage(java.lang.String msg,
               java.lang.String title,
               @CheckForNull
               java.lang.String helpID)

Shows the message dialog with given message.

Parameters:

msg - message text

title - title of the dialog

helpID - help item ID in help system

showHTMLMessage

public void showHTMLMessage(java.lang.String msg,
                   java.lang.String title,
                   @CheckForNull
                   java.lang.String helpID,
                   @CheckForNull
                   GUILog.URLActionHandler handler)

Shows the message dialog with given message.

Parameters:

msg - message text.

title - title of the dialog.

helpID - help item ID in help system

handler - url action handler

showHTMLMessage

public void showHTMLMessage(java.lang.String msg,
                   java.lang.String title,
                   @CheckForNull
                   java.lang.String helpID,
                   @CheckForNull
                   GUILog.URLActionHandler handler,
                   java.lang.String icon)

Shows the message dialog with given message.

Parameters:

msg - message text

title - title of the dialog

helpID - help item ID in help system

handler - url action handler

icon - path to icon image (for example "/com/company/icon.gif")

showMessage

public boolean showMessage(java.lang.String msg,
                  java.lang.String checkBoxMsg,
                  boolean checkBoxValue)

Shows the message dialog with given message. Shows another message with a checkbox before like "Show next time" option.

Parameters:

msg - message text.

checkBoxMsg - check box message

checkBoxValue - check box state

Returns:

check box state

showMessage

public void showMessage(java.awt.Dialog parent,
               java.lang.String msg)

Shows the message dialog with the given message.

Parameters:

parent - dialog parent

msg - message text

showMessageWithShowNextTime

public void showMessageWithShowNextTime(java.lang.String msg,
                               java.lang.String property_id)

Shows the message dialog with given message and with label to show next time.

Parameters:

msg - message text

property_id - registered invisible property id in the GeneralOptions with default value true

See Also:

GeneralOptionsGroup

showQuestion

public boolean showQuestion(java.lang.String msg)

Shows the yes-no dialog dialog with given message.

Parameters:

msg - message of question.

Returns:

true if answer was yes.

showQuestion

public int showQuestion(java.lang.String msg,
               boolean cancel)

Shows the yes-no dialog dialog with given message.

Parameters:

cancel - true if cancel button needed

msg - message of question.

Returns:

result constant form DialogConstants.

See Also:

DialogConstants

showQuestion

public int showQuestion(java.lang.String msg,
               boolean cancel,
               java.lang.String dialogTitle)

Shows the yes-no dialog with given message.

Parameters:

cancel - true if cancel button needed.

msg - message of question.

dialogTitle - title of the dialog.

Returns:

result constant form DialogConstants.

See Also:

DialogConstants

showQuestion

public int showQuestion(java.lang.String msg,
               boolean cancel,
               java.lang.String dialogTitle,
               @CheckForNull
               java.lang.String defaultAction)

Shows the yes-no dialog with given message.

Parameters:

cancel - true if cancel button needed.

msg - message of question.

dialogTitle - title of the dialog.

defaultAction - default selected action (button) in the question dialog.

Returns:

result constant form DialogConstants.

See Also:

DialogConstants

showQuestion

public int showQuestion(java.lang.String msg,
               java.lang.String yesLabel,
               java.lang.String noLabel,
               @CheckForNull
               java.lang.String cancelLabel,
               java.lang.String icon)

Shows dialogs with given button text

Parameters:

msg - message of question.

yesLabel - label key in dialog resources used instead of "Yes" text.

noLabel - label key in dialog resources used instead of "No" text.

cancelLabel - label key in dialog resources used instead of "Cancel" text, can be null.

icon - path to icon image (for example "/com/company/icon.gif")

Returns:

result constant form DialogConstants.

See Also:

DialogConstants

showQuestion

public int showQuestion(java.lang.String msg,
               java.lang.String yesLabel,
               java.lang.String noLabel,
               @CheckForNull
               java.lang.String cancelLabel,
               java.lang.String title,
               java.lang.String icon)

Shows dialogs with given button text

Parameters:

msg - message of question.

yesLabel - label key in dialog resources used instead of "Yes" text.

noLabel - label key in dialog resources used instead of "No" text.

cancelLabel - label key in dialog resources used instead of "Cancel" text, can be null.

title - title of the dialog.

icon - path to icon image (for example "/com/company/icon.gif")

Returns:

result constant form DialogConstants.

See Also:

DialogConstants

showQuestionOkCancel

public boolean showQuestionOkCancel(java.lang.String msg)

Shows the ok-cancel dialog dialog with given message.

Parameters:

msg - message of question.

Returns:

result constant form DialogConstants.

See Also:

DialogConstants

showQuestion

public boolean showQuestion(java.lang.String msg,
                   java.lang.String helpID)

Shows the yes-no-help dialog dialog with given message.

Parameters:

msg - message of question.

helpID - help item ID in help system

Returns:

true if answer was yes.

showYesNoHelp

public boolean showYesNoHelp(java.lang.String msg,
                    java.lang.String helpID,
                    java.lang.String title,
                    java.lang.String icon)

Shows the yes-no-help dialog with given message.

Parameters:

msg - message of question.

helpID - help item ID in help system

title - title

icon - path to icon image (for example "/com/company/icon.gif")

Returns:

true if answer was yes.

showQuestionForAll

public int showQuestionForAll(java.lang.String msg)

Shows the yes-no-all dialog dialog with given message.

Parameters:

msg - message text.

Returns:

result constant form DialogConstants.

See Also:

DialogConstants

showQuestionForAll

public int showQuestionForAll(java.lang.String msg,
                     boolean cancel)

Shows the yes-no-all dialog dialog with given message.

Parameters:

msg - message

cancel - true if cancel button needed

Returns:

one of the result constants in DialogConstants.

See Also:

DialogConstants

showRetryQuestion

public int showRetryQuestion(java.lang.String msg)

Shows the yes-no dialog dialog with given message

Parameters:

msg - Message Text

Returns:

one of the result constants in DialogConstants.

See Also:

DialogConstants

showWarning

public void showWarning(java.lang.String msg)

Shows the warning dialog with given message.

Parameters:

msg - warning text.

showWarning

public boolean showWarning(java.lang.String msg,
                  java.lang.String checkBoxMsg,
                  boolean checkBoxValue)

Shows the warning dialog with given message. Shows another message with a checkbox before like "Show next time" option.

Parameters:

msg - message text.

checkBoxMsg - check box message

checkBoxValue - check box state

Returns:

check box state

log

public void log(Notification notification,
       boolean openWindow)

Logs notification

Parameters:

notification - notification

openWindow - flag, if true opens notification window

logNotification

public void logNotification(@CheckForNull
                   java.lang.String title,
                   @CheckForNull
                   java.lang.String text,
                   NotificationSeverity severity,
                   Notification.Context context)

Logs notification

Parameters:

title - notification title

text - notification text

severity - notification severity

context - notification context

logNotification

public void logNotification(@CheckForNull
                   java.lang.String title,
                   @CheckForNull
                   java.lang.String text,
                   @CheckForNull
                   HRefRunnable[] actions,
                   NotificationSeverity severity,
                   Notification.Context context)

Logs notification

Parameters:

title - notification title

text - notification text

severity - notification severity

actions - list of actions

context - notification context

openMessageWindow

public void openMessageWindow()

Opens message window.

openLog

public void openLog()

Opens message window.

clearLog

public void clearLog()

Clear message window.

clearMessageWindow

public void clearMessageWindow()

Clear message window.

log

public void log(java.lang.String msg)

Writes message to message window.

Parameters:

msg - message text.

log

public void log(java.lang.String msg,
       boolean open)

Writes message to log window.

Parameters:

msg - message text.

open - true if closed window should be reopened.

writeLogText

public void writeLogText(java.lang.String msg,
                boolean open)

Writes message to log window.

Parameters:

msg - message text.

open - true if closed window should be reopened.

showOutOfMemoryError

public void showOutOfMemoryError(java.lang.String message)

Display out of memory error.

Parameters:

message - message

showErrorWithHelp

public void showErrorWithHelp(java.lang.String message,
                     java.lang.String helpID)

Shows the error dialog with given message.

Parameters:

message - message text

helpID - help item ID in help system

addHyperlinkedText

public void addHyperlinkedText(java.lang.String text,
                      java.util.Map<java.lang.String,java.lang.Runnable> callbacks)

Display text with hyperlinks. Each hyperlink must have entry in callback. Hyperlink in the text must be surrounded by <A> </A> tags. Callback is taken from the parameter callbacks using hyperlink text as key.

Parameters:

text - text with hyperlinks for example "blabla <A>hyperlink text to display</A> blabla." text can contain any number of href.

callbacks - map where is mapped hyperlinked text to the callback runnable. Map must contain String key and Runnable value.

See Also:

wrapForHyperlinkText(String)

wrapForHyperlinkText

public static java.lang.String wrapForHyperlinkText(java.lang.String str)

Helper method to wrap given string into string suitable to use for hyperlinked log. Simply wrap with <A></A> tags

Parameters:

str - target string for hyperlink

Returns:

string wrapped into <A></A>

See Also:

addHyperlinkedText(String, java.util.Map)

wrapForHeyperlinkText

@Deprecated
public static java.lang.String wrapForHeyperlinkText(java.lang.String text)

Deprecated. Misspelled - use wrapForHyperlinkText(String)

Wrap text for hyperlink

Parameters:

text - text to wrap

Returns:

wrapped text

addURLCallBack

public static java.util.Map<java.lang.String,java.lang.Runnable> addURLCallBack(@CheckForNull
                                                                java.util.Map<java.lang.String,java.lang.Runnable> map,
                                                                java.lang.String string,
                                                                java.lang.String href)

Adds callback to open href to the map. call back is used in addHyperlinkedText(String, Map)

Parameters:

map - map to which callback is

string - text fragment which is hyper link

href - reference

Returns:

map with url call backs

createActionURL

public static java.lang.String createActionURL(@Nonnull
                               NMAction action)

An utility method to create URL to some action.

Parameters:

action - action

Returns:

url to this action

createActionURLWithText

public static java.lang.String createActionURLWithText(NMAction action)

An utility method to create URL to some action with

Parameters:

action - action

Returns:

url to this action

createActionURLWithText

public static java.lang.String createActionURLWithText(NMAction action,
                                       java.lang.String text)

An utility method to create URL to some action with

Parameters:

action - action

text - url text

Returns:

url to this action

getLoggedMessages

public java.lang.String getLoggedMessages()

An utility method get all logged messages (This GUILog class provides a method to get the LogDialog, but the LogDialog is not part of the OpenAPI and therefore not accessible by code that will want to use it.)

Returns:

the messages visible in the LogDialog

showQuestionWithHelp

public boolean showQuestionWithHelp(java.lang.String msg,
                           java.lang.String notificationMsg,
                           java.lang.String okLabelKey,
                           java.lang.String title,
                           java.lang.String helpID)

Show customized Ok/Cancel/Help question in a modal dialog.

Parameters:

msg - message to show

notificationMsg - notification message to show if silent mode is on

okLabelKey - label key in DialogResource.properties for the Ok button

title - dialog title

helpID - help item ID in help system

Returns:

true - if Ok was pressed, false - if cancel.

showWarningQuestion

public boolean showWarningQuestion(java.lang.String msg,
                          java.lang.String okLabelKey,
                          java.lang.String title)

Show customized Cancel/Ok question in a modal dialog.

Parameters:

msg - message to show

okLabelKey - label key in DialogResource.properties for the Ok button

title - dialog title

Returns:

true - if Ok was pressed, false - if cancel.

showWarningQuestion

public boolean showWarningQuestion(java.lang.String msg,
                          java.lang.String okLabelKey,
                          java.lang.String cancelLabelKey,
                          java.lang.String title)

Show customized Cancel/Ok question in a model dialog

Parameters:

msg - the message to show

okLabelKey - the label key in DialogResource.properties for the Ok button

cancelLabelKey - the label key in DialogResource.properties for the Cancel button

title - the dialog title

Returns:

true if Ok was pressed, false otherwise

showCustomizedQuestion

public boolean showCustomizedQuestion(java.lang.String msg,
                             java.lang.String okLabelKey,
                             java.lang.String cancelLabelKey,
                             java.lang.String title,
                             java.lang.String icon)

Show customized Cancel/Ok question in a model dialog

Parameters:

msg - the message to show

okLabelKey - the label key in DialogResource.properties for the Ok button

cancelLabelKey - the label key in DialogResource.properties for the Cancel button

title - the dialog title

icon - the dialog icon

Returns:

true if Ok was pressed, false otherwise