Merge pull request #33 from gismofx/dev

Clean up code and comments

toast_ui.blazor_calendar.TestProject/toast_ui.blazor_calendar.TestProject/ViewModels/CalendarViewModel.cs

@@ -87,15 +87,25 @@ public async Task InitCalendarDataAsync()
         {
             StartDate = DateTimeOffset.Now;
             EndDate = DateTimeOffset.Now;
+
+            //Todo: Add More Template Examples
+            //TUITemplate calendarTemplate = null;
+            var calendarTemplate = new TUITemplate();
+            calendarTemplate.AddMonthGridHeaderExceed(@"return '<span class=""weekday-grid-more-schedules"">+' + hiddenSchedules + ' says gismofx' + '</span>';");
 
+
             var month = new TUIMonthOptions()
             {
                 //daynames = new[] { "Domingo", "Lunes", "Martes", "Miercoles", "Jueves", "Viernes", "Sabado" },
                 //startDayOfWeek = 0,
                 visibleWeeksCount = 6,
                 //visibleScheduleCount = 0,
             };
-
+
+            //optionally setup timezones for display
+            var timeZones = new TUICalendarTimeZoneOption();
+            timeZones.AddTimeZone(TimeZoneInfo.Local);
+            timeZones.AddTimeZone(TimeZoneInfo.FindSystemTimeZoneById("Tokyo Standard Time"));
 
             //Set the Calendar Options
             CalendarOptions = new TUICalendarOptions()
@@ -105,8 +115,9 @@ public async Task InitCalendarDataAsync()
                 defaultView = TUICalendarViewName.Month,
                 taskView = false,
                 scheduleView = true,
-                month = month
-
+                month = month,
+                TUItemplate = calendarTemplate,
+                timezone = timeZones
             };
 
             var calendarProps = new List<TUICalendarProps>();

toast_ui.blazor_calendar/Models/TUICalendarOptions.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Text.Json.Serialization;
 using toast_ui.blazor_calendar.Services;
@@ -43,6 +44,8 @@ public class TUICalendarOptions
         /// https://nhn.github.io/tui.calendar/latest/Template
         /// had to rename from 'template' - violates naming rule
         /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        [JsonPropertyName("template")]
         public TUITemplate TUItemplate { get; set; } = null;
 
         /// <summary>
@@ -75,7 +78,8 @@ public class TUICalendarOptions
         /// You can add secondary timezone in the weekly/daily view.
         /// https://nhn.github.io/tui.calendar/latest/Timezone
         /// </summary>
-        public TimeZoneInfo timezone { get; set; } //Todo: Map this or implement TUI timezone class
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        public TUICalendarTimeZoneOption timezone { get; set; } = null;
 
         /// <summary>
         /// Disable double click to create a schedule.
@@ -187,32 +191,4 @@ private bool CompareMembers(TUICalendarOptions options)
         }
 
     }
-
-    public class TUICalendarViewName
-    {
-        private TUICalendarViewName(string value)
-        {
-            Value = value;
-        }
-        public string Value { get; set; }
-
-        public static TUICalendarViewName Day { get { return new TUICalendarViewName("day"); } }
-        public static TUICalendarViewName Week { get { return new TUICalendarViewName("week"); } }
-        public static TUICalendarViewName Month { get { return new TUICalendarViewName("month"); } }
-
-    }
-
-public class TUITaskView
-{
-    private TUITaskView(string[] value)
-    {
-        Value = value;
-    }
-    public string[] Value { get; set; }
-
-    public static TUITaskView MilestoneAndTask { get { return new TUITaskView(new[] { "milestone", "task" });  }}
-    public static TUITaskView Milestone { get { return new TUITaskView(new[] { "milestone" }); } }
-    public static TUITaskView Task { get { return new TUITaskView(new[] { "task" }); } }
-    public static TUITaskView None { get { return new TUITaskView(new[] { "" }); } }
-}
 }

toast_ui.blazor_calendar/Models/TUICalendarTimeZoneOption.cs

@@ -0,0 +1,118 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace toast_ui.blazor_calendar.Models
+{
+    /// <summary>
+    /// Timezone options defined here https://nhn.github.io/tui.calendar/latest/Timezone
+    /// </summary>
+    public class TUICalendarTimeZoneOption
+    {
+        /// <summary>
+        /// List of TUITimeZone calendar time zones
+        /// </summary>
+        public List<TUITimeZone> zones { get; set; }
+
+        /// <summary>
+        /// Function Expression to return the Display Label
+        /// </summary>
+        [JsonIgnore]
+        public Func<TimeZoneInfo, string> DisplayLabelFunction { get; set; } = null;
+
+        /// <summary>
+        /// Function Expression to return the Tool Tip
+        /// </summary>
+        [JsonIgnore]
+        public Func<TimeZoneInfo, string> ToolTipFunction { get; set; } = null;
+
+        /// <summary>
+        /// Constructs a default TUICalendarTimeZoneOption
+        /// </summary>
+        public TUICalendarTimeZoneOption()
+        {
+            zones = new List<TUITimeZone>();
+        }
+
+        /// <summary>
+        /// Constructs TUICalendarTimeZoneOption with expressions to set the display label and tool tip
+        /// </summary>
+        /// <param name="displayLabelFunction">Function Expression to return the Display Label</param>
+        /// <param name="toolTipFunction">Function Expression to return the Tool Tip</param>
+        public TUICalendarTimeZoneOption(Func<TimeZoneInfo, string> displayLabelFunction, Func<TimeZoneInfo, string> toolTipFunction): this()
+        {
+            DisplayLabelFunction = displayLabelFunction;
+            ToolTipFunction = toolTipFunction;
+        }
+
+        /// <summary>
+        /// Convert a TimeZoneInfo object into a TUITimeZone Object
+        /// </summary>
+        /// <param name="timeZoneInfo"></param>
+        /// <returns></returns>
+        public bool AddTimeZone(TimeZoneInfo timeZoneInfo)
+        {
+            var TUItz = ToTuiTimeZone(timeZoneInfo);
+            if (TUItz is null)
+                return false;
+
+            zones.Add(TUItz);
+            return true;
+        }
+
+        /// <summary>
+        /// Converts a TimeZoneInfo into a TUI Defined Time Zone object
+        /// </summary>
+        /// <param name="timeZoneInfo">TimeZoneInfo</param>
+        /// <returns>TUITimeZone</returns>
+        private TUITimeZone ToTuiTimeZone(TimeZoneInfo timeZoneInfo)
+        {
+            //if unable to get the IanaId return a null object
+            if (!TimeZoneInfo.TryConvertWindowsIdToIanaId(timeZoneInfo.Id, out string timezoneName)) return null;
+
+            //create default options based on the example https://nhn.github.io/tui.calendar/latest/Timezone
+            //if the user specified a function to get the
+            //display label use that
+            string displayLabel;
+            if (DisplayLabelFunction != null)
+            {
+                displayLabel = DisplayLabelFunction(timeZoneInfo);
+            }
+            else
+            {
+                string positiveOrNegative = timeZoneInfo.BaseUtcOffset < TimeSpan.Zero ? "-" : "+";
+                displayLabel = $"GMT{positiveOrNegative}{timeZoneInfo.BaseUtcOffset:hh\\:mm}";
+            }
+
+            /* Why won't this lamba compile
+            string displayLabel = DisplayLabelFunction(timeZoneInfo) ?? (() => 
+            {
+                string positiveOrNegative = timeZoneInfo.BaseUtcOffset < TimeSpan.Zero ? "-" : "+";
+                return $"GMT{positiveOrNegative}{timeZoneInfo.BaseUtcOffset:hh\\:mm}";
+            });
+            */
+
+            //if the user specified a function to get the tooltip use that
+
+            //Why do these not work?
+            //var tooltip = ToolTipFunction?.Invoke(timeZoneInfo) ?? timeZoneInfo.StandardName;
+            //var tooltip = ToolTipFunction(timeZoneInfo) ?? timeZoneInfo.StandardName;
+            string tooltip;
+            if (ToolTipFunction is null)
+            {
+                tooltip = timeZoneInfo.StandardName;
+            }
+            else
+            {
+                tooltip = ToolTipFunction(timeZoneInfo);
+            }
+
+            return new TUITimeZone
+            {
+                timezoneName = timezoneName,
+                displayLabel = displayLabel,
+                tooltip = tooltip
+            };
+        }
+    }
+}

toast_ui.blazor_calendar/Models/TUICalendarViewName.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace toast_ui.blazor_calendar.Models
+{
+    /// <summary>
+    /// Enum Class/Helper For TUI Calendar Views
+    /// </summary>
+    public class TUICalendarViewName
+    {
+        public static TUICalendarViewName Day { get { return new TUICalendarViewName("day"); } }
+        public static TUICalendarViewName Week { get { return new TUICalendarViewName("week"); } }
+        public static TUICalendarViewName Month { get { return new TUICalendarViewName("month"); } }
+
+        private TUICalendarViewName(string value)
+        {
+            Value = value;
+        }
+        public string Value { get; set; }
+
+        public override string ToString()
+        {
+            return Value;
+        }
+
+    }
+}

toast_ui.blazor_calendar/Models/TUIMonthOptions.cs

@@ -54,7 +54,8 @@ public class TUIMonthOptions
         public int? visibleScheduleCount { get; set; } = null;
 
         /// <summary>
-        /// The more layer size
+        /// The 
+        /// layer size
         /// </summary>
         [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
         public object moreLayerSize { get; set; } = null; //@Todo: What is this?

toast_ui.blazor_calendar/Models/TUITaskView.cs

@@ -0,0 +1,27 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace toast_ui.blazor_calendar.Models
+{
+    /// <summary>
+    /// Enum Class/Helper For TUI Task View Modes
+    /// </summary>
+    public class TUITaskView
+    {
+
+        public static TUITaskView MilestoneAndTask { get { return new TUITaskView(new[] { "milestone", "task" }); } }
+        public static TUITaskView Milestone { get { return new TUITaskView(new[] { "milestone" }); } }
+        public static TUITaskView Task { get { return new TUITaskView(new[] { "task" }); } }
+        public static TUITaskView None { get { return new TUITaskView(new[] { "" }); } }
+
+        private TUITaskView(string[] value)
+        {
+            Value = value;
+        }
+        public string[] Value { get; set; }
+
+    }
+}