Merge branch 'feature/SelectableTreeView-Expansion' into develop

Previously, when a relationship was exposed via the editor via the `OnTopic.SelectableTreeView` script, all nodes were closed. This could make it cumbersome to identify which topics, if any, were selected, and especially when working with a large tree. Given this, a new feature has been introduced to allow the `OnTopic.SelectableTreeView` to default to expanding any nodes leading to a selected (related) value.

This functionality can be controlled via the new `TopicQueryOptions.ExpandRelated` value, which by default is set to `true`, assuming `TopicQueryOptions.MarkRelated` is set to `true`. (There's no point in expanding to related topics if those topics themselves are not checked.) Further, this option is exposed as a configuration attribute on the `RelationshipAttribute` content type descriptor, thus allowing the preference to be configured on a per-relationship basis.

 The `RelationshipViewComponent` relays this to the view via the `RelationshipAttributeTopicViewModel`, which then binds it to the `OnTopic.SelectableTreeView`'s `dataUrl` configuration, which is in turn used by the `EditorController.Json()` action to relay that information to the `TopicQueryService`, where is it bound to an `TopicQueryOptions` instance, and used to control the output of the service.

Author: JeremyCaney

OnTopic.Editor.AspNetCore/Areas/Editor/Views/Editor/Components/Relationship/Default.cshtml

@@ -16,7 +16,7 @@
 <script type="text/javascript">
   Ext.onReady(function(){
     var tree                    = new OnTopic.SelectableTreeView({
-      dataUrl                   : '/OnTopic/Json/@rootTopicKey?ShowRoot=@descriptor.ShowRoot&ShowAll=true&RelatedNamespace=@descriptor.Key&RelatedTopicID=@Model.CurrentTopic.Id&AttributeName=@descriptor.AttributeKey&AttributeValue=@descriptor.AttributeValue',
+      dataUrl                   : '/OnTopic/Json/@rootTopicKey?ShowRoot=@descriptor.ShowRoot&ShowAll=true&RelatedNamespace=@descriptor.Key&RelatedTopicID=@Model.CurrentTopic.Id&AttributeName=@descriptor.AttributeKey&AttributeValue=@descriptor.AttributeValue&ExpandRelated=@descriptor.ExpandRelated',
       checkAscendants           : @((descriptor.CheckAscendants is true).ToString().ToLower()),
       backingField              : '@Html.IdFor(m => m.Value)'
     });

OnTopic.Editor.AspNetCore/Infrastructure/TopicQueryService.cs

@@ -100,7 +100,8 @@ private void MapQueryResult(
           topic.GetUniqueKey(),
           topic.GetWebPath(),
           options.EnableCheckboxes ? (options.MarkRelated ? related.Contains(topic) : true) : new bool?(),
-          topic.Attributes.GetValue("DisableDelete", "0").Equals("0")
+          topic.Attributes.GetValue("DisableDelete", "0").Equals("0"),
+          options.ExpandRelated && related.Any(r => r.GetUniqueKey().StartsWith(topic.GetUniqueKey(), StringComparison.Ordinal))
         );
 
         //Add topic to topic list

OnTopic.Editor.Models/Metadata/RelationshipAttributeTopicViewModel.cs

@@ -25,6 +25,15 @@ public class RelationshipAttributeTopicViewModel: QueryableTopicListAttributeTop
     /// </summary>
     public bool? ShowRoot { get; set; }
 
+    /*==========================================================================================================================
+    | PROPERTY: EXPAND RELATED?
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Determines whether or not the tree panel should be expanded to ensure visibility of any related (checked)
+    ///   relationships upon load. Defaults to <c>true</c>.
+    /// </summary>
+    public bool? ExpandRelated { get; set; }
+
     /*==========================================================================================================================
     | PROPERTY: CHECK ASCENDANTS
     \-------------------------------------------------------------------------------------------------------------------------*/

OnTopic.Editor.Models/Queryable/QueryResultTopicViewModel.cs

@@ -35,7 +35,8 @@ public QueryResultTopicViewModel(
       string                    uniqueKey,
       string                    webPath,
       bool?                     isChecked                       = null,
-      bool                      isDraggable                     = true
+      bool                      isDraggable                     = true,
+      bool                      isExpanded                      = false
     ) {
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -47,6 +48,7 @@ public QueryResultTopicViewModel(
       UniqueKey                 = uniqueKey;
       WebPath                   = webPath;
       IsDraggable               = isDraggable;
+      IsExpanded                = isExpanded;
 
       if (isChecked.HasValue) {
         IsChecked               = isChecked.Value;
@@ -138,6 +140,24 @@ public bool IsDraggable {
     [JsonPropertyName("leaf")]
     public bool IsLeaf => Children.Count.Equals(0);
 
+    /*==========================================================================================================================
+    | IS EXPANDED?
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Determines whether the current node should be expanded, assuming it's not a <see cref="IsLead"/> node.
+    /// </summary>
+    /// <remarks>
+    ///   The <c>TopicQueryService</c> will set this value based if a <see cref="TopicQueryOptions.RelatedTopicId"/> is
+    ///   specified, and <see cref="TopicQueryOptions.MarkRelated"/> is set to <c>true</c>. Specifically, it will mark any item
+    ///   whose <see cref="Topic.GetUniqueKey()"/> starts with the <see cref="Topic.GetUniqueKey()"/> of any <see cref="Topic.
+    ///   Relationships"/> associated with the <see cref="TopicQueryOptions.RelatedTopicId"/>, thus ensuring that all selected
+    ///   items are expanded.
+    /// </remarks>
+    [JsonPropertyName("expanded")]
+    public bool IsExpanded {
+      get;
+    }
+
     /*==========================================================================================================================
     | CHILDREN
     \-------------------------------------------------------------------------------------------------------------------------*/

OnTopic.Editor.Models/Queryable/TopicQueryOptions.cs

@@ -19,6 +19,7 @@ public class TopicQueryOptions {
     | PRIVATE VARIABLES
     \-------------------------------------------------------------------------------------------------------------------------*/
     bool                        _markRelated                    = false;
+    bool                        _expandRelated                  = true;
     bool                        _showCheckboxes                 = false;
 
     /*==========================================================================================================================
@@ -44,6 +45,7 @@ public TopicQueryOptions() {
       AttributeValue            = null;
       Query                     = null;
       MarkRelated               = false;
+      ExpandRelated             = true;
       RelatedTopicId            = -1;
       RelatedNamespace          = null;
       EnableCheckboxes          = false;
@@ -195,18 +197,33 @@ public bool EnableCheckboxes {
     | MARK RELATED
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Determines whether <see cref="QueryResultTopicViewModel"/>s should be marked as <see cref="QueryResultTopicViewModel.IsChecked"/>
-    ///   based on their presence in related topics.
+    ///   Determines whether <see cref="QueryResultTopicViewModel"/>s should be marked as <see cref="QueryResultTopicViewModel.
+    ///   IsChecked"/> based on their presence in related topics.
     /// </summary>
     /// <remarks>
-    ///   This will automatically be set to true is <see cref="RelatedTopicId"/> or <see cref="RelatedNamespace"/> are set. If
+    ///   This will automatically be set to true if <see cref="RelatedTopicId"/> or <see cref="RelatedNamespace"/> are set. If
     ///   <see cref="RelatedTopicId"/> is <i>not</i> set, then the current <see cref="Topic"/> should be assumed.
     /// </remarks>
     public bool MarkRelated {
       get => (RelatedTopicId > 0 || !String.IsNullOrEmpty(RelatedNamespace) || _markRelated);
       set => _markRelated = value;
     }
 
+    /*==========================================================================================================================
+    | EXPAND RELATED
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Determines whether <see cref="QueryResultTopicViewModel"/>s should be marked ascendants as nodes marked as <see
+    ///   cref="QueryResultTopicViewModel.IsChecked"/> as <see cref="QueryResultTopicViewModel.IsExpanded"/>.
+    /// </summary>
+    /// <remarks>
+    ///   This will automatically be set to true if <see cref="MarkRelated"/> is set to true.
+    /// </remarks>
+    public bool ExpandRelated {
+      get => (MarkRelated && _expandRelated);
+      set => _expandRelated = value;
+    }
+
     /*==========================================================================================================================
     | RELATED TOPIC ID
     \-------------------------------------------------------------------------------------------------------------------------*/