de.willuhn.jameica.gui

Class AbstractView

java.lang.Object

de.willuhn.jameica.gui.AbstractView

Direct Known Subclasses:

Appointments, Backup, FatalErrorView, License, SearchResultView, Settings, Start

public abstract class AbstractView
extends java.lang.Object

Basis-Klasse fuer alles Views.

Author:

willuhn

Constructor Summary

Constructors

Constructor and Description
AbstractView()

Method Summary

Modifier and Type	Method and Description
abstract void	bind() Wird aufgerufen, wenn der Dialog geoeffnet wird.
boolean	canBookmark() Liefert true, wenn die View gebookmarkt werden kann.
java.lang.Object	getCurrentObject() Liefert das dieser View uebergebene Daten-Objekt zurueck.
java.lang.String	getHelp() Liefert einen Hilfetext fuer die View.
org.eclipse.swt.widgets.Composite	getParent() Liefert das Composite, in dem der Dialog gemalt wird.
void	reload() Kann von ableitenden Klassen ueberschrieben werden, um den Dialog neu zu laden.
void	setCurrentObject(java.lang.Object o) Speichert das zu dieser View gehoerende Daten-Objekt.
void	setParent(org.eclipse.swt.widgets.Composite p) Speichert das Composite, in dem der Dialog gemalt werden soll.
void	unbind() Wird aufgerufen, wenn der Dialog verlassen wird.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractView

public AbstractView()

Method Detail

bind

public abstract void bind()
                   throws java.lang.Exception

Wird aufgerufen, wenn der Dialog geoeffnet wird. Diese Methode muss von abgeleiteteten Klassen ueberschrieben werden, um dort den Content zu malen.

Throws:

java.lang.Exception - kann von der View geworfen werden, wenn ein Fehler waehrend des Erstellens der View aufgetreten ist und die View diesen Fehler nicht behandeln moechte. Die GUI uebernimmt das dann, indem Sie stattdessen eine Fehlerseite mit dem Message-Text der Exception anzeigt. Es ist also ratsam, in den Text der Exception etwas sinnvolles reinzuschreiben, weil es dem Benutzer angezeigt wird.

unbind

public void unbind()
            throws de.willuhn.util.ApplicationException

Wird aufgerufen, wenn der Dialog verlassen wird. Diese Methode kann von abgeleiteten Klassen ueberschrieben werden, um dort Aufraeumarbeiten vorzunehmen.

Throws:

de.willuhn.util.ApplicationException - darf vom Dialog geworfen werden, wenn der neue Dialog nicht gestartet werden soll. Z.Bsp. weil Daten noch nicht gespeichert worden oder ein Vorgang noch in Bearbeitung ist.

reload

public void reload()
            throws de.willuhn.util.ApplicationException

Kann von ableitenden Klassen ueberschrieben werden, um den Dialog neu zu laden.

Throws:

de.willuhn.util.ApplicationException

getCurrentObject

public final java.lang.Object getCurrentObject()

Liefert das dieser View uebergebene Daten-Objekt zurueck.

Returns:

Liefert das Business-Objekt fuer das der Dialog zustaendig ist.

setCurrentObject

public final void setCurrentObject(java.lang.Object o)

Speichert das zu dieser View gehoerende Daten-Objekt.

Parameters:

o - das Business-Objekt.

getParent

public final org.eclipse.swt.widgets.Composite getParent()

Liefert das Composite, in dem der Dialog gemalt wird.

Returns:

Parent-Composite.

setParent

public final void setParent(org.eclipse.swt.widgets.Composite p)

Speichert das Composite, in dem der Dialog gemalt werden soll. Wenn diese Funktion benutzt wird, muss sie zwingend vor bind() geschehen, da es sonst zu spaet ist ;).

Parameters:

p - das Parent-Composite.

getHelp

public java.lang.String getHelp()

Liefert einen Hilfetext fuer die View. Normalerweise liegen die Hilfetexte in help/${locale} in Form von Text-Dateien und werden automatisch geladen, wenn sie existieren. Durch diese Funktion hier existiert eine Alternative, mit der die Hilfetexte auch zur Laufzeit erzeugt werden koennen.

Returns:

der Hilfetext fuer die View.

canBookmark

public boolean canBookmark()

Liefert true, wenn die View gebookmarkt werden kann. Kann ueberschrieben werden, wenn nicht gewuenscht.

Returns:

true, wenn die View gebookmarkt werden kann. Default ist true.