Interface FormControlEditingHelper


  • @API(type=NOT_EXTENDABLE,
         src=PUBLIC)
    public interface FormControlEditingHelper
    Helper class for editing using form controls.
    Since:
    15.2
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String EDIT_CONTENT
      Constant that indicates that the value to edit represents the content of an element (with possible XML structure)
      static java.lang.String EDIT_TEXT
      Constant that indicates that the value to edit represents the text content of an element.
    • Field Detail

      • EDIT_CONTENT

        static final java.lang.String EDIT_CONTENT
        Constant that indicates that the value to edit represents the content of an element (with possible XML structure)
        See Also:
        Constant Field Values
      • EDIT_TEXT

        static final java.lang.String EDIT_TEXT
        Constant that indicates that the value to edit represents the text content of an element.
        See Also:
        Constant Field Values
    • Method Detail

      • commitEditedValue

        void commitEditedValue​(AuthorElement elem,
                               java.lang.String toEdit,
                               java.lang.String valueToCommit)
        Commits the value edited by the user.
        Parameters:
        elem - The element whose value to edit.
        toEdit - The attribute name or #CONTENT if we are editing the content of an element or #TEXT to edit the text of the element. null means #TEXT.
        valueToCommit - The new value to be committed.
      • commitEditedValueForProcessingInstruction

        void commitEditedValueForProcessingInstruction​(AuthorParentNode elem,
                                                       java.lang.String toEdit,
                                                       java.lang.String valueToCommit)
        Commits the value edited by the user.
        Parameters:
        elem - The processing instruction whose value to edit.
        toEdit - The attribute name.
        valueToCommit - The new value to be committed.
        Since:
        21