Skip to content

Stop double encoding button tooltips #6079

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 1 commit into from
Nov 21, 2024
Merged

Stop double encoding button tooltips #6079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 0 additions & 5 deletions api/src/org/labkey/api/jsp/JspBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,11 +482,6 @@ public ButtonBuilder button(String text)
return new ButtonBuilder(text);
}

public ButtonBuilder button(Renderable html)
{
return new ButtonBuilder(html);
}

public SelectBuilder select()
{
return new SelectBuilder();
Expand Down
17 changes: 10 additions & 7 deletions api/src/org/labkey/api/query/import.jsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,11 @@
<%@ page import="org.labkey.api.query.AbstractQueryImportAction" %>
<%@ page import="org.labkey.api.query.QueryUpdateService" %>
<%@ page import="org.labkey.api.util.HelpTopic" %>
<%@ page import="org.labkey.api.util.JavaScriptFragment" %>
<%@ page import="org.labkey.api.util.JsonUtil" %>
<%@ page import="org.labkey.api.util.Pair" %>
<%@ page import="org.labkey.api.view.HttpView" %>
<%@ page import="org.labkey.api.view.template.ClientDependencies" %>
<%@ page import="static org.labkey.api.util.HtmlString.NDASH" %>
<%@ page import="org.labkey.api.util.JavaScriptFragment" %>
<%@ page extends="org.labkey.api.jsp.JspBase"%>
<%!
@Override
Expand Down Expand Up @@ -53,8 +52,7 @@
extraFormFields += o.toString() + ",\n";
}


if (bean.urlExcelTemplates != null && bean.urlExcelTemplates.size() > 0)
if (bean.urlExcelTemplates != null && !bean.urlExcelTemplates.isEmpty())
{
if (bean.urlExcelTemplates.size() == 1)
{
Expand All @@ -72,7 +70,12 @@
<%= button("Download").onClick("window.location = document.getElementById('importTemplate').value;") %><br>&nbsp;<br>
<%
}
}%>
}

// We really want an en dash here; ignore IntelliJ which tries to replace this with a simple short dash.
//noinspection UnnecessaryUnicodeEscape
String ndash = "\u2013";
%>

<style>
.lk-import-expando .labkey-button {
Expand Down Expand Up @@ -102,7 +105,7 @@
<div class="panel-heading">
<h3 class="panel-title pull-left">Copy/paste text</h3>
<span class="lk-import-expando pull-right">
<%=button(NDASH).id(copyPasteDivId + "Expando") %>
<%=button(ndash).id(copyPasteDivId + "Expando") %>
</span>
<div class="clearfix"></div>
</div>
Expand Down Expand Up @@ -136,7 +139,7 @@

function toggleExpanded(toggleButton, toggleDiv, collapseButton, collapseDiv)
{
var collapsed = -1 !== toggleButton.dom.innerHTML.indexOf("+");
const collapsed = -1 !== toggleButton.dom.innerHTML.indexOf("+");
toggleButton.dom.innerHTML = collapsed ? "&ndash;" : "+";
toggleDiv.parent().setStyle("display",collapsed?"block":"none");

Expand Down
20 changes: 7 additions & 13 deletions api/src/org/labkey/api/util/Button.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
import org.apache.commons.lang3.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.labkey.api.data.RenderContext;
import org.labkey.api.util.DOM.Renderable;
import org.labkey.api.view.DisplayElement;
import org.labkey.api.view.HttpView;

Expand Down Expand Up @@ -53,7 +52,7 @@ public class Button extends DisplayElement implements HasHtmlString, SafeToRende
// Composable members
private final String cssClass;
private final String iconCls;
private final Renderable html; // required
private final String caption; // required
private final String href;
private final String onClick;
private final String id;
Expand All @@ -75,7 +74,7 @@ private Button(ButtonBuilder builder)
{
this.cssClass = builder.cssClass;
this.dropdown = builder.dropdown;
this.html = builder.html;
this.caption = builder.caption;
this.href = builder.href;
this.onClick = builder.onClick;
this.iconCls = builder.iconCls;
Expand Down Expand Up @@ -235,7 +234,7 @@ public HtmlString getHtmlString()
boolean iconOnly = getIconCls() != null;
String submitId = page.makeId("submit_");
// In the icon-only button case, use caption as tooltip. This avoids having to set both caption and tooltip
final Renderable tip = (null != tooltip ? HtmlString.of(tooltip) : (!iconOnly ? null : html));
final String tip = (null != tooltip ? tooltip : (iconOnly ? caption : null));
String clickHandler = generateOnClick();

var attrs = at(attributes)
Expand All @@ -257,28 +256,23 @@ public HtmlString getHtmlString()
return createHtmlFragment(
isSubmit() ?
INPUT(at(type,"submit",tabindex,"-1",Attribute.style,"position:absolute;left:-9999px;width:1px;height:1px;",Attribute.id,submitId)) : null,
A(attrs, iconOnly ? FA(getIconCls()) : SPAN(html))
A(attrs, iconOnly ? FA(getIconCls()) : SPAN(caption))
);
}

public static class ButtonBuilder extends DisplayElementBuilder<Button, ButtonBuilder>
{
private final Renderable html;
private final String caption;

private String typeCls;
private boolean disableOnClick;
private boolean dropdown;
private boolean enabled = true;
private boolean submit;

public ButtonBuilder(@NotNull String text)
public ButtonBuilder(@NotNull String caption)
{
this.html = HtmlString.of(text);
}

public ButtonBuilder(@NotNull Renderable html)
{
this.html = html;
this.caption = caption;
}

@Override
Expand Down