Skip to content

Feat : truncate overflowing content of TextEntry and TextUpdate, append ellipsis #3928

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

Open
gabriel-desmarchelier wants to merge 3 commits into
base: master
Choose a base branch
from
+109 −28
Open

Feat : truncate overflowing content of TextEntry and TextUpdate, append ellipsis #3928

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
6e6de5b
feat: display ellipsis when the TextEntry or TextUpdate content is to…
gabriel-desmarchelier Sep 18, 2026
dec66eb
remove unused Font import from TextUpdateRepresentation
gabriel-desmarchelier Sep 18, 2026
0352cb8
using focusProperty rather than active state to switch the display be…
gabriel-desmarchelier Sep 18, 2026
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
96 changes: 72 additions & 24 deletions ...a/org/csstudio/display/builder/representation/javafx/widgets/TextEntryRepresentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@
import javafx.css.PseudoClass;
import javafx.geometry.Pos;
import javafx.scene.input.MouseButton;
import javafx.scene.text.Text;
import org.csstudio.display.builder.model.DirtyFlag;
import org.csstudio.display.builder.model.UntypedWidgetPropertyListener;
import org.csstudio.display.builder.model.WidgetProperty;
import org.csstudio.display.builder.model.WidgetPropertyListener;
import org.csstudio.display.builder.model.properties.HorizontalAlignment;
import org.csstudio.display.builder.model.properties.VerticalAlignment;
import org.csstudio.display.builder.model.widgets.PVWidget;
import org.csstudio.display.builder.model.widgets.TextEntryWidget;
Expand Down Expand Up @@ -63,6 +65,7 @@
private final UntypedWidgetPropertyListener contentListener = this::contentChanged;
private final WidgetPropertyListener<String> pvNameListener = this::pvnameChanged;
private volatile String value_text = "<?>";
private volatile String truncated_value_text = "<?>";

Check warning on line 68 in app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/widgets/TextEntryRepresentation.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Rename this field "truncated_value_text" to match the regular expression '^[a-z][a-zA-Z0-9]*$'. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaC0zo-hzZY4JqY35yOd&open=AaC0zo-hzZY4JqY35yOd&pullRequest=3928

private static WidgetColor active_color = WidgetColorService.getColor(NamedWidgetColors.ACTIVE_TEXT);

Expand Down Expand Up @@ -165,12 +168,19 @@
});
// While getting the focus does not activate the widget
// (first need to type something or click),
// _loosing_ focus de-activates the widget.
// _getting_ focus replaces eventually truncated text by full text
// _loosing_ focus when active de-activates the widget.
// _loosing_ focus when inactive restores truncated text.
// Otherwise widget where one moves the cursor, then clicks
// someplace else would remain active and not show any updates
text.focusedProperty().addListener((prop, old, focused) ->
{
if (active && !focused)
if (focused)
{
if (jfx_node instanceof TextField)
jfx_node.setText(value_text);
}
else if (active)
{
// For multi-line, submit on exit because users
// cannot remember Ctrl-Enter.
Expand All @@ -182,6 +192,8 @@
restore();
setActive(false);
}
else
restore();
});
}

Expand Down Expand Up @@ -236,7 +248,7 @@
*/
private void restore()
{
jfx_node.setText(value_text);
jfx_node.setText(truncated_value_text);
}

/** Submit value entered by user */
Expand All @@ -245,12 +257,12 @@
if (enabled) {
// Strip 'units' etc. from text
final String text = jfx_node.getText();

final Object value = FormatOptionHandler.parse(model_widget.runtimePropValue().getValue(), text,
model_widget.propFormat().getValue());
logger.log(Level.FINE, "Writing '" + text + "' as " + value + " (" + value.getClass().getName() + ")");
toolkit.fireWrite(model_widget, value);

// Wrote value. Expected is either
// a) PV receives that value, PV updates to
// submitted value or maybe a 'clamped' value
Expand Down Expand Up @@ -356,9 +368,38 @@
if (value == PVWidget.RUNTIME_VALUE_NO_PV)
return "";
return FormatOptionHandler.format(value,
model_widget.propFormat().getValue(),
model_widget.propPrecision().getValue(),
model_widget.propShowUnits().getValue());
model_widget.propFormat().getValue(),
model_widget.propPrecision().getValue(),
model_widget.propShowUnits().getValue());
}

/** @param Text to truncate
* @return Truncated text to display depending on widget width
*/
private String truncateText(final String full_string)
{
Text textValue = new Text(full_string);
textValue.setFont(JFXUtil.convert(model_widget.propFont().getValue()));
// Compute string width in pixels
double fullStringWidth = textValue.getLayoutBounds().getWidth();
// Check if string is wider than field
double widthRatio = fullStringWidth/model_widget.propWidth().getValue();
// Displaying ellipsis if the string overflows the field
if (widthRatio > 1)
{
String truncatedString = "<?>";
// Computing the number of characters to keep from full string before adding ellipisis
int stringTruncIndex = (int) (full_string.length()/widthRatio);
// Append ellipsis if content is left-aligned
if (model_widget.propHorizontalAlignment().getValue() == HorizontalAlignment.LEFT)
truncatedString = full_string.substring(0,stringTruncIndex - 1) + "...";
// Prepend ellipsis if content is right-aligned
if (model_widget.propHorizontalAlignment().getValue() == HorizontalAlignment.RIGHT)
truncatedString = "..." + full_string.substring(full_string.length() - stringTruncIndex + 2);
return truncatedString;
}
else
return full_string;
}

private void pvnameChanged(final WidgetProperty<String> property, final String old_value, final String new_value)
Expand All @@ -375,6 +416,7 @@
private void contentChanged(final WidgetProperty<?> property, final Object old_value, final Object new_value)
{
value_text = computeText(model_widget.runtimePropValue().getValue());
truncated_value_text = truncateText(value_text);
dirty_content.mark();
if (! active)
toolkit.scheduleUpdate(this);
Expand Down Expand Up @@ -429,7 +471,7 @@
String alignment = model_widget.propHorizontalAlignment().getValue().toString().toLowerCase();
PseudoClass alignmentClass = PseudoClass.getPseudoClass(alignment);
jfx_node.pseudoClassStateChanged(alignmentClass, true);

if (jfx_node.getScene() != null && !enabled) {
// Need to get the TextArea 'content' node to set the cursor
// for the whole widget otherwise it will only show on the borders.
Expand All @@ -442,22 +484,28 @@
{
if (dirty_content.checkAndClear())
{
// For middle-aligned multi-line text, keep the scroll position
final TextArea area = jfx_node instanceof TextArea ? (TextArea) jfx_node : null;
final VerticalAlignment align = model_widget.propVerticalAlignment().getValue();
double pos = 0;
if (area != null && align == VerticalAlignment.MIDDLE)
pos = area.getScrollTop();

jfx_node.setText(value_text);

if (area != null && pos != 0)
area.setScrollTop(pos);
// For bottom scroll detail, see comments in TextUpdateRepresentation
if (area != null && align == VerticalAlignment.BOTTOM)
if (jfx_node instanceof TextField) {
jfx_node.setText(truncated_value_text);
}
else
{
area.selectRange(0, 1);
toolkit.schedule(() -> area.selectRange(value_text.length(), value_text.length()), 500, TimeUnit.MILLISECONDS);
// For middle-aligned multi-line text, keep the scroll position
final TextArea area = jfx_node instanceof TextArea ? (TextArea) jfx_node : null;
final VerticalAlignment align = model_widget.propVerticalAlignment().getValue();
double pos = 0;
if (area != null && align == VerticalAlignment.MIDDLE)
pos = area.getScrollTop();

jfx_node.setText(value_text);

if (area != null && pos != 0)
area.setScrollTop(pos);
// For bottom scroll detail, see comments in TextUpdateRepresentation
if (area != null && align == VerticalAlignment.BOTTOM)
{
area.selectRange(0, 1);
toolkit.schedule(() -> area.selectRange(value_text.length(), value_text.length()), 500, TimeUnit.MILLISECONDS);
}
}
}
}
Expand Down
41 changes: 37 additions & 4 deletions .../org/csstudio/display/builder/representation/javafx/widgets/TextUpdateRepresentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import org.csstudio.display.builder.model.WidgetPropertyListener;
import org.csstudio.display.builder.model.properties.RotationStep;
import org.csstudio.display.builder.model.properties.VerticalAlignment;
import org.csstudio.display.builder.model.properties.HorizontalAlignment;
import org.csstudio.display.builder.model.widgets.PVWidget;
import org.csstudio.display.builder.model.widgets.TextUpdateWidget;
import org.csstudio.display.builder.representation.javafx.JFXUtil;
Expand All @@ -34,6 +35,7 @@
import javafx.scene.layout.CornerRadii;
import javafx.scene.layout.Region;
import javafx.scene.paint.Color;
import javafx.scene.text.Text;
import javafx.scene.transform.Rotate;
import javafx.scene.transform.Translate;

Expand All @@ -53,6 +55,7 @@
private final UntypedWidgetPropertyListener contentListener = this::contentChanged;
private final WidgetPropertyListener<String> pvNameListener = this::pvnameChanged;
private volatile String value_text = "<?>";
private volatile String truncated_value_text = "<?>";

Check warning on line 58 in app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/widgets/TextUpdateRepresentation.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Rename this field "truncated_value_text" to match the regular expression '^[a-z][a-zA-Z0-9]*$'. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaC0zo2LzZY4JqY35yOc&open=AaC0zo2LzZY4JqY35yOc&pullRequest=3928
private volatile Pos pos;

/** Was there ever any transformation applied to the jfx_node?
Expand Down Expand Up @@ -174,9 +177,38 @@
if (value == PVWidget.RUNTIME_VALUE_NO_PV)
return "";
return FormatOptionHandler.format(value,
model_widget.propFormat().getValue(),
model_widget.propPrecision().getValue(),
model_widget.propShowUnits().getValue());
model_widget.propFormat().getValue(),
model_widget.propPrecision().getValue(),
model_widget.propShowUnits().getValue());
}

/** @param Text to truncate
* @return Truncated text to display depending on widget width
*/
private String truncateText(final String full_string)
{
Text textValue = new Text(full_string);
textValue.setFont(JFXUtil.convert(model_widget.propFont().getValue()));
// Compute string width in pixels
double fullStringWidth = textValue.getLayoutBounds().getWidth();
// Check if string is wider than field
double widthRatio = fullStringWidth/model_widget.propWidth().getValue();
// Displaying ellipsis if the string overflows the field
if (widthRatio > 1)
{
String truncatedString = "<?>";
// Computing the number of characters to keep from full string before adding ellipisis
int stringTruncIndex = (int) (full_string.length()/widthRatio);
// Append ellipsis if content is left-aligned
if (model_widget.propHorizontalAlignment().getValue() == HorizontalAlignment.LEFT)
truncatedString = full_string.substring(0,stringTruncIndex - 1) + "...";
// Prepend ellipsis if content is right-aligned
if (model_widget.propHorizontalAlignment().getValue() == HorizontalAlignment.RIGHT)
truncatedString = "..." + full_string.substring(full_string.length() - stringTruncIndex + 2);
return truncatedString;
}
else
return full_string;
}

private void pvnameChanged(final WidgetProperty<String> property, final String old_value, final String new_value)
Expand All @@ -197,6 +229,7 @@
if (value_text.equals(new_text))
return;
value_text = new_text;
truncated_value_text = truncateText(value_text);
dirty_content.mark();
toolkit.scheduleUpdate(this);
}
Expand Down Expand Up @@ -279,7 +312,7 @@
if (dirty_content.checkAndClear())
{
if (jfx_node instanceof Label)
((Label)jfx_node).setText(value_text);
((Label)jfx_node).setText(truncated_value_text);
else
{ // Implies 'interactive' mode
final TextArea area = (TextArea)jfx_node;
Expand Down
Loading