ro.sync.ecss.extensions.api.editor
Class AbstractInplaceEditor

java.lang.Object
  ro.sync.ecss.extensions.api.editor.AbstractInplaceEditor

All Implemented Interfaces:

InplaceEditor, Extension

Direct Known Subclasses:

SimpleURLChooserEditor, URLChooserEditorSWT

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class AbstractInplaceEditor
extends java.lang.Object
implements InplaceEditor

An abstract implementation that handles listeners fire.

Since:

14.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Constructor Summary

AbstractInplaceEditor()

Method Summary

void	addEditingListener(InplaceEditingListener editingListener) Adds a listener to receive edit notifications: - InplaceEditingListener.editingCanceled() to remove the editor and cancel the edit operation.
protected void	fireCommitValue(EditingEvent event) Notify the interested listeners that the current value must be committed.
protected void	fireEditingCanceled() Notify the interested listeners that the editing was canceled.
protected void	fireEditingOccured() Notify the interested listeners that an edit occurred inside the editor.
protected void	fireEditingStopped(EditingEvent event) Notify the interested listeners that the editing stopped.
protected void	fireNextEditLocationRequested() Notify the interested listeners that the next edit position was requested.
protected void	firePreviousEditLocationRequested() Notify the interested listeners that the previous edit position was requested.
void	removeEditingListener(InplaceEditingListener editingListener) Removes a listener that receives editing events.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ro.sync.ecss.extensions.api.editor.InplaceEditor

cancelEditing, getEditorComponent, getScrollRectangle, getValue, requestFocus, stopEditing

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Constructor Detail

AbstractInplaceEditor

public AbstractInplaceEditor()

Method Detail

fireEditingStopped

protected void fireEditingStopped(EditingEvent event)

Notify the interested listeners that the editing stopped.

Parameters:

event - Editing event.

fireEditingCanceled

protected void fireEditingCanceled()

Notify the interested listeners that the editing was canceled.

fireEditingOccured

protected void fireEditingOccured()

Notify the interested listeners that an edit occurred inside the editor.

fireNextEditLocationRequested

protected void fireNextEditLocationRequested()

Notify the interested listeners that the next edit position was requested.

firePreviousEditLocationRequested

protected void firePreviousEditLocationRequested()

Notify the interested listeners that the previous edit position was requested.

addEditingListener

public final void addEditingListener(InplaceEditingListener editingListener)

Description copied from interface: InplaceEditor

Adds a listener to receive edit notifications: - InplaceEditingListener.editingCanceled() to remove the editor and cancel the edit operation. - InplaceEditingListener.editingOccured() to signal modification in the editor. This event marks the editor as dirty and it's value will be committed when a InplaceEditingListener.editingStopped(EditingEvent) is received. - InplaceEditingListener.editingStopped(EditingEvent) to end editing and commit it's value if needed. The value is usually committed ONLY if a InplaceEditingListener.editingOccured() was fired. See InplaceEditingListener.editingStopped(EditingEvent) for more information.

Specified by:

addEditingListener in interface InplaceEditor

Parameters:

editingListener - Editing listener.

See Also:

InplaceEditor.addEditingListener(ro.sync.ecss.extensions.api.editor.InplaceEditingListener)

removeEditingListener

public final void removeEditingListener(InplaceEditingListener editingListener)

Description copied from interface: InplaceEditor

Removes a listener that receives editing events.

Specified by:

removeEditingListener in interface InplaceEditor

Parameters:

editingListener - Editing listener.

See Also:

InplaceEditor.removeEditingListener(ro.sync.ecss.extensions.api.editor.InplaceEditingListener)

fireCommitValue

protected void fireCommitValue(EditingEvent event)

Notify the interested listeners that the current value must be committed.

Parameters:

event - Editing event.