MessageOutput (JGUIraffe BOM 1.3.1 API)

All Known Implementing Classes:

NullMessageOutput, SwingMessageOutput
```
public interface MessageOutput
```
Definition of an interface for creating message boxes in a platform independent way.

This interface defines a main show() method to display a message box of a pre-defined type. The type is specified using one of the the constants defined by this interface. The method expects a title (as string) and an object representing the message to be displayed. From this object the toString() is called in order to obtain the message text to be displayed. Concrete implementations have to implement a certain amount of processing on the message text:
- The character '\n' should cause a newline in the message. That way messages with multiple lines can be created.
- A reasonable line wrapping should be performed to prevent that the message window becomes too wide or that parts of the message text are cut off.
In addition, this interface defines some constants for the buttons to be displayed in the constructed message window. For instance, it is possible to have just an OK button or specify that buttons for a YES/NO/CANCEL question are generated. The return value of the show() method indicates the pressed button.

Note that the show() method must be called in the UI thread! It lies in the responsibility of the caller to use the current GUISynchronizer to ensure that the invocation happens in the correct thread.

Concrete implementations will map the functionality provided by this interface to GUI library specific classes. A Swing related implementation for instance could use Swing's JOptionPane to provide the required functionality.
Version:

$Id: MessageOutput.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BTN_OK` Constant for the button type OK.
`static int`	`BTN_OK_CANCEL` Constant for the button type OK, CANCEL.
`static int`	`BTN_YES_NO` Constant for the button type YES, NO.
`static int`	`BTN_YES_NO_CANCEL` Constant for the button type YES, NO, CANCEL.
`static int`	`MESSAGE_ERROR` Constant for the message type ERROR.
`static int`	`MESSAGE_INFO` Constant for the message type INFO.
`static int`	`MESSAGE_PLAIN` Constant for the message type PLAIN.
`static int`	`MESSAGE_QUESTION` Constant for the message type QUESTION.
`static int`	`MESSAGE_WARNING` Constant for the message type WARNING.
`static int`	`RET_CANCEL` Constant for the return value CANCEL.
`static int`	`RET_NO` Constant for the return value NO.
`static int`	`RET_OK` Constant for the return value OK.
`static int`	`RET_YES` Constant for the return value YES.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`show(Window parent, Object message, String title, int messageType, int buttonType)` Displays a message box based on the given options.

- Field Detail
  - MESSAGE_ERROR
```
static final int MESSAGE_ERROR
```
    Constant for the message type ERROR.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_INFO
```
static final int MESSAGE_INFO
```
    Constant for the message type INFO.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_WARNING
```
static final int MESSAGE_WARNING
```
    Constant for the message type WARNING.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_QUESTION
```
static final int MESSAGE_QUESTION
```
    Constant for the message type QUESTION.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_PLAIN
```
static final int MESSAGE_PLAIN
```
    Constant for the message type PLAIN.
    
    See Also:
    
    Constant Field Values
  - BTN_OK
```
static final int BTN_OK
```
    Constant for the button type OK.
    
    See Also:
    
    Constant Field Values
  - BTN_OK_CANCEL
```
static final int BTN_OK_CANCEL
```
    Constant for the button type OK, CANCEL.
    
    See Also:
    
    Constant Field Values
  - BTN_YES_NO
```
static final int BTN_YES_NO
```
    Constant for the button type YES, NO.
    
    See Also:
    
    Constant Field Values
  - BTN_YES_NO_CANCEL
```
static final int BTN_YES_NO_CANCEL
```
    Constant for the button type YES, NO, CANCEL.
    
    See Also:
    
    Constant Field Values
  - RET_OK
```
static final int RET_OK
```
    Constant for the return value OK.
    
    See Also:
    
    Constant Field Values
  - RET_CANCEL
```
static final int RET_CANCEL
```
    Constant for the return value CANCEL.
    
    See Also:
    
    Constant Field Values
  - RET_YES
```
static final int RET_YES
```
    Constant for the return value YES. Note that this value is identical to the RET_OK return value. This is analogous to Swing.
    
    See Also:
    
    Constant Field Values
  - RET_NO
```
static final int RET_NO
```
    Constant for the return value NO.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - show
```
int show(Window parent,
         Object message,
         String title,
         int messageType,
         int buttonType)
```
    Displays a message box based on the given options. Please refer to the class comment for further details about the parameters and how they are interpreted.
    
    Parameters:
    
    parent - the parent window
    
    message - the message itself; can be an arbitrary object whose toString() method will be used to obtain the text to be displayed
    
    title - the message box's title
    
    messageType - the type of the message; this must be one the MESSAGE_XXXX constants
    
    buttonType - defines the buttons to be displayed; this must be one of the BTN_XXXX constants
    
    Returns:
    
    a flag for the button pressed by the user; this will be one of the RET_XXXX constants

Interface MessageOutput

Field Summary

Method Summary

Field Detail

MESSAGE_ERROR

MESSAGE_INFO

MESSAGE_WARNING

MESSAGE_QUESTION

MESSAGE_PLAIN

BTN_OK

BTN_OK_CANCEL

BTN_YES_NO

BTN_YES_NO_CANCEL

RET_OK

RET_CANCEL

RET_YES

RET_NO

Method Detail

show