Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ public class Messages
public static String promptTitle;
public static String removeComponentFailed;
public static String renameItemFailed;
public static String search;
public static String searchByPv;
public static String totalPVs;
public static String unacknowledgeFailed;
public static String withEnableDate;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import java.util.stream.Collectors;

import javafx.collections.FXCollections;
import javafx.scene.control.TextField;
import org.phoebus.applications.alarm.AlarmSystem;
import org.phoebus.applications.alarm.client.AlarmClient;
import org.phoebus.applications.alarm.client.AlarmClientLeaf;
Expand All @@ -34,13 +35,15 @@
import org.phoebus.applications.alarm.model.BasicState;
import org.phoebus.applications.alarm.ui.AlarmContextMenuHelper;
import org.phoebus.applications.alarm.ui.AlarmUI;
import org.phoebus.applications.alarm.ui.Messages;
import org.phoebus.applications.alarm.ui.config.ItemConfigDialog;
import org.phoebus.framework.selection.Selection;
import org.phoebus.framework.selection.SelectionService;
import org.phoebus.ui.application.ContextMenuService;
import org.phoebus.ui.application.SaveSnapshotAction;
import org.phoebus.ui.dialog.DialogHelper;
import org.phoebus.ui.docking.DockPane;
import org.phoebus.ui.javafx.ClearingTextField;
import org.phoebus.ui.javafx.ImageCache;
import org.phoebus.ui.javafx.PrintAction;
import org.phoebus.ui.javafx.Screenshot;
Expand Down Expand Up @@ -149,6 +152,8 @@
items.remove(changing);
});

private final TextField searchBox;

// Javadoc for TreeItem shows example for overriding isLeaf() and getChildren()
// to dynamically create TreeItem as TreeView requests information.
//
Expand Down Expand Up @@ -185,7 +190,11 @@
tree_view.setCellFactory(view -> new AlarmTreeViewCell());
tree_view.getSelectionModel().setSelectionMode(SelectionMode.MULTIPLE);

setTop(createToolbar());
searchBox = new ClearingTextField();
searchBox.setPromptText(Messages.searchByPv);
searchBox.setPrefWidth(300);

setTop(createToolbar(searchBox));
setCenter(tree_view);

createContextMenu();
Expand Down Expand Up @@ -243,7 +252,7 @@
});
}

private ToolBar createToolbar()
private ToolBar createToolbar(TextField searchBox)
{
final Button collapse = new Button("",
ImageCache.getImageView(AlarmUI.class, "/icons/collapse.png"));
Expand All @@ -264,14 +273,117 @@
show_disabled.setTooltip(new Tooltip("Expand alarm tree to show disabled PVs"));
show_disabled.setOnAction(event -> expandDisabledPVs(tree_view.getRoot()));

return new ToolBar(no_server, changing, ToolbarHelper.createSpring(), collapse, show_alarms, show_disabled);
final Button searchButton = new Button(Messages.search);

searchButton.setOnAction(event -> propagateVisibilityDownTree(tree_view.getRoot()));
searchBox.setOnAction(event -> propagateVisibilityDownTree(tree_view.getRoot())); // act as if button pressed when enter pressed
searchBox.textProperty().addListener(_ ->
{
// act as if button pressed when text box cleared
if (searchBox.getText().isEmpty())
{
propagateVisibilityDownTree(tree_view.getRoot());
}
});

return new ToolBar(searchBox, searchButton, no_server, changing, ToolbarHelper.createSpring(), collapse, show_alarms, show_disabled);
}

ToolBar getToolbar()
{
return (ToolBar) getTop();
}

/** Recursively updates the tree so that it only shows the items matching the search.
*
* This is done bottom-up, by recursing down to the leaf nodes initially to determine
* whether they should be visible, and then returning up the tree to determine whether
* each component should be visible or not, and showing/hiding it accordingly.
*/
private boolean propagateVisibilityDownTree(final TreeItem<AlarmTreeItem<?>> item)
{
for (final AlarmTreeItem<?> child : item.getValue().getChildren())
{
final TreeItem<AlarmTreeItem<?>> childItem = path2view.get(child.getPathName());

final boolean shouldDisplay = propagateVisibilityDownTree(childItem);

if (shouldDisplay)
{
final boolean doesNotHaveChildAlready = item.getChildren().stream()
.noneMatch(viewChild -> viewChild.getValue().getPathName().equals(child.getPathName()));
if (doesNotHaveChildAlready)
// should display and does not have child, so add child
addChildToParent(item, childItem);
}
else
item.getChildren().removeIf(
alarmTreeItemTreeItem -> alarmTreeItemTreeItem.getValue() == child
);
}

return shouldDisplay(item);
}

/** Ensures that an item is shown if it matches the search term, and not shown if it does not.
*
* This is done by determining whether the current node should be visible, and then propagating
* up the tree to ensure all the parent nodes are also only visible if they match the search term.
* This does not consider child nodes; it's intended to be called when a single node is added or
* updated to minimise state updates.
*/
private void propagateVisibilityUpTree(final TreeItem<AlarmTreeItem<?>> item)
{
final AlarmTreeItem<?> modelParent = item.getValue().getParent();
if (modelParent == null)
{
// root
return;
}

final TreeItem<AlarmTreeItem<?>> currentParent = item.getParent();
final TreeItem<AlarmTreeItem<?>> actualParent = path2view.get(modelParent.getPathName());

final boolean shouldDisplay = shouldDisplay(item);
if (shouldDisplay && currentParent == null)
{
// should display but does not have a parent (so will not be displayed)
addChildToParent(actualParent, item);
propagateVisibilityUpTree(actualParent);
}
else if (!shouldDisplay && currentParent != null)
{
// should not display but has a parent (so will be displayed)
actualParent.getChildren().remove(item);
propagateVisibilityUpTree(actualParent);
}
}

private boolean shouldDisplay(final TreeItem<AlarmTreeItem<?>> item)
{
return (searchBox.getText().isEmpty() || !item.getChildren().isEmpty())
|| item.getValue() instanceof AlarmClientLeaf && item.getValue().getName().toLowerCase().contains(searchBox.getText().toLowerCase());
}

/**
* Adds a child TreeItem to a parent TreeItem, ensuring the order is preserved
*
* @param view_parent
* @param view_item
*/
private static void addChildToParent(TreeItem<AlarmTreeItem<?>> view_parent, TreeItem<AlarmTreeItem<?>> view_item)

Check warning on line 374 in app/alarm/ui/src/main/java/org/phoebus/applications/alarm/ui/tree/AlarmTreeView.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

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

See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaF9PRreSiAyecBgH3EI&open=AaF9PRreSiAyecBgH3EI&pullRequest=3988

Check warning on line 374 in app/alarm/ui/src/main/java/org/phoebus/applications/alarm/ui/tree/AlarmTreeView.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

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

See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaF9PRreSiAyecBgH3EH&open=AaF9PRreSiAyecBgH3EH&pullRequest=3988
{
// Keep sorted by inserting at appropriate index
final List<TreeItem<AlarmTreeItem<?>>> items = view_parent.getChildren();
final int index = Collections.binarySearch(items, view_item,
(a, b) -> CompareNatural.compareTo(a.getValue().getName(),
b.getValue().getName()));
if (index < 0)
items.add(-index - 1, view_item);
else
items.add(index, view_item);
}

private void expandAlarms(final TreeItem<AlarmTreeItem<?>> node)
{
if (node.isLeaf())
Expand Down Expand Up @@ -340,7 +452,7 @@
setCursor(Cursor.WAIT);
final ObservableList<Node> items = getToolbar().getItems();
if (! items.contains(changing))
items.add(1, changing);
items.add(3, changing);
}
else
previous.cancel(false);
Expand Down Expand Up @@ -413,15 +525,7 @@
}
final TreeItem<AlarmTreeItem<?>> view_item = createViewItem(item);

// Keep sorted by inserting at appropriate index
final List<TreeItem<AlarmTreeItem<?>>> items = view_parent.getChildren();
final int index = Collections.binarySearch(items, view_item,
(a, b) -> CompareNatural.compareTo(a.getValue().getName(),
b.getValue().getName()));
if (index < 0)
items.add(-index - 1, view_item);
else
items.add(index, view_item);
propagateVisibilityUpTree(view_item);
done.countDown();
});

Expand Down Expand Up @@ -461,9 +565,11 @@
// because item might just have been created by itemAdded() event
// and won't be on the screen until UI thread runs.
final TreeItem<AlarmTreeItem<?>> view_parent = view_item.getParent();
if (view_parent == null)
throw new IllegalStateException("No parent in view for " + item.getPathName());
view_parent.getChildren().remove(view_item);
if (view_parent != null)
{
view_parent.getChildren().remove(view_item);
propagateVisibilityUpTree(view_parent);
}
done.countDown();
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,7 @@ tooltipMoveEditDetail=Edit the detail field of table item
tooltipMoveTableItemDown=Move table item down
tooltipMoveTableItemUp=Move table item up
totalPVs=PVs: {0}
search=Search
searchByPv=Search by PV
unacknowledgeFailed=Failed to unacknowledge alarm(s)
withEnableDate=With Enable Date
Loading