Sirius.navigator.ui.attributes.editor

Interface BasicEditor

All Superinterfaces:

BasicContainer, EditorActivationDelegate, EditorUIDelegate

All Known Subinterfaces:

ComplexEditor, SimpleEditor

All Known Implementing Classes:

AbstractComplexEditor, AbstractComplexMetaAttributeEditor, AbstractSimpleEditor, AbstractSimpleMetaAttributeEditor, AdressenEditor, DefaultComplexEditor, DefaultComplexMetaAttributeArrayEditor, DefaultComplexMetaAttributeEditor, DefaultSimpleComplexMetaAttributeEditor, DefaultSimpleEditor, DefaultSimpleMetaAttributeEditor, ReadOnlyMetaAttributeEditor, SimpleBooleanEditor, SimpleBooleanMetaAttributeEditor, SimpleByteMetaAttributeEditor, SimpleCharacterMetaAttributeEditor, SimpleDateMetaAttributeEditor, SimpleDoubleMetaAttributeEditor, SimpleFloatMetaAttributeEditor, SimpleFromStringMetaAttributeEditor, SimpleIntegerMetaAttributeEditor, SimpleLongMetaAttributeEditor, SimpleObjectSelectionMetaAttributeEditor, SimpleShortMetaAttributeEditor, SimpleStringEditor, SimpleStringMetaAttributeEditor, SimpleStringSelectionMetaAttributeEditor, SimpleTextEditor

public interface BasicEditor
extends BasicContainer

Basisklasse aller simplen und komplexen Editoren.

Die Methoden stopEditing() und cancelEditing sollten
a) rekursiv auf allen untergeordneten Editoren aufgerufen werden
und
b) jeweils ein stopEditing bzw. cancelEditing Ereigniss auslösen.
Ein geeignter Listener sollte auf diese Ereginisse reagieren und dementsprechend die Werte der untergeordneten Objekte setzten.

Version:

$Revision$, $Date$

Author:

Pascal

Field Summary

Fields inherited from interface Sirius.navigator.ui.attributes.editor.EditorActivationDelegate

ACTIVE_CHILD_EDITOR_TREE

Fields inherited from interface Sirius.navigator.ui.attributes.editor.EditorUIDelegate

ACTIVE_CHILD_EDITOR

Method Summary

Modifier and Type	Method and Description
void	addEditorListener(EditorListener l) Adds a listener to the list that's notified when the editor stops, or cancels editing.
void	cancelEditing() Tells the editor to cancel editing and not accept any partially edited value.
Object	getId() Returns the id of the edited object or null if no value has been set.
Object	getProperty(String key) Fragt eine Eigenschaft des Editors ab.
Object	getValue() Returns the value contained in the editor.
boolean	isEditable(EventObject anEvent) Asks the editor if it can start editing using anEvent.
boolean	isValueChanged() Gibt an, ob der Wert durch den Editor verändert wurde.
boolean	isValueNew() Gibt an, daß ein neuer Wert durch den Editor hinzugefügt wurde.
void	removeEditorListener(EditorListener l) Removes a listener from the list that's notified.
boolean	setProperty(String key, Object value) Setzt eine Eigenschaft des Editors, z.B.
void	setValueChanged(boolean valueChanged) Gibt an, ob der Wert durch den Editor verändert wurde.
boolean	stopEditing() Tells the editor to stop editing and accept any partially edited value as the value of the editor.

Methods inherited from interface Sirius.navigator.ui.attributes.editor.BasicContainer

getActiveChildEditorTree, getChildEditors, getParentContainer, setActiveChildEditorTree

Methods inherited from interface Sirius.navigator.ui.attributes.editor.EditorActivationDelegate

addComplexEditor, addPropertyChangeListener, removeComplexEditor, removePropertyChangeListener

Methods inherited from interface Sirius.navigator.ui.attributes.editor.EditorUIDelegate

getActiveChildEditorId, getComponent, hideComplexEditorComponentUI, showComplexEditorComponentUI, uiChanged

Method Detail

getValue

Object getValue()

Returns the value contained in the editor. Returns null if no value has been set.

Returns:

the value contained in the editor

getId

Object getId()

Returns the id of the edited object or null if no value has been set.

Returns:

the id of the edited object

isEditable

boolean isEditable(EventObject anEvent)

Asks the editor if it can start editing using anEvent. anEvent is in the invoking component coordinate system. The editor can not assume the Component returned by getCellEditorComponent is installed. This method is intended for the use of client to avoid the cost of setting up and installing the editor component if editing is not possible. If editing can be started this method returns true.

Parameters:

anEvent - the event the editor should use to consider whether to begin editing or not

Returns:

true if editing can be started

See Also:

#shouldSelectCell

stopEditing

boolean stopEditing()

Tells the editor to stop editing and accept any partially edited value as the value of the editor. The editor returns false if editing was not stopped; this is useful for editors that validate and can not accept invalid entries.

Returns:

true if editing was stopped; false otherwise

cancelEditing

void cancelEditing()

Tells the editor to cancel editing and not accept any partially edited value.

addEditorListener

void addEditorListener(EditorListener l)

Adds a listener to the list that's notified when the editor stops, or cancels editing.

Parameters:

l - the CellEditorListener

removeEditorListener

void removeEditorListener(EditorListener l)

Removes a listener from the list that's notified.

Parameters:

l - the CellEditorListener

setProperty

boolean setProperty(String key,
                    Object value)

Setzt eine Eigenschaft des Editors, z.B. die Sprache.

Implementierende Klassen sollten zuerst super.setProperty() aufrufen, der return Wert gibt dann an, ob die Eigenschaft bereits der Superklasse bekannt war und schon gesetzt wurde.

Parameters:

key - Name der Eigenschaft

value - Wert der Eigenschaft

Returns:

true, wenn es sich um eine bekannte Eigenschaft gehandelt hat.

getProperty

Object getProperty(String key)

Fragt eine Eigenschaft des Editors ab.

z.B. die Sprache

Parameters:

key - DOCUMENT ME!

Returns:

Wert der Eigenschaft, oder null

isValueChanged

boolean isValueChanged()

Gibt an, ob der Wert durch den Editor verändert wurde.

Nach dem Aufruf dieser Methode, solle das changed flag automatisch auf false zurückgesetzt werden.
. Das changed flag sollte in der Methode stopEditing() auf true gesetzt werden, wenn getComponentValue() einen neuen Wert liefert.

Returns:

true, wenn sich der Wert geändert hat

setValueChanged

void setValueChanged(boolean valueChanged)

Gibt an, ob der Wert durch den Editor verändert wurde.

Das changed flag sollte in der Methode stopEditing() auf true gesetzt werden, wenn getComponentValue() einen neuen Wert liefert. Das changed flag sollte durch den parent editor automatisch auf false gesetzt werden (im editor Listener).
.

Parameters:

valueChanged - DOCUMENT ME!

isValueNew

boolean isValueNew()

Gibt an, daß ein neuer Wert durch den Editor hinzugefügt wurde.

Wird nur abgefragt, wenn isChanged() true liefert. Der parent Editor sollte das alte Objekt zur id des child Editors entfernen, das neue Objekt unter einer neuen negativen is hinzufügen und dem Editor diese neue id zuweisen.
Auch hier sollte das new flag zurückgesetzt werden.

return true, wenn sich der Wert neu ist

Returns:

DOCUMENT ME!