@API(type=EXTENDABLE, src=PUBLIC) public interface InplaceEditingListener extends InplaceEditingTraversalListener
editingStopped(EditingEvent)
- a request to stop the editing and commit the value from the editor.
Unless a editingOccured()
is received the value will not be committed.editingOccured()
- signals an edit event inside the editor. This will mark
the value from the editor as being dirty and requiring committing.editingCanceled()
- a request to hide the editor without any commit.KeyListener
for handling key events like: ENTER to stop editing and ESCAPE to cancel it.FocusListener
to stop editing when the focus is given to a component that is not
part of the editor.DocumentListener
to fire editingOccured()
events (If the editor has a document).Modifier and Type | Method and Description |
---|---|
void |
commitValue(EditingEvent event)
Commit the given value inside the document without stopping the editing.
|
void |
editingCanceled()
An editing canceled request.
|
void |
editingOccured()
An edit happened in the inplace editor which could result in a document modification if the
new value will be committed.
|
void |
editingStopped(EditingEvent event)
An editing stopped request.
|
nextEditLocationRequested, previousEditLocationRequested
void editingStopped(EditingEvent event)
editingOccured()
event was received prior to this event.InplaceEditorArgumentKeys.INITIAL_VALUE
or, if missing,
InplaceEditorArgumentKeys.DEFAULT_VALUE
.event
- Provides information about the editing. If null
we should handle this as a cancel event.void editingCanceled()
void editingOccured()
editingOccured()
event
is received, the value from the editor will not be committed when the editing
is stopped. See editingStopped(EditingEvent)
for more information.void commitValue(EditingEvent event)
editingOccured()
event.event
- Editing event. Currently only the string value from within is of interest.
Also in case of custom form controls any given EditingEvent.customEdit
will
also be executed.© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.