org.jzuul.engine.gui
Interface GuiInterface

All Known Implementing Classes:

SwingGui, SwtGui, TextUi

public interface GuiInterface

Dieses Interface wird von dem Engine für seine Ein/Ausgabe benutzt. Die print Methoden müssen so weit wie möglich den erwartungen Entsprechen. Der KeyListener muss nicht unbedingt implementiert werden, der ActionListener jedoch muss die Eingabe an das Engine weiterreichen.

Version:

$Revision: 1.10 $

Field Summary

static int[]	BLACK Definiert die Farbe Black in einem int[3] in RGB Werten
static int[]	BLUE Definiert die Farbe Blau in einem int[3] in RGB Werten
static int[]	GREEN Definiert die Farbe Grün in einem int[3] in RGB Werten
static int[]	ORANGE Definiert die Farbe Orange in einem int[3] in RGB Werten
static int[]	RED Definiert die Farbe Rot in einem int[3] in RGB Werten

Method Summary

void	close() Beendet und schliesst das UserInterface
void	disableInput() Schaltet das Input ab, der gesetzte ActionListener darf nicht mehr mit Events bedient werden.
void	enableInput() Schaltet das Input ein, der gesetzte ActionListener wird mit Events bedient.
ActionListener	getActionListener() Gibt den aktuell aktiven ActionListener zurück
String	getInput() Holt den aktuellen Wert der Eingabezeile
boolean	isApplet() Fragt das GUI ob es in einer Applet Sandbox läuft
void	print(String out) Erwartet die Ausgabe von out ohne Zeilenumbruch
void	println() Erwartet eine Leerzeile in der Ausgabe
void	println(String out) Erwartet die Ausgabe mit anschließendem Zeilenumbruch
void	println(String out, int[] color) Erwartet die Ausgaben von out mit anschließendem Zeilenumbruch in der Farbe color, die in RGB in einem int[3] übergeben wird.
void	printlnB(String out) Erwartet die Ausgabe von out in Fett (Bold), falls das Ausgabesystem es unterstützt plus einen Zeilenumbruch
void	printlnB(String out, int[] color) Erwartet die Ausgabe von out in Fett (Bold) in der in color spezifizierten Farbe, falls das Ausgabesystem es unterstützt plus einen Zeilenumbruch.
void	printlnI(String out) Erwartet die Ausgabe von out in Kursiv (Italic) plus einen Zeilenumbruch
void	printlnI(String out, int[] color) Erwartet die Ausgabe von out in Kursiv(Italic) in der in color spezifizierten Farbe, falls das Ausgabesystem dies unterstützt plus einen Zeilenumbruch.
void	printU(String out) Erwartet die Ausgabe von out unterstrichen, falls das Ausgabesystem es unterstützt
void	redraw() Fordert das neuzeichnen der Ausgabe, alle vorher aufgerufenen print methoden müssen dargestellt werden.
void	resetInput() Das GUI muss die Inputzeile bereinigen, falls dies möglich ist
void	setActionListener(ActionListener al) Setzt den ActionListener der von dem GUI Objekt bedient werden muss.
void	setDefaultActionListener() Setzt den ActionListener der mit setDefaultActionListener(defaultListener) gesetzt worden ist wieder aktuell.
void	setDefaultActionListener(ActionListener defaultListener) Setzt einen default ActionListener der mit setDefaultActionListener() wieder gesetzt werden kann.
void	setInput(String newline) Setzt die Eingabezeile auf newline
void	setKeyListener(KeyListener list) Setzt einen KeyListener, der einzelne Tastendrücke mitgeteilt bekommt, falls das Ausgabesystem dies unterstützt.
void	showImage(InputStream imageStream) Zeigt ein Bild an, wenn das Gui dieses Unterstützt
void	splash_next(String message) stellt aufdem Splashscreen den Fortschritt um einen weiteren Task da
void	splash_start(int numOfSteps) Startet den Splashscreen (Fenster was den Ladevorgang illustriert)
void	start() Übergibt dem GUI die Kontrolle

Field Detail

RED

public static final int[] RED

Definiert die Farbe Rot in einem int[3] in RGB Werten

GREEN

public static final int[] GREEN

Definiert die Farbe Grün in einem int[3] in RGB Werten

BLUE

public static final int[] BLUE

Definiert die Farbe Blau in einem int[3] in RGB Werten

ORANGE

public static final int[] ORANGE

Definiert die Farbe Orange in einem int[3] in RGB Werten

BLACK

public static final int[] BLACK

Definiert die Farbe Black in einem int[3] in RGB Werten

Method Detail

println

public void println(String out,
                    int[] color)

Erwartet die Ausgaben von out mit anschließendem Zeilenumbruch in der Farbe color, die in RGB in einem int[3] übergeben wird.

Parameters:

out - der String der Ausgegeben werden soll

color - die Farbe in RGB

print

public void print(String out)

Erwartet die Ausgabe von out ohne Zeilenumbruch

Parameters:

out - der String der Ausgegeben werden soll

println

public void println(String out)

Erwartet die Ausgabe mit anschließendem Zeilenumbruch

Parameters:

out - der String der Ausgegben wird

println

public void println()

Erwartet eine Leerzeile in der Ausgabe

printU

public void printU(String out)

Erwartet die Ausgabe von out unterstrichen, falls das Ausgabesystem es unterstützt

Parameters:

out - der String der ausgegebn werden soll

printlnB

public void printlnB(String out)

Erwartet die Ausgabe von out in Fett (Bold), falls das Ausgabesystem es unterstützt plus einen Zeilenumbruch

Parameters:

out - der String der Ausgegeben werden soll

printlnB

public void printlnB(String out,
                     int[] color)

Erwartet die Ausgabe von out in Fett (Bold) in der in color spezifizierten Farbe, falls das Ausgabesystem es unterstützt plus einen Zeilenumbruch.

Parameters:

out - der String der Ausgegeben werden soll

color - die RGB Farben in einem int[3]

printlnI

public void printlnI(String out)

Erwartet die Ausgabe von out in Kursiv (Italic) plus einen Zeilenumbruch

Parameters:

out - der String der Ausgegeben werden soll.

printlnI

public void printlnI(String out,
                     int[] color)

Erwartet die Ausgabe von out in Kursiv(Italic) in der in color spezifizierten Farbe, falls das Ausgabesystem dies unterstützt plus einen Zeilenumbruch.

Parameters:

out - der String der ausgegeben werden soll

color - die Farbe in RGB in einem int[3]

setActionListener

public void setActionListener(ActionListener al)

Setzt den ActionListener der von dem GUI Objekt bedient werden muss.

Parameters:

al - der ActionListener

setDefaultActionListener

public void setDefaultActionListener(ActionListener defaultListener)

Setzt einen default ActionListener der mit setDefaultActionListener() wieder gesetzt werden kann.

Parameters:

defaultListener - der default ActionListener

See Also:

setDefaultActionListener()

setDefaultActionListener

public void setDefaultActionListener()

Setzt den ActionListener der mit setDefaultActionListener(defaultListener) gesetzt worden ist wieder aktuell.

See Also:

setDefaultActionListener(ActionListener defaultListener)

setKeyListener

public void setKeyListener(KeyListener list)

Setzt einen KeyListener, der einzelne Tastendrücke mitgeteilt bekommt, falls das Ausgabesystem dies unterstützt.

Parameters:

list - der KeyListener.

getActionListener

public ActionListener getActionListener()

Gibt den aktuell aktiven ActionListener zurück

Returns:

den ActionListener, der aktuell von der Gui bedient wird

enableInput

public void enableInput()

Schaltet das Input ein, der gesetzte ActionListener wird mit Events bedient.

disableInput

public void disableInput()

Schaltet das Input ab, der gesetzte ActionListener darf nicht mehr mit Events bedient werden.

redraw

public void redraw()

Fordert das neuzeichnen der Ausgabe, alle vorher aufgerufenen print methoden müssen dargestellt werden.

start

public void start()

Übergibt dem GUI die Kontrolle

resetInput

public void resetInput()

Das GUI muss die Inputzeile bereinigen, falls dies möglich ist

isApplet

public boolean isApplet()

Fragt das GUI ob es in einer Applet Sandbox läuft

Returns:

true wenn das der Fall is, false sonst

setInput

public void setInput(String newline)

Setzt die Eingabezeile auf newline

Parameters:

newline - der neue Text der Eingabezeile

getInput

public String getInput()

Holt den aktuellen Wert der Eingabezeile

Returns:

den aktuellen Wert der Eingabezeile

splash_start

public void splash_start(int numOfSteps)

Startet den Splashscreen (Fenster was den Ladevorgang illustriert)

Parameters:

numOfSteps - wieviele Schritte ausgeführt werden

splash_next

public void splash_next(String message)

stellt aufdem Splashscreen den Fortschritt um einen weiteren Task da

Parameters:

message - Nachricht die für den Fortschritt ausgegeben werden soll

close

public void close()

Beendet und schliesst das UserInterface

showImage

public void showImage(InputStream imageStream)

Zeigt ein Bild an, wenn das Gui dieses Unterstützt

Parameters:

imageStream -