Package ro.sync.ecss.extensions.api.editor

Class EditingEvent

  • @API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class EditingEvent
extends java.lang.Object
    The in-place editing was stopped. It will provide the committed value if such a value exists for the current type of editor. For example a InplaceEditorCSSConstants.TYPE_BUTTON doesn't give such a value. In this case when the notification is received we will just invoke the action associated with the button. A custom form control that wants to perform more custom operation can wrap these on a Runnable and give then on the customEdit field. This is the recommended way for performing custom changes.
    Since:
    14.1

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Runnable customEdit
      If the form control performs custom editing(InplaceEditorCSSConstants.EDIT_CUSTOM) it can give this custom editing wrapped inside this runnable.
      boolean requestFocusInHost
      true if the focus should be requested inside the author component.
      IAuthorExtensionAction toInvoke
      The action to be invoked as a result for the edit event.
      java.lang.String val
      The value that the user accepted when the editing stopped.

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • val

        public java.lang.String val
        The value that the user accepted when the editing stopped. If the type of editor used can provide such a value. When editing an attribute value, an empty string will result in deleting the attribute.

      • requestFocusInHost

        public boolean requestFocusInHost
        true if the focus should be requested inside the author component. Depending on how the editing was stopped it might be necessary to skip requesting focus inside the author component. For example if the cause of the stop editing was a focus lost event, we should skip requesting focus since the focus has already a destination.

      • customEdit

        public final java.lang.Runnable customEdit
        If the form control performs custom editing(InplaceEditorCSSConstants.EDIT_CUSTOM) it can give this custom editing wrapped inside this runnable. This will ensure a more seamless integration by letting Oxygen decide when to make the custom changes.

    • Constructor Detail

      • EditingEvent

        public EditingEvent​(java.lang.String val)
        Constructor.
        Parameters:
        val - The value that the user accepted when the editing stopped.

      • EditingEvent

        public EditingEvent​(java.lang.Runnable toInvoke,
                    boolean requestFocus)
        Constructor.
        Parameters:
        toInvoke - The action to be invoked as a result for the edit event.
        requestFocus - true if the focus should be requested inside the author component. Depending on how the editing was stopped it might be necessary to skip requesting focus inside the author component. For example if the cause of the stop editing was a focus lost event, we should skip requesting focus since the focus has already a destination.

      • EditingEvent

        public EditingEvent​(IAuthorExtensionAction toInvoke)
        Constructor.
        Parameters:
        toInvoke - The action to be invoked as a result for the edit event.

      • EditingEvent

        public EditingEvent​(java.lang.String value,
                    boolean requestFocus)
        Constructor.
        Parameters:
        value - The value that the user accepted when the editing stopped.
        requestFocus - true if the focus should be requested inside the author component. Depending on how the editing was stopped it might be necessary to skip requesting focus inside the author component. For example if the cause of the stop editing was a focus lost event, we should skip requesting focus since the focus has already a destination.