Skip to content

DisplayColumn refactor #908

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

DisplayColumn refactor #908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
402b2d8
DisplayColumn refactor
labkey-adam Mar 12, 2025
2b48e7f
Remove unused methods from DisplayColumn, refactor
labkey-adam Mar 12, 2025
edb1c6b
Migrate renderGridCellContents() and renderDetailsCellContents()
labkey-adam Mar 13, 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
2 changes: 1 addition & 1 deletion ehr/api-src/org/labkey/api/ehr/table/DurationColumn.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public void setDropTime(boolean dropTime)
}

@Override
public Class getDisplayValueClass()
public Class<String> getDisplayValueClass()
{
//NOTE: this is required in order to get excel to output correctly
//the raw value is numeric, but the displayValue is text
Expand Down
21 changes: 14 additions & 7 deletions ehr/api-src/org/labkey/api/ehr/table/FixedWidthDisplayColumn.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
import org.labkey.api.data.ColumnInfo;
import org.labkey.api.data.DataColumn;
import org.labkey.api.data.RenderContext;
import org.labkey.api.util.DOM;
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.DIV;
import static org.labkey.api.util.DOM.at;

public class FixedWidthDisplayColumn extends DataColumn
{
private int _maxWidth;
private final int _maxWidth;

public FixedWidthDisplayColumn(ColumnInfo col, int maxWidth)
{
Expand All @@ -18,10 +21,14 @@ public FixedWidthDisplayColumn(ColumnInfo col, int maxWidth)
}

@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
{
out.write("<div style=\"max-width:" + _maxWidth + ";\">");
super.renderGridCellContents(ctx, out);
out.write("</div>");
DIV(
at(style, "max-width:" + _maxWidth + ";"),
(DOM.Renderable) ret -> {
super.renderGridCellContents(ctx, out);
return ret;
}
).appendTo(out);
}
}
11 changes: 6 additions & 5 deletions ehr/api-src/org/labkey/api/ehr/table/VetReviewDisplayColumn.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
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;
Expand All @@ -24,7 +25,7 @@ public VetReviewDisplayColumn(ColumnInfo col)
}

@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
{
Object o = getValue(ctx);
if (o != null)
Expand All @@ -37,7 +38,7 @@ public void renderGridCellContents(RenderContext ctx, Writer out) throws IOExcep
part = StringUtils.trimToNull(part);
String[] tokens = part.split("<>");

out.write(delim);
oldWriter.write(delim);
delim = "<br><br>";
//String key = StringUtils.trimToNull(tokens[0]);
String text = StringUtils.trimToNull(tokens[1]);
Expand All @@ -47,15 +48,15 @@ public void renderGridCellContents(RenderContext ctx, Writer out) throws IOExcep
text = text.replaceAll("\\*\\*", "<span style=\"background-color: yellow;\">\\*\\*</span>");
}

out.write("<a style=\"max-width: 500px;\" class=\"labkey-text-link vrdc-row\" data-objectid=\"" + PageFlowUtil.filter(StringUtils.trimToNull(tokens[2])) + "\">");
oldWriter.write("<a style=\"max-width: 500px;\" class=\"labkey-text-link vrdc-row\" data-objectid=\"" + PageFlowUtil.filter(StringUtils.trimToNull(tokens[2])) + "\">");

if (!_clickHandlerRegistered)
{
HttpView.currentPageConfig().addHandlerForQuerySelector("a.vrdc-row", "click", "EHR.panel.ClinicalManagementPanel.replaceSoap({objectid: this.attributes.getNamedItem('data-objectid').value, scope: this, callback: function(){EHR.panel.ClinicalManagementPanel.updateVetColumn(this, arguments[0], arguments[1]);}});" );
_clickHandlerRegistered = true;
}
out.write(text);
out.write("</a>");
oldWriter.write(text);
oldWriter.write("</a>");
}
}
}
Expand Down
5 changes: 3 additions & 2 deletions ehr/src/org/labkey/ehr/table/DefaultEHRCustomizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
import org.labkey.api.view.HttpView;
import org.labkey.api.view.NavTree;
import org.labkey.api.view.template.ClientDependency;
import org.labkey.api.writer.HtmlWriter;
import org.labkey.ehr.EHRModule;
import org.labkey.ehr.EHRSchema;

Expand Down Expand Up @@ -824,13 +825,13 @@ public DisplayColumn createRenderer(final ColumnInfo colInfo)
return new DataColumn(colInfo)
{
@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
{
Object objectid = ctx.get("objectid");
Date date = (Date) ctx.get("date");
Object id = ctx.get(ID_COL);

out.write("<span style=\"white-space:nowrap\"><a class=\"labkey-text-link anm-history\" data-id=\"" + PageFlowUtil.filter(id) + "\">[Show Hx]</a></span>");
oldWriter.write("<span style=\"white-space:nowrap\"><a class=\"labkey-text-link anm-history\" data-id=\"" + PageFlowUtil.filter(id) + "\">[Show Hx]</a></span>");
if (!_clickHandlerAdded)
{
HttpView.currentPageConfig().addHandlerForQuerySelector("a.anm-history", "click", "EHR.window.ClinicalHistoryWindow.showClinicalHistory(null , this.attributes.getNamedItem('data-id').value, null, this);");
Expand Down
7 changes: 4 additions & 3 deletions ehr/src/org/labkey/ehr/table/SNOMEDCodesDisplayColumn.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.labkey.api.data.RenderContext;
import org.labkey.api.query.FieldKey;
import org.labkey.api.view.template.ClientDependency;
import org.labkey.api.writer.HtmlWriter;

import java.io.IOException;
import java.io.Writer;
Expand All @@ -47,7 +48,7 @@ public SNOMEDCodesDisplayColumn(ColumnInfo col)
}

@Override
public void renderGridCellContents(RenderContext ctx, Writer out) throws IOException
public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
{
Object o = getValue(ctx);
if (o != null)
Expand Down Expand Up @@ -85,9 +86,9 @@ public void renderGridCellContents(RenderContext ctx, Writer out) throws IOExcep
for (Integer sort : ret.keySet())
{
text = ret.get(sort).replaceAll("\\r?\\n", "<br>");
out.write(delim);
oldWriter.write(delim);
delim = "<br>";
out.write(text);
oldWriter.write(text);
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion snd/api-src/org/labkey/api/snd/PlainTextNarrativeDisplayColumn.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package org.labkey.api.snd;

import org.jetbrains.annotations.NotNull;
import org.labkey.api.data.ColumnInfo;
import org.labkey.api.data.DataColumn;
import org.labkey.api.data.RenderContext;
Expand All @@ -28,7 +29,7 @@ public PlainTextNarrativeDisplayColumn(ColumnInfo col)
}

@Override
public HtmlString getFormattedHtml(RenderContext ctx)
public @NotNull HtmlString getFormattedHtml(RenderContext ctx)
{
String htmlNarrative = (String)ctx.get(getColumnInfo().getFieldKey());
return HtmlString.of(removeHtmlTagsFromNarrative(htmlNarrative));
Expand Down