de.guibuilder.framework
Class GuiComponent

java.lang.Object
  extended by de.guibuilder.framework.GuiMember
      extended by de.guibuilder.framework.GuiElement
          extended by de.guibuilder.framework.GuiComponent
All Implemented Interfaces:
IDatasetComponent, IDatasetMember, MemberAble, MemberPopupAble
Direct Known Subclasses:
GuiCheck, GuiDocument, GuiEditor, GuiLabel, GuiMemo, GuiMenuItemCheckBox, GuiMenuItemOption, GuiMinMax, GuiOption, GuiOptionGroup, GuiPassword, GuiSelect, GuiTable, GuiTButton, GuiText, GuiTree, HiddenField

public abstract class GuiComponent
extends GuiElement
implements IDatasetComponent

Abstrakte Basisklasse für alle Oberflächenelemente die Daten halten können im Unterschied zu denen, die Aktionen auslösen.

Since:
0.9.1
See Also:
GuiAction

Field Summary
static int BOOLEAN
           
static java.lang.String[] DATA_TYPE_NAMES
           
static int DATE
           
static int ENUM
           
static int INTEGER
           
static int MULTILINE
           
static int NUMBER
           
static int STRING
           
static int TABLE
           
static int TIME
           
static int TREE
           
 
Fields inherited from class de.guibuilder.framework.GuiMember
GUI_ACTION, GUI_COMPONENT, GUI_CONTAINER, GUI_TABLE, GUI_TREE, GUI_TYPE_NAMES, OID
 
Method Summary
 void commitChanges()
          Teilt der Komponente mit, daß die Benutzereingaben erfolgreich verarbeitet wurden.
 void getDatasetValues(JDataSet ds)
          Der von der Komponente gehaltene Wert wird in den Dataset eingetragen.
 void getDatasetValues(JDataSet ds, java.lang.String current)
           
abstract  int getDataType()
          Liefert den Datentyp der Componente.
static java.lang.String getDataTypeName(int dataType)
          Liefert die Bezeichung zu dem Datentyp.
 GuiComponent getGuiComponent()
           
 int getGuiType()
          Liefert GUI_COMPONENT
 java.lang.String getLabel()
          Überschreibt die Methode der Oberklasse, um bei Pflichtfeldern eine Ergänzung des Labels vorzunehmen (sofern in der GuiBuilderConfig.xml ein solches Zeichen definiert ist).
 int getMaxlen()
          Liefert die maximale Eingabelänge z.B. von Textfeldern.
 int getMinlen()
          Liefert die minimale Eingabelänge z.B. von Textfeldern.
abstract  java.lang.Object getUnformatedValue()
          Liefert den unformatierten Inhalt dieser Componente.
abstract  java.lang.Object getValue()
          Liefert den Inhalt dieser Componente.
 boolean isModified()
          Liefert das Kennzeichen, ob der Inhalt der Komponente vom Benutzer verändert wurde.
 boolean isNotnull()
          Liefert das Kennzeichen "Pflichtfeld".
 void postProc()
          Diese Methode wird aufgerufen, nachdem der Benutzer eine Änderung an dem Eingabefeld vorgenommen hat.
 void setDatasetValues(JDataSet ds)
          Setzt den Inhalt der Komponente auf den Inhalt des Models der über getElementPath erreichbar ist.
 void setMaxlen(int len)
          Setzt die maximale Eingabelänge z.B. für Textfelder.
 void setMinlen(int len)
          Setzt die minimale Eingabelänge z.B. für Textfelder.
 void setModified(boolean b)
          Setzt das Änderungskennzeichen neu.
 void setNotnull(boolean b)
          Setzt das Kennzeichen "Pflichtfeld".
 void setValue(java.lang.Object o)
          Setzt den Inhalt dieser Componente.
 java.lang.String toString()
           
 void verify()
          Ruft den InputVerifier der Componente auf.
 
Methods inherited from class de.guibuilder.framework.GuiElement
getFileName, getHint, getMsgChange, getMsgClick, getMsgDblClick, getParentTable, getRootPane, hasTabstop, isEnabled, requestFocus, setEnabled, setHint, setMsgChange, setMsgClick, setMsgDblClick, setMsgLostFocus, setParentTable, setTabstop
 
Methods inherited from class de.guibuilder.framework.GuiMember
addSetter, click, d_click, getAwtComponent, getBackground, getConstraints, getControler, getController, getDropTarget, getElementName, getElementPath, getFont, getForeground, getFullName, getGuiParent, getGuiTypeName, getJComponent, getMaximumSize, getMemberElement, getMinimumSize, getMsgDragEnter, getMsgDragExit, getMsgDragOver, getMsgDrop, getMsgFileDrop, getMsgMouseOver, getMsgPopup, getName, getOid, getParentNames, getParentTab, getPopupMenu, getPreferences, getPreferredSize, getRef, getTag, getToolTipText, getUserObject, isRootElement, isVisible, reset, setBackground, setConstraints, setControler, setController, setDrag, setElementName, setFont, setForeground, setGuiParent, setLabel, setMaximumSize, setMinimumSize, setMsgDragEnter, setMsgDragExit, setMsgDragOver, setMsgDrop, setMsgFileDrop, setMsgMouseMoved, setMsgMouseOver, setMsgPopup, setName, setOid, setPopupMenu, setPreferences, setPreferredSize, setRef, setStateAttributes, setToolTipText, setUserObject, setVisible, showPopupMenu, showPopupMenu
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.guibuilder.framework.IDatasetMember
getElementName, getElementPath, isRootElement, setElementName
 

Field Detail

BOOLEAN

public static final int BOOLEAN
See Also:
Constant Field Values

STRING

public static final int STRING
See Also:
Constant Field Values

NUMBER

public static final int NUMBER
See Also:
Constant Field Values

DATE

public static final int DATE
See Also:
Constant Field Values

TIME

public static final int TIME
See Also:
Constant Field Values

ENUM

public static final int ENUM
See Also:
Constant Field Values

MULTILINE

public static final int MULTILINE
See Also:
Constant Field Values

INTEGER

public static final int INTEGER
See Also:
Constant Field Values

TABLE

public static final int TABLE
See Also:
Constant Field Values

TREE

public static final int TREE
See Also:
Constant Field Values

DATA_TYPE_NAMES

public static final java.lang.String[] DATA_TYPE_NAMES
Method Detail

getGuiType

public int getGuiType()
Liefert GUI_COMPONENT

Specified by:
getGuiType in class GuiMember

getDataType

public abstract int getDataType()
Liefert den Datentyp der Componente.

Denkbare Werte sind:


getDataTypeName

public static java.lang.String getDataTypeName(int dataType)
Liefert die Bezeichung zu dem Datentyp.

Parameters:
dataType -
Returns:

setValue

public void setValue(java.lang.Object o)
Setzt den Inhalt dieser Componente.

Diese Methode wird üblicherweise von den erbenden Komponenten überschrieben.

Die Eigenschaft "modified" der Komponente wird dabei auf "false" gesetzt.

See Also:
setModified(boolean), isModified()

getUnformatedValue

public abstract java.lang.Object getUnformatedValue()
Liefert den unformatierten Inhalt dieser Componente.


getValue

public abstract java.lang.Object getValue()
Liefert den Inhalt dieser Componente.

Wird hier null zurückgegeben, ist die Componente zu ignorieren; es handelt sich dann um nicht selektierte RadioButtons.


setDatasetValues

public void setDatasetValues(JDataSet ds)
Setzt den Inhalt der Komponente auf den Inhalt des Models der über getElementPath erreichbar ist. Wird von GuiTable und GuiTree überschrieben.

Specified by:
setDatasetValues in interface IDatasetComponent

getDatasetValues

public void getDatasetValues(JDataSet ds,
                             java.lang.String current)

getDatasetValues

public void getDatasetValues(JDataSet ds)
Der von der Komponente gehaltene Wert wird in den Dataset eingetragen.

Specified by:
getDatasetValues in interface IDatasetComponent
Parameters:
ds -

commitChanges

public void commitChanges()
Teilt der Komponente mit, daß die Benutzereingaben erfolgreich verarbeitet wurden. Zumeist wird die Eigenschaft "modified" nur auf "false" gesetzt.

Specified by:
commitChanges in interface IDatasetComponent

isModified

public final boolean isModified()
Liefert das Kennzeichen, ob der Inhalt der Komponente vom Benutzer verändert wurde.

Wird der Inhalt per Programm mit setValue() gefüllt, wird modified auf false gesetzt.


setModified

public final void setModified(boolean b)
Setzt das Änderungskennzeichen neu. Wenn true, wird dieses auch an RootPane weiter verpetzt.

See Also:
isModified(), setValue(java.lang.Object), GuiRootPane.setModified(boolean)

isNotnull

public final boolean isNotnull()
Liefert das Kennzeichen "Pflichtfeld".

See Also:
GuiUtil.setCheckNN(boolean)

setNotnull

public final void setNotnull(boolean b)
Setzt das Kennzeichen "Pflichtfeld". In GuiBuilder.properties kann unter "notNullBackgroundColor" eine Farbe für den Hintergrund der Komponente abgelegt werden; z.B. 243,243,192

Es wird ein InputVerifier für NotNull gesetzt wenn true.

See Also:
GuiInputVerifier

getMaxlen

public final int getMaxlen()
Liefert die maximale Eingabelänge z.B. von Textfeldern.


setMaxlen

public final void setMaxlen(int len)
Setzt die maximale Eingabelänge z.B. für Textfelder.

Es wird ein InputVerifier gesetzt.

See Also:
GuiInputVerifier

getMinlen

public final int getMinlen()
Liefert die minimale Eingabelänge z.B. von Textfeldern.


setMinlen

public final void setMinlen(int len)
Setzt die minimale Eingabelänge z.B. für Textfelder.

Es wird ein InputVerifier gesetzt.

See Also:
GuiInputVerifier

verify

public final void verify()
                  throws java.lang.IllegalStateException
Ruft den InputVerifier der Componente auf.

Specified by:
verify in class GuiMember
Throws:
java.lang.IllegalStateException - , wenn Eingaben unzulässig.
See Also:
GuiContainer.verify()

postProc

public void postProc()
Diese Methode wird aufgerufen, nachdem der Benutzer eine Änderung an dem Eingabefeld vorgenommen hat. Sie ist hier leer implementiert und kann (z.B. bei Plugins) überschrieben werden.


getGuiComponent

public final GuiComponent getGuiComponent()
Returns:
GuiComponent
See Also:
TableColumnAble

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getLabel

public final java.lang.String getLabel()
Überschreibt die Methode der Oberklasse, um bei Pflichtfeldern eine Ergänzung des Labels vorzunehmen (sofern in der GuiBuilderConfig.xml ein solches Zeichen definiert ist).

Overrides:
getLabel in class GuiMember