org.apache.fop.viewer
Class UserMessage


public class UserMessage

Klasse UserMessage ist ein utility zum Abfragen oder zum Informieren des Benutzers.
Eine Meldung besteht aus dem Identifikator (Suchschlüssel im Meldungspool), einem Dialogtitel, einem Buttonset und dem Meldungstext mit eventuellen Platzhaltern für die Parameter.

Author:
S. Gorkhover
Version: 18.03.1999
subject Weitere Ausgabemethoden: show(String, String) und show(String,String,Frame), MessageException unterstützen, Neue Klasse MessagesException zur Anzeige verwenden, Unicode
changed 23.04.99 Juergen.Verwohlt@jCatalog.com, 28.05.99 Juergen.Verwohlt@jCatalog.com, 09.06.99 Juergen.Verwohlt@jCatalog.com, 10.12.00 gears@apache.org

Field Summary
 final static intCANCEL
          Möglicher Rückgabewert @see ButtonDialog
 final static intNO
          Möglicher Rückgabewert @see ButtonDialog
 final static intSTYLE_NOBUTTON
          Wert für Setzten keines Buttons
 final static intSTYLE_Y
          Wert für Setzten von nur Ja-Button.
 final static intSTYLE_Y_N
          Wert für Setzten von Ja- und Nein-Buttons.
 final static intSTYLE_Y_N_C
          Wert für Setzten von Ja-, Nein-und Abbruch Buttons.
 final static intYES
          Möglicher Rückgabewert @see ButtonDialog

Method Summary
 (package private) static StringgetTitle(String strVal)
          Gibt den Title fürs Dialogfenster.
 (package private) static intgetValue(String fieldName)
          Liefert den Wert der über den Nemen übergebenen Klassenvariablen.
 (package private) static StringprepareMessage(String rawText, String[] par)
          Ersetzt die eventuellen Platzhalter durch die übergebenen Parameter
 static voidsetTranslator(Translator aRes)
           
 static intshow(String messageId, String[] parameterList, Exception anException, Frame parentFrame)
          Öffnet das Dialogfenster mit der Übersetzung der per Suchschlüssel übergebenen Meldung mit eingesetzten Parametern.
 static intshow(String messageId, String[] parameterList, Exception anException)
           
 static intshow(String messageId, String[] parameterList, Frame parentFrame)
           
 static intshow(String messageId, String[] parameterList)
           
 static intshow(String messageId, String parameter, Frame parentFrame)
           
 static intshow(String messageId, String parameter)
           
 static intshow(String messageId, Frame parentFrame)
           
 static intshow(String messageId)
           
 static intshow(String messageId, Exception anException, Frame aFrame)
           
 static intshow(String messageId, Exception anException)
           
 static intshow(Exception anException, Frame aFrame)
           

Field Detail

CANCEL

public final static int CANCEL
Möglicher Rückgabewert @see ButtonDialog

NO

public final static int NO
Möglicher Rückgabewert @see ButtonDialog

STYLE_NOBUTTON

public final static int STYLE_NOBUTTON
Wert für Setzten keines Buttons

STYLE_Y

public final static int STYLE_Y
Wert für Setzten von nur Ja-Button.

STYLE_Y_N

public final static int STYLE_Y_N
Wert für Setzten von Ja- und Nein-Buttons.

STYLE_Y_N_C

public final static int STYLE_Y_N_C
Wert für Setzten von Ja-, Nein-und Abbruch Buttons.

YES

public final static int YES
Möglicher Rückgabewert @see ButtonDialog
Method Detail

getTitle

static String getTitle(String strVal)
Gibt den Title fürs Dialogfenster. Dieser wird durch die Dialogart festgelegt (erster Teil in der MeldungsDefinition in der Properties-Datei).

getValue

static int getValue(String fieldName)
Liefert den Wert der über den Nemen übergebenen Klassenvariablen.

prepareMessage

static String prepareMessage(String rawText, String[] par)
Ersetzt die eventuellen Platzhalter durch die übergebenen Parameter

setTranslator

public static void setTranslator(Translator aRes)

show

public static int show(String messageId, String[] parameterList, Exception anException, Frame parentFrame)
Öffnet das Dialogfenster mit der Übersetzung der per Suchschlüssel übergebenen Meldung mit eingesetzten Parametern. Für die Übersetzung der Parameter trägt die aufrufende Stelle die Sorge. Der Dialog ist modal zum Frame frame.
Parameters:
  • - textID - Suchschlüssel der Meldung im Meldungspool,
  • param - Array der in die Meldung einzusetztenden Parameter,
  • frame - das Fenster, zu dem der Dialog modal ist.
Returns:
  • -1 wenn keine Rückgabe möglich ist oder Dialog NICHT MODAL ist.
  • ButtonDialog.YES = 2
  • ButtonDialog.NO = 4
  • ButtonDialog.CANCEL = 8
  • Wird das Dialog-Fenster ohne Buttonklick geschlossen (Kreuzchen oben rechts), so ist die Rückgabe gleich ButtonDialog.CANCEL.

show

public static int show(String messageId, String[] parameterList, Exception anException)

show

public static int show(String messageId, String[] parameterList, Frame parentFrame)

show

public static int show(String messageId, String[] parameterList)

show

public static int show(String messageId, String parameter, Frame parentFrame)

show

public static int show(String messageId, String parameter)

show

public static int show(String messageId, Frame parentFrame)

show

public static int show(String messageId)

show

public static int show(String messageId, Exception anException, Frame aFrame)

show

public static int show(String messageId, Exception anException)

show

public static int show(Exception anException, Frame aFrame)

Association Links

to Class org.apache.fop.viewer.Translator

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String