de.guibuilder.framework
Class GuiMember

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

All Implemented Interfaces:

MemberAble, java.io.Serializable

Direct Known Subclasses:

GuiContainer, GuiElement

public abstract class GuiMember

extends java.lang.Object

implements MemberAble, java.io.Serializable

Eine abstrakte Oberflächenkomponente als Wurzel für alle Komponenten.
Der Zusammenhang dieser Klasse mit GuiElement und GuiContainer bildet ein Kompositum Pattern.

Einige Methoden sind abstact, müssen also jeweils implementiert werden. Andere sind final um sicherzustellen, daß sie nicht überschrieben werden.

Since:

0.9.1

See Also:

GuiElement, GuiContainer, Serialized Form

Field Summary

static int	GUI_ACTION
static int	GUI_COMPONENT
static int	GUI_CONTAINER
static int	GUI_TABLE
static int	GUI_TREE
static java.lang.String[]	GUI_TYPE_NAMES
protected boolean	hasMouseListener Kennzeichen, ob bereits ein MouseListener eingerichtet ist.
static java.lang.String	OID Xml-Attribute für oid: "_oid"

Method Summary

void	click(java.awt.event.MouseEvent e) Die Komponente wird angeklickt; ist hier leer implementiert und muß bei Bedarf überschrieben werden.
void	d_click(java.awt.event.MouseEvent e) Die Komponente wird doppelt angeklickt.
java.awt.Color	getBackground() From swing.JComponent
java.awt.GridBagConstraints	getConstraints() Liefert die GridBagConstraints zu diesem Member, oder null, wenn kein GridBagLayout oder wenn kein awt.Component.
java.lang.Object	getControler() Liefert den eingerichteten Controler oder der seines Parents.
java.lang.String	getElementName() Liefert den ElementNamen dieser Komponente im GuiModel.
java.awt.Font	getFont() From swing.JComponent
java.awt.Color	getForeground() From swing.JComponent
java.lang.String	getFullName() Liefert den vollständigen Pfad-Namen dieser Komponenten; etwaige übergeordnete Container werden in Punktnotation vorangestellt: tabBestellung.panelLieferAdresse.strasse Wenn das Objekt auf dem MainPanel liegt, wird getName() geliefert.
GuiContainer	getGuiParent() Liefert den Container zu dieser Komponente oder null, wenn nicht Teil eines Containers.
abstract int	getGuiType() Liefert den Typ der Komponente: GUI_ACTION (Button, MenuItem) GUI_COMPONENT (Combo, List, Text, Check, usw) GUI_CONTAINER (Panel, Group, Tab) GUI_TABLE GUI_TREE
static java.lang.String	getGuiTypeName(int i) Liefert die Bezeichnung dieses Typs.
abstract javax.swing.JComponent	getJComponent() Liefert die Swing-Komponente zu diesem Oberflächen-Objekt (Delegation).
java.lang.String	getLabel() Üblicherweise der Text des dazugehörigen Labels der Komponente oder null, wenn kein Label vorhanden.
java.awt.Dimension	getMaximumSize() From swing.JComponent
java.awt.Dimension	getMinimumSize() From swing.JComponent
java.lang.String	getMsgMouseOver() Liefert das ActionCommand, was bei MouseOver geliefert wird.
java.lang.String	getName() From awt.Component.
long	getOid() Liefert die Oid.
java.lang.String	getParentNames() Liefert den oder die Namen der übergeordneten Container einer Komponente.
GuiTab	getParentTab() Deprecated. Das geht schief, wenn die Registerkarte nur ein Layout-Container ist! Liefert die Registerkarte, auf der die Komponente liegt oder null, wenn außerhalb eines Tabset.
java.awt.Dimension	getPreferredSize() From swing.JComponent
java.lang.String	getRef()
GuiRootPane	getRootPane() Liefert RootPane.
abstract java.lang.String	getTag() Liefert den XML-Element-Tag für den Member.
java.lang.String	getToolTipText() From swing.JComponent
java.lang.Object	getUserObject() Liefert das UserObject
java.lang.String	getXValue() Liefert text(), cdata() oder den Attributnamen für den Wert dieser Komponente.
boolean	isVisible() From awt.Component
void	setBackground(java.awt.Color c) From swing.JComponent
void	setConstraints(java.awt.GridBagConstraints constr) Setzt die GridBagConstraints für diesen Member neu; macht nichts, wenn Member kein awt.Component.
void	setControler(java.lang.Object o) Auf jeder Ebene kann ein Controler für Benutzerereignisse eingerichet werden.
void	setFont(java.awt.Font f) From swing.JComponent
void	setForeground(java.awt.Color c) From swing.JComponent
void	setGuiParent(GuiContainer c) Verknüpft ein Member mit einem Container Ist hier Public wegen Interface OptionAble
void	setLabel(java.lang.String s) Üblicherweise der Text des dazugehörigen Labels der Komponente.
void	setMaximumSize(java.awt.Dimension d) From swing.JComponent
void	setMinimumSize(java.awt.Dimension d) From swing.JComponent
void	setMsgMouseMoved(java.lang.String s) Setzt das ActionCommand, was bei MouseMoved geliefert werden soll.
void	setMsgMouseOver(java.lang.String s) Setzt das ActionCommand, was bei MouseOver geliefert werden soll.
void	setName(java.lang.String name) Delegiert an awt.Component.
void	setOid(long id) Setzt die beliebige Oid.
void	setPopupMenu(GuiPopupMenu m) Setzt das PopupMenu der Komponente.
void	setPreferredSize(java.awt.Dimension d) From swing.JComponent
void	setRef(java.lang.String ref) Setzt eine beliebige Zeichenfolge für Benutzer-definierte Zwecke; z.B. als Datenbankreferenz.
void	setToolTipText(java.lang.String s) From swing.JComponent
void	setUserObject(java.lang.Object obj) Jeder OberflächenKomponente kann ein beliebiges Object zugewiesen werden.
void	setVisible(boolean b) From awt.Component

Methods inherited from class java.lang.Object

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

Field Detail

GUI_ACTION

public static final int GUI_ACTION

See Also:

GuiAction, getGuiType(), Constant Field Values

GUI_COMPONENT

public static final int GUI_COMPONENT

See Also:

GuiComponent, getGuiType(), Constant Field Values

GUI_CONTAINER

public static final int GUI_CONTAINER

See Also:

GuiContainer, getGuiType(), Constant Field Values

GUI_TABLE

public static final int GUI_TABLE

See Also:

GuiTable, getGuiType(), Constant Field Values

GUI_TREE

public static final int GUI_TREE

See Also:

GuiTree, getGuiType(), Constant Field Values

GUI_TYPE_NAMES

public static final java.lang.String[] GUI_TYPE_NAMES

OID

public static final java.lang.String OID

Xml-Attribute für oid: "_oid"

See Also:

Constant Field Values

hasMouseListener

protected boolean hasMouseListener

Kennzeichen, ob bereits ein MouseListener eingerichtet ist. Soll doppelte und fehlende MouseListener vermeiden helfen.

Method Detail

getJComponent

public abstract javax.swing.JComponent getJComponent()

Liefert die Swing-Komponente zu diesem Oberflächen-Objekt (Delegation).

Es ist möglich, auf die jeweilige Swing-Klasse (JCombo, JTextField, JPanel, ...) zu casten; die Swing-Methoden können so genutzt werden.

Bei einem HiddenField und OptionGroup wird null geliefert!

setGuiParent

public final void setGuiParent(GuiContainer c)

Verknüpft ein Member mit einem Container Ist hier Public wegen Interface OptionAble

See Also:

GuiContainer.addMember(de.guibuilder.framework.GuiMember), GuiContainer.addAction(de.guibuilder.framework.GuiAction)

getGuiParent

public final GuiContainer getGuiParent()

Liefert den Container zu dieser Komponente oder null, wenn nicht Teil eines Containers.

Bei Layout-Containern wird der Parent-Container geliefert.

getName

public java.lang.String getName()

From awt.Component. Wird von HiddenField und OptionGroup überschrieben.

Specified by:

getName in interface MemberAble

setName

public void setName(java.lang.String name)

Delegiert an awt.Component.
Wenn das Label null ist, wird es auf den Namen gesetzt. Wird von HiddenField und OptionGroup überschrieben.

Specified by:

setName in interface MemberAble

getLabel

public final java.lang.String getLabel()

Üblicherweise der Text des dazugehörigen Labels der Komponente oder null, wenn kein Label vorhanden.

setLabel

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

Üblicherweise der Text des dazugehörigen Labels der Komponente.

getElementName

public final java.lang.String getElementName()

Liefert den ElementNamen dieser Komponente im GuiModel. Da hieraus XPath-Ausdrücke gebildet werden muß dieser Name mit einem "/" beginnen.

See Also:

GuiModel

getXValue

public final java.lang.String getXValue()

Liefert text(), cdata() oder den Attributnamen für den Wert dieser Komponente.

See Also:

GuiModel

isVisible

public final boolean isVisible()

From awt.Component

setVisible

public final void setVisible(boolean b)

From awt.Component

getParentTab

public final GuiTab getParentTab()

Deprecated. Das geht schief, wenn die Registerkarte nur ein Layout-Container ist!

Liefert die Registerkarte, auf der die Komponente liegt oder null, wenn außerhalb eines Tabset.

getParentNames

public final java.lang.String getParentNames()

Liefert den oder die Namen der übergeordneten Container einer Komponente.

Wenn mehrere Container geschachtelt, denn die Namen in Punkt-Notation: tabBestellung.panelLieferAdresse
Wenn das Objekt direkt auf dem mainPanel liegt, wird null geliefert.

See Also:

GuiContainer.isParentContainer()

getFullName

public final java.lang.String getFullName()

Liefert den vollständigen Pfad-Namen dieser Komponenten; etwaige übergeordnete Container werden in Punktnotation vorangestellt:

tabBestellung.panelLieferAdresse.strasse
Wenn das Objekt auf dem MainPanel liegt, wird getName() geliefert.

See Also:

getParentNames(), getName()

getGuiType

public abstract int getGuiType()

Liefert den Typ der Komponente:

• GUI_ACTION (Button, MenuItem)
• GUI_COMPONENT (Combo, List, Text, Check, usw)
• GUI_CONTAINER (Panel, Group, Tab)
• GUI_TABLE
• GUI_TREE

getGuiTypeName

public static java.lang.String getGuiTypeName(int i)

Liefert die Bezeichnung dieses Typs.

getRootPane

public GuiRootPane getRootPane()

Liefert RootPane.

Wird von MenuItem und GuiElement überschrieben.

setMsgMouseOver

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

Setzt das ActionCommand, was bei MouseOver geliefert werden soll. Dazu wird ein MouseListener eingerichtet (wenn noch nicht vorhanden). Dieses Verhalten wird mit Übergabe von null abgeschaltet.

See Also:

#mouseOver

setMsgMouseMoved

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

Setzt das ActionCommand, was bei MouseMoved geliefert werden soll. Dazu wird ein MouseMotion eingerichtet. Dieses Verhalten wird mit Übergabe von null abgeschaltet.

See Also:

#mouseOver

getMsgMouseOver

public final java.lang.String getMsgMouseOver()

Liefert das ActionCommand, was bei MouseOver geliefert wird.

click

public void click(java.awt.event.MouseEvent e)

Die Komponente wird angeklickt; ist hier leer implementiert und muß bei Bedarf überschrieben werden.

See Also:

GuiMouseListener

d_click

public void d_click(java.awt.event.MouseEvent e)

Die Komponente wird doppelt angeklickt. Diese Methode ist hier leer implementiert und muß folglich bei abgeleiteten Klassen überschrieben werden. Ist dieses Objekt eine Tabellenspalte, wird diese Nachricht auch an die Tabelle weitergeleitet.

See Also:

GuiMouseListener, GuiRootPane#obj_DblClick

setPopupMenu

public final void setPopupMenu(GuiPopupMenu m)

Setzt das PopupMenu der Komponente. Dazu wird ein MouseListener eingerichtet (wenn noch nicht vorhanden).

See Also:

GuiMouseListener

setMinimumSize

public final void setMinimumSize(java.awt.Dimension d)

From swing.JComponent

getMinimumSize

public final java.awt.Dimension getMinimumSize()

From swing.JComponent

setMaximumSize

public final void setMaximumSize(java.awt.Dimension d)

From swing.JComponent

getMaximumSize

public final java.awt.Dimension getMaximumSize()

From swing.JComponent

setPreferredSize

public final void setPreferredSize(java.awt.Dimension d)

From swing.JComponent

getPreferredSize

public final java.awt.Dimension getPreferredSize()

From swing.JComponent

setFont

public final void setFont(java.awt.Font f)

From swing.JComponent

getFont

public final java.awt.Font getFont()

From swing.JComponent

getToolTipText

public final java.lang.String getToolTipText()

From swing.JComponent

setToolTipText

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

From swing.JComponent

getBackground

public final java.awt.Color getBackground()

From swing.JComponent

setBackground

public final void setBackground(java.awt.Color c)

From swing.JComponent

getForeground

public final java.awt.Color getForeground()

From swing.JComponent

setForeground

public final void setForeground(java.awt.Color c)

From swing.JComponent

See Also:

GuiFocusListener

setRef

public final void setRef(java.lang.String ref)

Setzt eine beliebige Zeichenfolge für Benutzer-definierte Zwecke; z.B. als Datenbankreferenz.
Siehe Attribut ref=

getRef

public final java.lang.String getRef()

See Also:

setRef(java.lang.String)

setUserObject

public final void setUserObject(java.lang.Object obj)

Jeder OberflächenKomponente kann ein beliebiges Object zugewiesen werden. Dieses wird vom Framework selbst nie verwendet.

getUserObject

public final java.lang.Object getUserObject()

Liefert das UserObject

setOid

public final void setOid(long id)

Setzt die beliebige Oid.

getOid

public final long getOid()

Liefert die Oid.
Wenn -1, dann ist keine Oid gesetzt.

getConstraints

public final java.awt.GridBagConstraints getConstraints()

Liefert die GridBagConstraints zu diesem Member, oder null, wenn kein GridBagLayout oder wenn kein awt.Component.

setConstraints

public final void setConstraints(java.awt.GridBagConstraints constr)

Setzt die GridBagConstraints für diesen Member neu; macht nichts, wenn Member kein awt.Component.

getTag

public abstract java.lang.String getTag()

Liefert den XML-Element-Tag für den Member.

Specified by:

getTag in interface MemberAble

setControler

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

Auf jeder Ebene kann ein Controler für Benutzerereignisse eingerichet werden.

See Also:

GuiRootPane#invokeMethod

getControler

public final java.lang.Object getControler()

Liefert den eingerichteten Controler oder der seines Parents.