[jira] [Created] (OFBIZ-11908) WidgetWorker should not write generated html to Appendable

["Daniel Watford (Jira)" <ji...@apache.org>]

Daniel Watford created OFBIZ-11908:
--------------------------------------

             Summary: WidgetWorker should not write generated html to Appendable
                 Key: OFBIZ-11908
                 URL: https://issues.apache.org/jira/browse/OFBIZ-11908
             Project: OFBiz
          Issue Type: Sub-task
          Components: framework/widget
            Reporter: Daniel Watford


WidgetWorker is used to create URLs, anchor links and hidden forms (to support hidden-form links). 

WidgetWorker doesn't just generate these elements but it also writes those elements to an Appendable object normally passed to it from classes like MacroScreenRenderer and MacroFormRenderer.

Requiring that an Appendable is passed to WidgetWorker unnecessarily forces behaviour onto the calling classes, when all that is really required is for the WidgetWorker to create the elements it has been asked. Calling classes can write the created elements to I/O as they see fit.

Further, WidgetWorker produces HTML elements rendered to string. By doing this WidgetWorker has assumed knowledge about how the elements are to be used (i.e. within an FTL macro parameter call) and has to apply appropriate encoding.

Rather than rendering a string, WidgetWorker should create data structures, such as JSoup's elements, to represent the requested elements. The calling classes can then decide how/where to render the elements.

The above changes are deemed necessary to allow the refactoring of MacroFormRenderer to proceed, as otherwise MacroFormRenderer will have to ensure knowledge of where elements are to be rendered is maintained in order for this information to be passed to WidgetWorker. This is not in-line with the refactoring efforts targeting MacroFormRenderer.

This changes will reduce the responsibilities of WidgetWorker. It shall be responsible for creating data structures to represent requested elements, without needing to know how to render those elements to a string or other I/O channel.

 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)