Skip to content

Migrate to renderGridCellContents(RenderContext, HtmlWriter) #1077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
labkey-adam merged 2 commits into from
May 19, 2025
Merged

Migrate to renderGridCellContents(RenderContext, HtmlWriter) #1077

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ea3c9b
Migrate to renderGridCellContents(RenderContext, HtmlWriter)
labkey-adam May 15, 2025
787d7b7
Fix id
labkey-adam May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions src/org/labkey/targetedms/TargetedMSSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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";
Expand Down Expand Up @@ -805,7 +805,6 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)
{
return new DataColumn(colInfo)
{

@Override
public @NotNull Set<ClientDependency> getClientDependencies()
{
Expand All @@ -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)
Expand All @@ -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);
}
}
}
Expand Down
37 changes: 21 additions & 16 deletions src/org/labkey/targetedms/query/ChromatogramDisplayColumnFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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()
{
Expand All @@ -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)
Expand Down Expand Up @@ -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
Expand Down
17 changes: 5 additions & 12 deletions src/org/labkey/targetedms/query/QCFolderDisplayColumnFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand All @@ -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));
Expand All @@ -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());
}
};
}
Expand Down
24 changes: 13 additions & 11 deletions src/org/labkey/targetedms/query/RepresentativeStateDisplayColumn.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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());
}
}
}
15 changes: 9 additions & 6 deletions src/org/labkey/targetedms/query/SampleFileTable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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
Expand Down Expand Up @@ -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);
Expand All @@ -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
Expand Down