Package ro.sync.ecss.extensions.api.webapp.formcontrols

Class WebappFormControlRenderer

  • All Implemented Interfaces:
    Extension
    @API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class WebappFormControlRenderer
extends java.lang.Object
implements Extension
    Common interface for server-side form control renderers used in the Web Author.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isChangeTrackingAware()
      The form control may be added on elements that have been inserted or deleted as a tracked change, or it may be in a content range on which there is a review comment.
      void renderControl​(AuthorInplaceContext context, java.io.Writer out)
      Renders the form control with the given properties.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • WebappFormControlRenderer

        public WebappFormControlRenderer()

    • Method Detail

      • renderControl

        public void renderControl​(AuthorInplaceContext context,
                          java.io.Writer out)
                   throws java.io.IOException
        Renders the form control with the given properties.
        Parameters:
        context - The context in which the form control is rendered.
        out - The output to render the form control to.
        Throws:
        java.io.IOException

      • isChangeTrackingAware

        public boolean isChangeTrackingAware()

        The form control may be added on elements that have been inserted or deleted as a tracked change, or it may be in a content range on which there is a review comment.

        In these cases, if the method returns true, in the HTML rendering, there will be some additional HTML span elements that wrap the form-control markup (generated by the renderControl(AuthorInplaceContext, Writer) method.

        If the method returns false, comment and change markers will not be rendered over the form-control. This option is provided for backwards-compatibility reasons, so it is recommended to override this method and return true.

        Returns:
        true if the form-control is aware of comment and change-tracking markers.
        Since:
        20.1