de.guibuilder.framework
Class GuiWindow

java.lang.Object
  |
  +--de.guibuilder.framework.GuiWindow

All Implemented Interfaces:

MemberAble

Direct Known Subclasses:

GuiApplet, GuiDialog, GuiForm, GuiInternalFrame

public abstract class GuiWindow

extends java.lang.Object

implements MemberAble

Diese abstakte Klasse ist für Top Level Fenster; also GuiForm, GuiDialog, GuiApplet, GuiInternalFrame.

Weitere Methoden stehen über den Zugriff auf GuiRootPane und dessen HauptPanel zur Verfügung.

Ein Fenster verfügt immer über ein solches RootPane-Objekt und RootPane hat immer ein HauptPanel.
Der folgende Code funktioniert daher zuverlässig:
myForm.getRootPane().getMainPanel()

See Also:

getRootPane(), GuiRootPane.getMainPanel()

Field Summary

static int	APPLET
static int	DIALOG
static int	DISPOSE
static int	FORM
static int	HIDE
static int	INTERNAL
static int	NOTHING

Constructor Summary

GuiWindow(java.lang.String title)
Erzeugt ein Fenster mit einem Titel; der Titel wird gleichzeitig als Name verwendet.

Method Summary

abstract void	dispose() Vernichtet das Fenster und entfernt alle abhängigen Objekte; das hilft dem gc.
GuiAction	getAction(java.lang.String name)
electric.xml.Document	getAllValuesXml()
abstract java.awt.Container	getComponent() Liefert die Swing-Komponente zu diesem Oberflächen-Objekt.
java.lang.Object	getControler()
java.lang.String	getDefaultTitle() Wird von der Factory versorgt für zusammengesetzte Fenstertitel; enthält also den Text aus der GuiSpezifikation.
GuiComponent	getGuiComponent(java.lang.String name)
GuiContainer	getGuiContainer(java.lang.String name)
GuiMember	getGuiMember(java.lang.String name)
GuiMenuBar	getGuiMenuBar()
abstract int	getGuiType() Liefert den Typ des Fensters je nach Unterklasse: FORM, DIALOG, APPLET oder INTERNAL
abstract java.awt.Image	getIconImage() Liefert den Icon in der linken oberen Ecke des Fensters; nur bei Form
GuiPanel	getMainPanel()
GuiModel	getModel()
GuiModel	getModelValues()
java.lang.String	getMsgActive()
java.lang.String	getMsgClose()
java.lang.String	getMsgOpen()
java.lang.String	getName() Delegation an jeweilige Component
int	getObjectSize() Deprecated.
abstract GuiRootPane	getRootPane() Liefert GuiRootPane.
abstract java.lang.String	getTag() Liefert den XML-Element-Tag der Komponente ("Form", "Text", "Panel", ...).
abstract java.lang.String	getTitle() Liefert den Fenstertitel; gilt nicht für Applet.
java.lang.Object	getValue(java.lang.String name) Es kann über den Namen einer Komponente (siehe Attribut name=) ihr Wert ausgelesen werden.
java.lang.String	getWindowId() Liefert die Window-Id des Fensters
abstract void	hide() "Versteckt" das Fenster; es kann anschließend mit "show()" wieder in alter Schönheit angezeigt werden.
abstract boolean	isModal() Gilt nur für GuiDialog
boolean	isSystemForm() Liefert das Kennzeichen, ob das Formular ein Systemfenster ist.
void	replaceRootPane(java.lang.String filename) Deprecated.
void	reset() Inhalt aller Felder zurücksetzen; siehe eingebaute Methode new()
void	setAllValuesXml(electric.xml.Document doc)
void	setAllValuesXml(electric.xml.Element node)
void	setControler(java.lang.Object c) Controler für Reflection setzen.
void	setControler(java.lang.String s) Controler setzen;
void	setDefaultCloseOperation(int type) Es kann definiert werden, was passiert, wenn der Benutzer die ControlBox des Fensters betätigt: DISPOSE, HIDE, NOTHING.
void	setDefaultTitle(java.lang.String s)
abstract void	setIconImage(java.awt.Image icon) Setzt den Icon in der linken oberen Ecke des Fensters; nur bei Form
abstract void	setModal(boolean b) Gilt nur für GuiDialog
void	setModel(GuiModel m)
void	setModelValues(GuiModel m)
void	setMsgActive(java.lang.String s)
void	setMsgClose(java.lang.String s)
void	setMsgOpen(java.lang.String s)
void	setName(java.lang.String name) Delegation an jeweilige Component
abstract void	setRootPane(GuiRootPane root) Schiebt dem Fenster ein anderes RootPane unter.
void	setSystemForm(boolean b) Kennzeichnet das Formmular als ein Systemfenster.
abstract void	setTitle(java.lang.String title) Setzt den Fenstertitel; gilt nicht für Applet.
void	setValue(java.lang.String name, java.lang.Object value) Es kann über den Namen einer Komponente (siehe Attribut name=) ihr Wert gesetzt werden.
void	setWindowId(java.lang.String id) Setzt die Window-Id des Fensters
void	show() Zeigt das Fenster an, wenn Form oder Dialog.
void	verify()

Methods inherited from class java.lang.Object

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

Field Detail

FORM

public static final int FORM

See Also:

Constant Field Values

DIALOG

public static final int DIALOG

See Also:

Constant Field Values

APPLET

public static final int APPLET

See Also:

Constant Field Values

INTERNAL

public static final int INTERNAL

See Also:

Constant Field Values

NOTHING

public static final int NOTHING

See Also:

Constant Field Values

DISPOSE

public static final int DISPOSE

See Also:

Constant Field Values

HIDE

public static final int HIDE

See Also:

Constant Field Values

Constructor Detail

GuiWindow

public GuiWindow(java.lang.String title)

Erzeugt ein Fenster mit einem Titel; der Titel wird gleichzeitig als Name verwendet.

Method Detail

setName

public final void setName(java.lang.String name)

Delegation an jeweilige Component

Specified by:

setName in interface MemberAble

getName

public final java.lang.String getName()

Delegation an jeweilige Component

Specified by:

getName in interface MemberAble

getTag

public abstract java.lang.String getTag()

Description copied from interface: MemberAble

Liefert den XML-Element-Tag der Komponente ("Form", "Text", "Panel", ...).

Specified by:

getTag in interface MemberAble

setModel

public void setModel(GuiModel m)

getModel

public GuiModel getModel()

setModelValues

public void setModelValues(GuiModel m)

getModelValues

public GuiModel getModelValues()

show

public final void show()

Zeigt das Fenster an, wenn Form oder Dialog.

Setzt in der Session das CurrentWindow

See Also:

GuiSession.setCurrentWindow(de.guibuilder.framework.GuiWindow)

getComponent

public abstract java.awt.Container getComponent()

Liefert die Swing-Komponente zu diesem Oberflächen-Objekt.
Delegation; es ist möglich, auf die jeweilige swing-Klasse (JApplet, JDialog, JFrame, ...) zu casten; die Swing-Methoden können so genutzt werden.

Returns:

awt.Container als kleinstes gemeinsames Vielfaches

isModal

public abstract boolean isModal()

Gilt nur für GuiDialog

See Also:

GuiDialog

setModal

public abstract void setModal(boolean b)

Gilt nur für GuiDialog

See Also:

GuiDialog

getGuiType

public abstract int getGuiType()

Liefert den Typ des Fensters je nach Unterklasse: FORM, DIALOG, APPLET oder INTERNAL

getTitle

public abstract java.lang.String getTitle()

Liefert den Fenstertitel; gilt nicht für Applet.

setTitle

public abstract void setTitle(java.lang.String title)

Setzt den Fenstertitel; gilt nicht für Applet.

getIconImage

public abstract java.awt.Image getIconImage()

Liefert den Icon in der linken oberen Ecke des Fensters; nur bei Form

setIconImage

public abstract void setIconImage(java.awt.Image icon)

Setzt den Icon in der linken oberen Ecke des Fensters; nur bei Form

dispose

public abstract void dispose()

Vernichtet das Fenster und entfernt alle abhängigen Objekte; das hilft dem gc.

Achtung!
Im Anschluß an diese Methodenaufruf dürfen keine weiteren Manipulation an diesem Objekt mehr vorgenommen werden; vielmehr ist die Objektreferenz auf null zu setzen.

hide

public abstract void hide()

"Versteckt" das Fenster; es kann anschließend mit "show()" wieder in alter Schönheit angezeigt werden.

setDefaultCloseOperation

public final void setDefaultCloseOperation(int type)

Es kann definiert werden, was passiert, wenn der Benutzer die ControlBox des Fensters betätigt: DISPOSE, HIDE, NOTHING.

Geht naturgemäß nicht bei einem Applet.

replaceRootPane

public final void replaceRootPane(java.lang.String filename)

Deprecated.

Diese Methode ersetzt den vorhandenen Inhalt eines Fensters komplett durch eine neue Spezifikation aus dem übergebenen Filenamen.
Dabei wird auch das Menü und die Toolbar übernommen. Siehe die Standard-Methode replace([filename]).

PENDING Diese Methode hat ein Memory leak!

setRootPane

public abstract void setRootPane(GuiRootPane root)

Schiebt dem Fenster ein anderes RootPane unter.

getRootPane

public abstract GuiRootPane getRootPane()

Liefert GuiRootPane.

Wenn der Rückgabewert hier null sein sollte, liegt ein schwerer interner Fehler vor; entweder trat bereits ein Fehler bei der Initialisierung des Fensters auf, oder es wurde zuvor dispose() aufgerufen.

isSystemForm

public boolean isSystemForm()

Liefert das Kennzeichen, ob das Formular ein Systemfenster ist.
Nur bei FORM kann true geliefert werden.

setSystemForm

public final void setSystemForm(boolean b)

Kennzeichnet das Formmular als ein Systemfenster. Beim Betätigen der Controlbox wird die Anwendung beendet (System.exit).
Funktioniert nur bei FORM.

getDefaultTitle

public final java.lang.String getDefaultTitle()

Wird von der Factory versorgt für zusammengesetzte Fenstertitel; enthält also den Text aus der GuiSpezifikation.

setDefaultTitle

public final void setDefaultTitle(java.lang.String s)

setMsgOpen

public final void setMsgOpen(java.lang.String s)

getMsgOpen

public final java.lang.String getMsgOpen()

setMsgClose

public final void setMsgClose(java.lang.String s)

getMsgClose

public final java.lang.String getMsgClose()

setMsgActive

public final void setMsgActive(java.lang.String s)

getMsgActive

public final java.lang.String getMsgActive()

getGuiMenuBar

public final GuiMenuBar getGuiMenuBar()

See Also:

JRootPane.getMenuBar()

getMainPanel

public final GuiPanel getMainPanel()

See Also:

GuiRootPane.getMainPanel()

getAction

public final GuiAction getAction(java.lang.String name)

See Also:

GuiContainer.getAction(java.lang.String)

getGuiMember

public final GuiMember getGuiMember(java.lang.String name)

See Also:

GuiContainer.getMember(java.lang.String)

getGuiComponent

public final GuiComponent getGuiComponent(java.lang.String name)

See Also:

GuiContainer.getGuiComponent(java.lang.String)

getGuiContainer

public final GuiContainer getGuiContainer(java.lang.String name)

getValue

public final java.lang.Object getValue(java.lang.String name)

Es kann über den Namen einer Komponente (siehe Attribut name=) ihr Wert ausgelesen werden.

See Also:

GuiContainer.getValue(java.lang.String)

setValue

public final void setValue(java.lang.String name,
                           java.lang.Object value)

Es kann über den Namen einer Komponente (siehe Attribut name=) ihr Wert gesetzt werden.

See Also:

GuiContainer.setValue(java.lang.String, java.lang.Object)

getAllValuesXml

public final electric.xml.Document getAllValuesXml()

setAllValuesXml

public final void setAllValuesXml(electric.xml.Document doc)

setAllValuesXml

public final void setAllValuesXml(electric.xml.Element node)

reset

public final void reset()

Inhalt aller Felder zurücksetzen; siehe eingebaute Methode new()

verify

public final void verify()
                  throws java.lang.IllegalStateException

java.lang.IllegalStateException

See Also:

GuiContainer.verify()

getWindowId

public final java.lang.String getWindowId()

Liefert die Window-Id des Fensters

See Also:

GuiAPI.createWindow(java.lang.String, java.lang.String, java.lang.String)

setWindowId

public final void setWindowId(java.lang.String id)

Setzt die Window-Id des Fensters

See Also:

GuiAPI.createWindow(java.lang.String, java.lang.String, java.lang.String)

setControler

public final void setControler(java.lang.Object c)

Controler für Reflection setzen.

setControler

public final void setControler(java.lang.String s)

Controler setzen;

Parameters:

s - Ein String, der einen Klassennamen (muß im Classpath enthalten sein) oder eine Script-File (*.pnut oder *.bsh) enthält

getControler

public final java.lang.Object getControler()

getObjectSize

public final int getObjectSize()

Deprecated.

Liefert die Größe des Objektes