Package net.sf.jguiraffe.gui.platform.swing.builder.utils

Klasse SwingMessageOutput

java.lang.Object

net.sf.jguiraffe.gui.platform.swing.builder.utils.SwingMessageOutput

Alle implementierten Schnittstellen:

MessageOutput

public class SwingMessageOutput
extends Object
implements MessageOutput

A Swing specific implementation of the MessageOutput interface.

This implementation makes use of JOptionPane for displaying message boxes.

Version:

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

Autor:

Oliver Heger

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final int	NO_LINE_WRAP	Constant for a line length which disables line wrapping.

Von Schnittstelle geerbte Felder net.sf.jguiraffe.gui.builder.utils.MessageOutput

BTN_OK, BTN_OK_CANCEL, BTN_YES_NO, BTN_YES_NO_CANCEL, MESSAGE_ERROR, MESSAGE_INFO, MESSAGE_PLAIN, MESSAGE_QUESTION, MESSAGE_WARNING, RET_CANCEL, RET_NO, RET_OK, RET_YES

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
SwingMessageOutput()	Creates a new instance of SwingMessageOutput and sets a default maximum line length.
SwingMessageOutput(int maxLineLength)	Creates a new instance of SwingMessageOutput with the specified maximum message line length.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected int	convertButtonType(int type)	Converts the passed in button type into the corresponding option type used by JOptionPane.
protected int	convertMessageType(int type)	Converts the passed in message type into the corresponding type used by JOptionPane.
protected int	convertReturnValue(int value)	Converts the passed in return value from the JOptionPane to the corresponding RET_XXXX constant.
protected JDialog	createDialog(JOptionPane pane, Window parent, String title)	Creates the dialog from the option pane.
protected JOptionPane	createOptionPane(Window parent, Object message, String title, int messageType, int optionType)	Creates the option pane dialog for displaying the message box.
int	getMaximumLineLength()	Returns the maximum line length for the messages to be displayed.
int	show(Window parent, Object message, String title, int messageType, int buttonType)	Displays a message box.
protected Object	showPane(JOptionPane pane, JDialog dialog)	Displays the given option pane.

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

NO_LINE_WRAP

public static final int NO_LINE_WRAP

Constant for a line length which disables line wrapping. If this value is passed to the constructor, the message text is not wrapped into multiple lines.

Seit:

1.3

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

SwingMessageOutput

public SwingMessageOutput()

Creates a new instance of SwingMessageOutput and sets a default maximum line length.

SwingMessageOutput

public SwingMessageOutput(int maxLineLength)

Creates a new instance of SwingMessageOutput with the specified maximum message line length. Before the message is displayed, it is ensured that single lines do not exceed this maximum length; if necessary, the text is split into multiple lines. To disable line wrapping, the value NO_LINE_WRAP can be passed.

Parameter:

maxLineLength - the maximum length of a line for the message text (in characters); must be > 0

Löst aus:

IllegalArgumentException - if an invalid line length is passed in

Seit:

1.3

Methodendetails

getMaximumLineLength

public int getMaximumLineLength()

Returns the maximum line length for the messages to be displayed.

Gibt zurück:

the maximum line length

Seit:

1.3

show

public int show(Window parent,
 Object message,
 String title,
 int messageType,
 int buttonType)

Displays a message box.

Angegeben von:

show in Schnittstelle MessageOutput

Parameter:

parent - the parent window; this should be null or point to a Swing window

message - the message

title - the message box's title

messageType - the type of the message

buttonType - specifies the buttons to be displayed

Gibt zurück:

the pressed button

convertMessageType

protected int convertMessageType(int type)

Converts the passed in message type into the corresponding type used by JOptionPane.

Parameter:

type - the type to be converted

Gibt zurück:

the corresponding Swing constant

convertButtonType

protected int convertButtonType(int type)

Converts the passed in button type into the corresponding option type used by JOptionPane.

Parameter:

type - the type to be converted

Gibt zurück:

the corresponding Swing constant

convertReturnValue

protected int convertReturnValue(int value)

Converts the passed in return value from the JOptionPane to the corresponding RET_XXXX constant.

Parameter:

value - the return value from the option pane

Gibt zurück:

the corresponding RET_XXXX constant

createOptionPane

protected JOptionPane createOptionPane(Window parent,
 Object message,
 String title,
 int messageType,
 int optionType)

Creates the option pane dialog for displaying the message box.

Parameter:

parent - the parent window

message - the message

title - the title

messageType - the message type

optionType - the option type

Gibt zurück:

the option pane

showPane

protected Object showPane(JOptionPane pane,
 JDialog dialog)

Displays the given option pane. This method is called after the pane has been created and initialized.

Parameter:

pane - the pane to display

dialog - the dialog obtained from the option pane

Gibt zurück:

the return value of the pane (indicating the option selected by the user)

createDialog

protected JDialog createDialog(JOptionPane pane,
 Window parent,
 String title)

Creates the dialog from the option pane. This is the component that is to be displayed.

Parameter:

pane - the option pane

parent - the parent component

title - the dialog's title

Gibt zurück:

the dialog to display