Skip to content

DisplayColumn refactor #341

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
merged 2 commits into from
Mar 18, 2025
Merged

DisplayColumn refactor #341

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
cc656e6
Migrate renderGridCellContents() and renderDetailsCellContents()
labkey-adam Mar 13, 2025
676ff32
Finish migration (#342)
bbimber Mar 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
13 changes: 6 additions & 7 deletions ...eAnalysis/src/org/labkey/sequenceanalysis/query/DownloadSequenceDisplayColumnFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@
import org.labkey.api.util.PageFlowUtil;
import org.labkey.api.view.HttpView;
import org.labkey.api.view.template.ClientDependency;
import org.labkey.api.writer.HtmlWriter;

import java.io.IOException;
import java.io.Writer;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Map;
Expand All @@ -38,12 +37,12 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)
private boolean _handlerRegistered = false;

@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
{
Object val = ctx.get(FieldKey.fromString(getBoundColumn().getFieldKey().getParent(), "rowId"));
out.write(PageFlowUtil.link("Download Sequence").attributes(Map.of(
"data-rowid", val.toString()
)).addClass("sdc-row").toString());
Integer val = ctx.get(FieldKey.fromString(getBoundColumn().getFieldKey().getParent(), "rowId"), Integer.class);
out.write(PageFlowUtil.link("Download Sequence").
attributes(Map.of("data-rowid", val.toString())).
addClass("sdc-row"));

if (!_handlerRegistered)
{
Expand Down
15 changes: 8 additions & 7 deletions SequenceAnalysis/src/org/labkey/sequenceanalysis/query/GenbankDisplayColumnFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
import org.labkey.api.data.DisplayColumnFactory;
import org.labkey.api.data.RenderContext;
import org.labkey.api.util.PageFlowUtil;
import org.labkey.api.util.URLHelper;
import org.labkey.api.writer.HtmlWriter;

import java.io.IOException;
import java.io.Writer;
Expand All @@ -23,26 +25,25 @@ public GenbankDisplayColumnFactory()
@Override
public DisplayColumn createRenderer(ColumnInfo colInfo)
{
DataColumn ret = new DataColumn(colInfo)
return new DataColumn(colInfo)
{
@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
{
Object val = ctx.get(getBoundColumn().getFieldKey());
String val = ctx.get(getBoundColumn().getFieldKey(), String.class);
if (val != null)
{
String[] vals = String.valueOf(val).replaceAll("\\s+", "").split(";|,");
String[] vals = val.replaceAll("\\s+", "").split("[;,]");
String delim = "";
for (String v : vals)
{
out.write(delim + "<a href=" + getFormattedURL(v) + ">" + PageFlowUtil.encode(v) + "</a>");
out.write(delim);
out.write(PageFlowUtil.link(v).href(getFormattedURL(v)).clearClasses());
delim = "; ";
}
}
}
};

return ret;
}

protected String getFormattedURL(String v)
Expand Down
28 changes: 21 additions & 7 deletions SequenceAnalysis/src/org/labkey/sequenceanalysis/query/SequenceAnalysisCustomizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,15 @@
import org.labkey.api.query.QueryForeignKey;
import org.labkey.api.query.QueryService;
import org.labkey.api.security.User;
import org.labkey.api.util.HtmlString;
import org.labkey.api.util.HtmlStringBuilder;
import org.labkey.api.util.PageFlowUtil;
import org.labkey.api.view.ActionURL;
import org.labkey.api.view.HttpView;
import org.labkey.api.view.template.ClientDependency;
import org.labkey.api.writer.HtmlWriter;
import org.labkey.sequenceanalysis.SequenceAnalysisSchema;

import java.io.IOException;
import java.io.Writer;
import java.util.Collection;
import java.util.Set;

Expand All @@ -42,6 +43,8 @@
*/
public class SequenceAnalysisCustomizer implements TableCustomizer
{
private static final HtmlString COMMA_NEWLINE = HtmlStringBuilder.of(",").append(HtmlString.BR).getHtmlString();

@Override
public void customize(TableInfo tableInfo)
{
Expand Down Expand Up @@ -258,7 +261,7 @@ private FieldKey getBoundKey(String colName)
}

@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
{
Integer rowId = ctx.get(getBoundKey("rowId"), Integer.class);
if (rowId != null)
Expand All @@ -267,18 +270,29 @@ public void renderGridCellContents(RenderContext ctx, Writer out) throws IOExcep
if (value != null)
{
String[] tokens = value.split(",");
String delim = "";
HtmlString delim = HtmlString.EMPTY_STRING;
for (String token : tokens)
{
ActionURL url = QueryService.get().urlFor(ctx.getViewContext().getUser(), ctx.getContainer(), QueryAction.executeQuery, SequenceAnalysisSchema.SCHEMA_NAME, SequenceAnalysisSchema.TABLE_OUTPUTFILES);
url.addParameter("query.fileSets~contains", token);

out.write(delim + "<a href=\"" + url.getURIString() + "\"" + ">" + token + "</a>");
delim = ",<br>";
out.write(delim);
out.write(PageFlowUtil.link(token, url).clearClasses());
delim = COMMA_NEWLINE;
}
}

out.write("<a class=\"fa fa-pencil lk-dr-action-icon sfs-row\" data-tt=\"tooltip\" data-rowid=\"" + rowId +"\" data-original-title=\"add/edit\"></a>");
out.write(PageFlowUtil.link("").
clearClasses().
addClass("fa fa-pencil").
addClass("lk-dr-action-icon").
addClass("sfs-row").
attributes(PageFlowUtil.map(
"data-tt", "tooltip",
"data-rowid", rowId.toString(),
"data-original-title", "add/edit"
))
);

if (!_handlerRegistered)
{
Expand Down
21 changes: 10 additions & 11 deletions SequenceAnalysis/src/org/labkey/sequenceanalysis/query/SequenceAnalysisUserSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@
import org.labkey.api.query.SimpleUserSchema;
import org.labkey.api.security.User;
import org.labkey.api.sequenceanalysis.pipeline.SequenceOutputHandler;
import org.labkey.api.util.HtmlString;
import org.labkey.api.util.PageFlowUtil;
import org.labkey.api.view.ActionURL;
import org.labkey.api.writer.HtmlWriter;
import org.labkey.sequenceanalysis.SequenceAnalysisSchema;
import org.labkey.sequenceanalysis.SequenceAnalysisServiceImpl;

import java.io.IOException;
import java.io.Writer;
import java.util.Arrays;
import java.util.LinkedHashSet;

Expand Down Expand Up @@ -259,17 +259,15 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)
return new DataColumn(colInfo)
{
@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
{
Object o = getValue(ctx);
if (o != null)
{
ActionURL url = QueryService.get().urlFor(getUser(), ctx.getContainer(), QueryAction.executeQuery, SequenceAnalysisSchema.SCHEMA_NAME, SequenceAnalysisSchema.TABLE_READ_DATA);
url.addFilter("query", FieldKey.fromString("readset"), CompareType.EQUAL, o);

out.write("<a class=\"labkey-text-link\" href=\"" + url + "\">");
out.write("View File(s)");
out.write("</a>");
out.write(PageFlowUtil.link("View File(s)", url));
}
else
{
Expand Down Expand Up @@ -448,19 +446,20 @@ public DisplayColumn createRenderer(ColumnInfo colInfo)
return new DataColumn(colInfo)
{
@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
{
String result = StringUtils.trimToNull(super.getFormattedHtml(ctx).toString());
String delim = "";
HtmlString delim = HtmlString.EMPTY_STRING;
if (result != null)
{
String[] tokens = result.split(",");
for (String token : tokens)
{
String url = DetailsURL.fromString(_baseUrl + PageFlowUtil.encode(token), ctx.getContainer()).getActionURL().toString();
ActionURL url = DetailsURL.fromString(_baseUrl + PageFlowUtil.encode(token), ctx.getContainer()).getActionURL();

out.write(delim + "<a href=\"" + url + "\">" + token + "</a>");
delim = "<br>";
out.write(delim);
out.write(PageFlowUtil.link(token, url).clearClasses());
delim = HtmlString.BR;
}
}
}
Expand Down