Skip to content

Commit d726947

Browse files
authored
Merge pull request #3866 from ControlSystemStudio/CSSSTUDIO-3766
updated context menu in alarm tree
2 parents 9c4396a + 2453bdc commit d726947

26 files changed

Lines changed: 851 additions & 481 deletions

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# SCM syntax highlighting & preventing 3-way merges
2+
pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,6 @@ docs/source/_ext/**/*.pyc
132132
# Ignore pip installation metadata
133133
docs/phoebus_docs.egg-info/
134134
*.pyc
135+
# pixi environments
136+
.pixi/*
137+
!.pixi/config.toml
81.9 KB
Loading
30.5 KB
Loading
26.8 KB
Loading
9.72 KB
Loading

app/alarm/ui/doc/index.rst

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -459,13 +459,32 @@ Context Menu
459459

460460
In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch a context menu:
461461

462-
.. image:: images/context_menu.png
462+
.. image:: images/context_menu_new.png
463463
:width: 20%
464464

465465
The top item ("Guidance" in the screenshot) will launch a dialog showing the guidance text for the alarm item.
466466

467-
With the Disable Alarms menu item (Alarm Tree only) user may disable an alarm item, or all alarms in the sub-tree of a
468-
node. The alarm(s) will stay disabled until explicitly enabled by the user. See also notes below for
467+
.. image:: images/context_menu_disable.png
468+
:width: 35%
469+
470+
With the Disable... menu item (Alarm Tree only) user may disable an alarm item, or all alarms in the sub-tree of a
471+
node.
472+
When choosing to disable the alarm(s) *indefinitely* in the sub-context menu, the alarm(s) will stay disabled until
473+
explicitly enabled by the user.
474+
475+
Alarm(s) can also be disabled for a certain time choosing *with enable date*.
476+
477+
.. image:: images/dialog_enable_date.png
478+
:width: 40%
479+
480+
Users can specify an either absolute or relative date or time the alarm(s) should be disabled. After that, the alarm(s)
481+
will be enabled again automatically.
482+
483+
**NOTE**: A structural component, along with all the items in its sub-tree, can **only** be disabled with an enable date
484+
if either all of the items have the same enable date or none at all.
485+
If this is not the case, the *with enable date* option in the sub context menu will be disabled.
486+
487+
See also notes below for
469488
more information on how disabled alarms are handled upon import of the alarm configuration XML file.
470489

471490
Configuration Editor
@@ -479,8 +498,13 @@ editor dialog:
479498

480499
In this view user may update all settings defined in the alarm configuration XML file:
481500

482-
.. image:: images/configuration_editor.png
483-
:width: 50%
501+
**NOTE:** There are different configuration files for a structural component (path), containing several components
502+
or leaves, and a leaf itself (training:COUNTER), as their functionalities vary
503+
504+
505+
.. image:: images/configuration_editor_dialogs.png
506+
:width: 85%
507+
484508

485509
**NOTE:** Any changes performed in the editor will be overwritten when the associated alarm configuration XML file is
486510
imported again.

app/alarm/ui/src/main/java/org/phoebus/applications/alarm/ui/Messages.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ public class Messages
2424
public static String disableAlarmFailed;
2525
public static String disableAlarms;
2626
public static String disabled;
27+
public static String disableMenu;
2728
public static String disabledUntil;
2829
public static String displays;
2930
public static String enableAlarmFailed;
@@ -34,6 +35,7 @@ public class Messages
3435
public static String headerConfirmDisable;
3536
public static String headerConfirmDisableWithEnableDate;
3637
public static String headerConfirmEnable;
38+
public static String indefinitely;
3739
public static String moveItemFailed;
3840
public static String partlyDisabled;
3941
public static String promptTitle;
@@ -42,6 +44,7 @@ public class Messages
4244
public static String renameItemFailed;
4345
public static String timer;
4446
public static String unacknowledgeFailed;
47+
public static String withEnableDate;
4548

4649
static
4750
{

app/alarm/ui/src/main/java/org/phoebus/applications/alarm/ui/config/ComponentConfigDialogController.java

Lines changed: 0 additions & 220 deletions
This file was deleted.

0 commit comments

Comments
 (0)