Migrate to renderGridCellContents(RenderContext, HtmlWriter) (#1077)

labkey-adam · web-flow · commit d77aef596d9b · 2025-05-19T10:37:42.000-07:00
diff --git a/src/org/labkey/targetedms/TargetedMSSchema.java b/src/org/labkey/targetedms/TargetedMSSchema.java
@@ -118,8 +118,6 @@
 import org.springframework.validation.BindException;
 import org.springframework.web.servlet.mvc.Controller;
 
-import java.io.IOException;
-import java.io.Writer;
 import java.sql.SQLException;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -135,6 +133,8 @@
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
+import static org.labkey.api.util.DOM.EM;
+
 public class TargetedMSSchema extends UserSchema
 {
     public static final String SCHEMA_NAME = "targetedms";
@@ -805,7 +805,6 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)
                     {
                         return new DataColumn(colInfo)
                         {
-
                             @Override
                             public @NotNull Set<ClientDependency> getClientDependencies()
                             {
@@ -815,7 +814,7 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)
                             }
 
                             @Override
-                            public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
+                            public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
                             {
                                 Long runId = ctx.get(this.getColumnInfo().getFieldKey(), Long.class);
                                 if (runId != null)
@@ -825,11 +824,11 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit
                                     if(run != null)
                                     {
                                         PopupMenu menu = TargetedMSController.createDownloadMenu(run);
-                                        menu.render(oldWriter);
+                                        menu.render(out);
                                     }
                                     else
                                     {
-                                        oldWriter.write("<em>Not available</em>");
+                                        EM("Not available").appendTo(out);
                                     }
                                 }
                             }
diff --git a/src/org/labkey/targetedms/query/ChromatogramDisplayColumnFactory.java b/src/org/labkey/targetedms/query/ChromatogramDisplayColumnFactory.java
@@ -23,27 +23,25 @@
 import org.labkey.api.data.RenderContext;
 import org.labkey.api.query.FieldKey;
 import org.labkey.api.util.GUID;
-import org.labkey.api.util.PageFlowUtil;
 import org.labkey.api.view.ActionURL;
 import org.labkey.api.view.HttpView;
 import org.labkey.api.writer.HtmlWriter;
 import org.labkey.targetedms.TargetedMSController;
 import org.labkey.targetedms.view.ChromatogramsDataRegion;
 import org.springframework.web.servlet.mvc.Controller;
 
-import java.io.IOException;
-import java.io.Writer;
 import java.util.Set;
 import java.util.function.Consumer;
 
+import static org.labkey.api.util.DOM.A;
+import static org.labkey.api.util.DOM.Attribute.alt;
+import static org.labkey.api.util.DOM.Attribute.name;
+import static org.labkey.api.util.DOM.Attribute.style;
+import static org.labkey.api.util.DOM.DIV;
+import static org.labkey.api.util.DOM.at;
 import static org.labkey.targetedms.view.ChromatogramsDataRegion.FRAGMENT_PREFIX;
 import static org.labkey.targetedms.view.ChromatogramsDataRegion.HIGHLIGHTED_CHROMATOGRAM_PARAMETER_NAME;
 
-/**
- * User: vsharma
- * Date: 5/3/12
- * Time: 9:10 PM
- */
 public class ChromatogramDisplayColumnFactory implements DisplayColumnFactory
 {
     private final Container _container;
@@ -156,8 +154,8 @@ public ChromatogramDisplayColumnFactory(Container container, Type type,
     @Override
     public DisplayColumn createRenderer(ColumnInfo colInfo)
     {
-        return new DataColumn(colInfo) {
-
+        return new DataColumn(colInfo)
+        {
             @Override
             public boolean isFilterable()
             {
@@ -171,7 +169,7 @@ public boolean isSortable()
             }
 
             @Override
-            public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
+            public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
             {
                 Object id = getValue(ctx);  // Primary key from the relevant table
                 if(null == id)
@@ -204,13 +202,20 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit
 
                 ChromatogramsDataRegion dataRegion = (ChromatogramsDataRegion)ctx.getCurrentRegion();
 
-                String html = "<a name=\"" + FRAGMENT_PREFIX + id + "\"></a>";
-                html += "<div alt=\"Chromatogram " + PageFlowUtil.filter(sampleName) + "\" style=\"border: " + (highlight ? "beige" : "white") +
-                        " solid 8px; width:" + (_chartWidth + 16) + "px; min-height:" + (_chart_height + 50) + "px\" id=\"" + PageFlowUtil.filter(domId) + "\"></div>" +
-                        "<div style=\"text-align: center\" id=\"" + PageFlowUtil.filter(domLabelId) + "\"></div>";
+                A(at(name,FRAGMENT_PREFIX + id )).appendTo(out);
+                DIV(
+                    at(
+                        alt, "Chromatogram " + sampleName,
+                        style, "border: " + (highlight ? "beige" : "white") + " solid 8px; width:" + (_chartWidth + 16) + "px; min-height:" + (_chart_height + 50) + "px"
+                    ).id(domId)
+                ).appendTo(out);
+                DIV(
+                    at(
+                        style, "text-align: center"
+                    ).id(domLabelId)
+                ).appendTo(out);
 
                 dataRegion.addSVG(chromAction.getLocalURIString(), domId, domLabelId);
-                oldWriter.write(html);
             }
 
             @Override
diff --git a/src/org/labkey/targetedms/query/QCFolderDisplayColumnFactory.java b/src/org/labkey/targetedms/query/QCFolderDisplayColumnFactory.java
@@ -9,18 +9,18 @@
 import org.labkey.api.security.User;
 import org.labkey.api.security.permissions.ReadPermission;
 import org.labkey.api.targetedms.TargetedMSService;
-import org.labkey.api.util.PageFlowUtil;
+import org.labkey.api.util.LinkBuilder;
 import org.labkey.api.writer.HtmlWriter;
 import org.labkey.targetedms.TargetedMSManager;
 import org.labkey.targetedms.TargetedMSModule;
 import org.labkey.targetedms.TargetedMSRun;
 
-import java.io.IOException;
-import java.io.Writer;
 import java.util.Objects;
 import java.util.Set;
 import java.util.TreeSet;
 
+import static org.labkey.api.util.DOM.DIV;
+
 public class QCFolderDisplayColumnFactory implements DisplayColumnFactory
 {
     public QCFolderDisplayColumnFactory()
@@ -33,7 +33,7 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)
         return new DataColumn(colInfo)
         {
             @Override
-            public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
+            public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
             {
                 final User user = ctx.getViewContext().getUser();
                 String serialNumber = String.valueOf(getBoundColumn().getValue(ctx));
@@ -50,22 +50,15 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit
                         }
                     }
                 });
-                StringBuilder sb = new StringBuilder();
                 qcContainers.forEach(qcContainer -> {
                     var url = qcContainer.getStartURL(user);
                     if (null != currentRunId)
                     {
                         url.addParameter("RunId", currentRunId.toString());
                     }
                     url.addReturnUrl(ctx.getViewContext().getActionURL());
-                    sb.append("<div><a href=\"")
-                            .append(PageFlowUtil.filter(url))
-                            .append("\"")
-                            .append(">")
-                            .append(PageFlowUtil.filter(qcContainer.getName()))
-                            .append("</a></div>");
+                    DIV(LinkBuilder.simpleLink(qcContainer.getName(), url)).appendTo(out);
                 });
-                oldWriter.write(sb.toString());
             }
         };
     }
diff --git a/src/org/labkey/targetedms/query/RepresentativeStateDisplayColumn.java b/src/org/labkey/targetedms/query/RepresentativeStateDisplayColumn.java
@@ -21,14 +21,10 @@
 import org.labkey.api.targetedms.RepresentativeDataState;
 import org.labkey.api.writer.HtmlWriter;
 
-import java.io.IOException;
-import java.io.Writer;
+import static org.labkey.api.util.DOM.Attribute.style;
+import static org.labkey.api.util.DOM.SPAN;
+import static org.labkey.api.util.DOM.at;
 
-/**
- * User: vsharma
- * Date: 8/5/13
- * Time: 8:32 PM
- */
 public class RepresentativeStateDisplayColumn extends DataColumn
 {
     public RepresentativeStateDisplayColumn (ColumnInfo columnInfo)
@@ -37,23 +33,29 @@ public RepresentativeStateDisplayColumn (ColumnInfo columnInfo)
     }
 
     @Override
-    public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
+    public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
     {
         Object representativeState = getValue(ctx);
         if (representativeState == null)
             return;
 
         if (RepresentativeDataState.Representative.getLabel().equals(representativeState.toString()))
         {
-            oldWriter.write("<span style='color:green;'>" + representativeState.toString() + "</span>");
+            SPAN(
+                at(style, "color:green;"),
+                representativeState.toString()
+            ).appendTo(out);
         }
         else if (RepresentativeDataState.Conflicted.getLabel().equals(representativeState.toString()))
         {
-            oldWriter.write("<span style='color:red;'>" + representativeState.toString() + "</span>");
+            SPAN(
+                at(style, "color:red;"),
+                representativeState.toString()
+            ).appendTo(out);
         }
         else
         {
-            oldWriter.write(representativeState.toString());
+            out.write(representativeState.toString());
         }
     }
 }
diff --git a/src/org/labkey/targetedms/query/SampleFileTable.java b/src/org/labkey/targetedms/query/SampleFileTable.java
@@ -55,6 +55,7 @@
 import org.labkey.api.security.permissions.ReadPermission;
 import org.labkey.api.targetedms.TargetedMSService;
 import org.labkey.api.util.ContainerContext;
+import org.labkey.api.util.HtmlString;
 import org.labkey.api.util.PageFlowUtil;
 import org.labkey.api.util.Pair;
 import org.labkey.api.view.ActionURL;
@@ -80,6 +81,8 @@
 import java.util.Map;
 import java.util.Set;
 
+import static org.labkey.api.util.DOM.EM;
+
 public class SampleFileTable extends TargetedMSTable
 {
     @Nullable
@@ -352,7 +355,7 @@ public DownloadLinkColumn(ColumnInfo col)
         }
 
         @Override
-        public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
+        public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
         {
             Long sampleFileId = ctx.get(this.getColumnInfo().getFieldKey(), Long.class);
             Container container = ctx.get(_containerFieldKey, Container.class);
@@ -370,21 +373,21 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit
                         String size = dataSize != null ? FileUtils.byteCountToDisplaySize(dataSize) : "";
                         ExpData expData = downloadInfo.getExpData();
                         String url = expData.getWebDavURL(FileContentService.PathType.full).toString();
-                        if(!downloadInfo.isFile())
+                        if (!downloadInfo.isFile())
                         {
                             int idx = url.lastIndexOf('/');
                             url = idx != -1 ? url.substring(0, idx) : url;
                             url = url + "?method=zip&depth=-1&file=" + PageFlowUtil.encode(expData.getName()) + "&zipName=" + PageFlowUtil.encode(expData.getName());
                         }
 
-                        oldWriter.write(PageFlowUtil.iconLink("fa fa-download", null).href(url).toString());
-                        oldWriter.write("&nbsp;");
-                        oldWriter.write(PageFlowUtil.filter(size));
+                        out.write(PageFlowUtil.iconLink("fa fa-download", null).href(url));
+                        out.write(HtmlString.NBSP);
+                        out.write(size);
                         return;
                     }
                 }
             }
-            oldWriter.write("<em>Not available</em>");
+            EM("Not available").appendTo(out);
         }
 
         @Override

Original file line number	Diff line number	Diff line change
`@@ -118,8 +118,6 @@`
`118`	`118`	`import org.springframework.validation.BindException;`
`119`	`119`	`import org.springframework.web.servlet.mvc.Controller;`
`120`	`120`
`121`		`-import java.io.IOException;`
`122`		`-import java.io.Writer;`
`123`	`121`	`import java.sql.SQLException;`
`124`	`122`	`import java.util.ArrayList;`
`125`	`123`	`import java.util.Arrays;`
`@@ -135,6 +133,8 @@`
`135`	`133`	`import java.util.function.Consumer;`
`136`	`134`	`import java.util.stream.Collectors;`
`137`	`135`
	`136`	`+import static org.labkey.api.util.DOM.EM;`
	`137`	`+`
`138`	`138`	`public class TargetedMSSchema extends UserSchema`
`139`	`139`	`{`
`140`	`140`	`public static final String SCHEMA_NAME = "targetedms";`
`@@ -805,7 +805,6 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)`
`805`	`805`	`{`
`806`	`806`	`return new DataColumn(colInfo)`
`807`	`807`	`{`
`808`		`-`
`809`	`808`	`@Override`
`810`	`809`	`public @NotNull Set<ClientDependency> getClientDependencies()`
`811`	`810`	`{`
`@@ -815,7 +814,7 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)`
`815`	`814`	`}`
`816`	`815`
`817`	`816`	`@Override`
`818`		`- public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException`
	`817`	`+ public void renderGridCellContents(RenderContext ctx, HtmlWriter out)`
`819`	`818`	`{`
`820`	`819`	`Long runId = ctx.get(this.getColumnInfo().getFieldKey(), Long.class);`
`821`	`820`	`if (runId != null)`
`@@ -825,11 +824,11 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit`
`825`	`824`	`if(run != null)`
`826`	`825`	`{`
`827`	`826`	`PopupMenu menu = TargetedMSController.createDownloadMenu(run);`
`828`		`- menu.render(oldWriter);`
	`827`	`+ menu.render(out);`
`829`	`828`	`}`
`830`	`829`	`else`
`831`	`830`	`{`
`832`		`- oldWriter.write("<em>Not available</em>");`
	`831`	`+ EM("Not available").appendTo(out);`
`833`	`832`	`}`
`834`	`833`	`}`
`835`	`834`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,14 +21,10 @@`
`21`	`21`	`import org.labkey.api.targetedms.RepresentativeDataState;`
`22`	`22`	`import org.labkey.api.writer.HtmlWriter;`
`23`	`23`
`24`		`-import java.io.IOException;`
`25`		`-import java.io.Writer;`
	`24`	`+import static org.labkey.api.util.DOM.Attribute.style;`
	`25`	`+import static org.labkey.api.util.DOM.SPAN;`
	`26`	`+import static org.labkey.api.util.DOM.at;`
`26`	`27`
`27`		`-/**`
`28`		`- * User: vsharma`
`29`		`- * Date: 8/5/13`
`30`		`- * Time: 8:32 PM`
`31`		`- */`
`32`	`28`	`public class RepresentativeStateDisplayColumn extends DataColumn`
`33`	`29`	`{`
`34`	`30`	`public RepresentativeStateDisplayColumn (ColumnInfo columnInfo)`
`@@ -37,23 +33,29 @@ public RepresentativeStateDisplayColumn (ColumnInfo columnInfo)`
`37`	`33`	`}`
`38`	`34`
`39`	`35`	`@Override`
`40`		`- public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException`
	`36`	`+ public void renderGridCellContents(RenderContext ctx, HtmlWriter out)`
`41`	`37`	`{`
`42`	`38`	`Object representativeState = getValue(ctx);`
`43`	`39`	`if (representativeState == null)`
`44`	`40`	`return;`
`45`	`41`
`46`	`42`	`if (RepresentativeDataState.Representative.getLabel().equals(representativeState.toString()))`
`47`	`43`	`{`
`48`		`- oldWriter.write("<span style='color:green;'>" + representativeState.toString() + "</span>");`
	`44`	`+ SPAN(`
	`45`	`+ at(style, "color:green;"),`
	`46`	`+ representativeState.toString()`
	`47`	`+ ).appendTo(out);`
`49`	`48`	`}`
`50`	`49`	`else if (RepresentativeDataState.Conflicted.getLabel().equals(representativeState.toString()))`
`51`	`50`	`{`
`52`		`- oldWriter.write("<span style='color:red;'>" + representativeState.toString() + "</span>");`
	`51`	`+ SPAN(`
	`52`	`+ at(style, "color:red;"),`
	`53`	`+ representativeState.toString()`
	`54`	`+ ).appendTo(out);`
`53`	`55`	`}`
`54`	`56`	`else`
`55`	`57`	`{`
`56`		`- oldWriter.write(representativeState.toString());`
	`58`	`+ out.write(representativeState.toString());`
`57`	`59`	`}`
`58`	`60`	`}`
`59`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@`
`55`	`55`	`import org.labkey.api.security.permissions.ReadPermission;`
`56`	`56`	`import org.labkey.api.targetedms.TargetedMSService;`
`57`	`57`	`import org.labkey.api.util.ContainerContext;`
	`58`	`+import org.labkey.api.util.HtmlString;`
`58`	`59`	`import org.labkey.api.util.PageFlowUtil;`
`59`	`60`	`import org.labkey.api.util.Pair;`
`60`	`61`	`import org.labkey.api.view.ActionURL;`
`@@ -80,6 +81,8 @@`
`80`	`81`	`import java.util.Map;`
`81`	`82`	`import java.util.Set;`
`82`	`83`
	`84`	`+import static org.labkey.api.util.DOM.EM;`
	`85`	`+`
`83`	`86`	`public class SampleFileTable extends TargetedMSTable`
`84`	`87`	`{`
`85`	`88`	`@Nullable`
`@@ -352,7 +355,7 @@ public DownloadLinkColumn(ColumnInfo col)`
`352`	`355`	`}`
`353`	`356`
`354`	`357`	`@Override`
`355`		`- public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException`
	`358`	`+ public void renderGridCellContents(RenderContext ctx, HtmlWriter out)`
`356`	`359`	`{`
`357`	`360`	`Long sampleFileId = ctx.get(this.getColumnInfo().getFieldKey(), Long.class);`
`358`	`361`	`Container container = ctx.get(_containerFieldKey, Container.class);`
`@@ -370,21 +373,21 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit`
`370`	`373`	`String size = dataSize != null ? FileUtils.byteCountToDisplaySize(dataSize) : "";`
`371`	`374`	`ExpData expData = downloadInfo.getExpData();`
`372`	`375`	`String url = expData.getWebDavURL(FileContentService.PathType.full).toString();`
`373`		`- if(!downloadInfo.isFile())`
	`376`	`+ if (!downloadInfo.isFile())`
`374`	`377`	`{`
`375`	`378`	`int idx = url.lastIndexOf('/');`
`376`	`379`	`url = idx != -1 ? url.substring(0, idx) : url;`
`377`	`380`	`url = url + "?method=zip&depth=-1&file=" + PageFlowUtil.encode(expData.getName()) + "&zipName=" + PageFlowUtil.encode(expData.getName());`
`378`	`381`	`}`
`379`	`382`
`380`		`- oldWriter.write(PageFlowUtil.iconLink("fa fa-download", null).href(url).toString());`
`381`		`- oldWriter.write(" ");`
`382`		`- oldWriter.write(PageFlowUtil.filter(size));`
	`383`	`+ out.write(PageFlowUtil.iconLink("fa fa-download", null).href(url));`
	`384`	`+ out.write(HtmlString.NBSP);`
	`385`	`+ out.write(size);`
`383`	`386`	`return;`
`384`	`387`	`}`
`385`	`388`	`}`
`386`	`389`	`}`
`387`		`- oldWriter.write("<em>Not available</em>");`
	`390`	`+ EM("Not available").appendTo(out);`
`388`	`391`	`}`
`389`	`392`
`390`	`393`	`@Override`