ElementAssistant.cs

// =============================================================================
// GPAL - Generally Positive Automation Library
// Copyright © 2026 Software Decisions, Inc. All rights reserved.
//
// This file is part of GPAL.
// Licensed under the Business Source License 1.1
//
// Primary development, architecture, and vision by Michael B. Vederman,
// CEO of Software Decisions, Inc., Texas.
//
// Internal development maintained privately.
// Public releases appear on GitHub: https://github.com/SoftwareDecisionsInc/GPAL.
//
// See LICENSE for full terms, including Additional Use Grant.
// =============================================================================
 
using OpenQA.Selenium;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using static GenerallyPositive.Enums;
 
namespace GenerallyPositive.Browser
{
    public class ElementAssistant : IAllowElementSettingsAndActions
    {
        private ElementSettings ElementSettings;// { get; set; }

        internal ElementAssistant()
        {
            ElementSettings = new ElementSettings();
        }
        public IAllowElementSettingsAndActions WithJavaScript
        {
            get
            {
                ElementSettings.InteractionType = InteractionType.JavaScript;
                return this;
            }
        }

        public IAllowElementSettingsAndActions WithHardware
        {
            get
            {
                ElementSettings.InteractionType = InteractionType.Hardware;
                return this;
            }
        }

        public IAllowElementSettingsAndActions LeftClick()
        {
            ElementHelper.Click(ElementSettings.Browser, ElementSettings.Selector, ElementSettings.WebElement, ClickType.LeftClick, ModifierKeys.NONE);
            BrowserHelper.CheckDocumentReady(ElementSettings.Browser);
 
            return this;
        }

        public IAllowElementSettingsAndActions LeftClick(Enums.ModifierKeys modifierKeys)
        {
            ElementHelper.Click(ElementSettings.Browser, ElementSettings.Selector, ElementSettings.WebElement, ClickType.LeftClick, modifierKeys);
            BrowserHelper.CheckDocumentReady(ElementSettings.Browser);
 
            return this;
        }

        public IAllowElementSettingsAndActions LeftClick(IGPALElement webElement)
        {
            ElementSettings.WebElement = (GPALElement)webElement;
            ElementHelper.Click(ElementSettings.Browser, ElementSettings.Selector, ElementSettings.WebElement, ClickType.LeftClick, ModifierKeys.NONE);
            BrowserHelper.CheckDocumentReady(ElementSettings.Browser);
 
            return this;
        }

        public IAllowElementSettingsAndActions LeftClickAndDownload(IGPALElement webElement, GPALFile downloadTo)
        {
            ElementSettings.WebElement = (GPALElement)webElement;
            Browser.LeftClickAndDownload(downloadTo, (GPALElement)webElement, ElementSettings.Selector);
            BrowserHelper.CheckDocumentReady(ElementSettings.Browser);
 
            return this;
        }

        public IAllowElementSettingsAndActions LeftDoubleClick()
        {
 
            ElementHelper.Click(ElementSettings.Browser, ElementSettings.Selector, ElementSettings.WebElement, ClickType.LeftDoubleClick, ModifierKeys.NONE);
 
            return this;
        }

        public IAllowElementSettingsAndActions LeftDoubleClick(IGPALElement webElement)
        {
            ElementSettings.WebElement = (GPALElement)webElement;
            ElementHelper.Click(ElementSettings.Browser, ElementSettings.Selector, ElementSettings.WebElement, ClickType.LeftDoubleClick, ModifierKeys.NONE);
 
            return this;
        }

        public IAllowElementSettingsAndActions MiddleClick()
        {
            ElementHelper.Click(ElementSettings.Browser, ElementSettings.Selector, ElementSettings.WebElement, ClickType.MiddleClick, ModifierKeys.NONE);
            BrowserHelper.CheckDocumentReady(ElementSettings.Browser);
 
            return this;
        }

        public IAllowElementSettingsAndActions RightClick(IGPALElement webElement = null)
        {
            GPALElement webElementToUse = (GPALElement)webElement ?? ElementSettings.WebElement;
 
            ElementHelper.Click(ElementSettings.Browser, ElementSettings.Selector, ElementSettings.WebElement, ClickType.RightClick, ModifierKeys.NONE);
 
            Thread.Sleep(250);
            return this;
        }

        internal void ForSelector(Selector selector)
        {
            ElementSettings.Selector = selector;
        }
        public IAllowElementSettingsAndActions WithElement(IGPALElement GPALElement)
        {
            ElementSettings.WebElement = (GPALElement)GPALElement;
            return this;
        }

        public IAllowElementSettingsAndActions FillInFrom(string inputText)
        {
            ElementHelper.FillInFrom(ElementSettings.Browser, inputText, WriteMode.Overwrite, ElementSettings.WebElement);
            //if (true == Browser.BrowserSettings.UseHeadless)
            //    ElementSettings.WebElement.SendKeys(inputText);
            //else if (InteractionType.JavaScript == ElementSettings.InteractionType)
            //    ElementHelper.JavaScriptFillInFrom(ElementSettings.Browser, ElementSettings.WebElement, inputText, WriteMode.Overwrite);
            //else if (InteractionType.Hardware == ElementSettings.InteractionType)
            //    ElementHelper.HardwareFillInFrom(Browser, ElementSettings.WebElement, 5, 5, inputText, WriteMode.Overwrite);   // KLUDGE: 5,5 is to click inside the control
            //else
            //    ElementSettings.WebElement.SendKeys(inputText);
 
            return this;
        }

        public IAllowElementSettingsAndActions InsertFrom(string inputText)
        {
            ElementHelper.FillInFrom(ElementSettings.Browser, inputText, WriteMode.Insert, ElementSettings.WebElement);
 
            //if (true != Browser.BrowserSettings.UseHeadless)
            //{
            //    ElementSettings.WebElement.SendKeys(Keys.Control + "A");    // select all text and overwrite
            //    ElementSettings.WebElement.SendKeys(inputText);
            //}
            //else if (InteractionType.JavaScript == ElementSettings.InteractionType)
            //    ElementHelper.JavaScriptFillInFrom(ElementSettings.Browser, ElementSettings.WebElement, inputText, WriteMode.Insert);
            //else if (InteractionType.Hardware == ElementSettings.InteractionType)
            //    ElementHelper.HardwareFillInFrom(Browser, ElementSettings.WebElement, 5, 5, inputText, WriteMode.Insert);   // KLUDGE: 5,5 is to click inside the control
            //else
            //{
            //    ElementSettings.WebElement.SendKeys(Keys.Control + "A");    // select all text and overwrite
            //    ElementSettings.WebElement.SendKeys(inputText);
            //}
            return this;
        }

        public IAllowElementSettingsAndActions AppendFrom(string inputText)
        {
            ElementHelper.FillInFrom(ElementSettings.Browser, inputText, WriteMode.Append, ElementSettings.WebElement);
 
            //if (true == Browser.BrowserSettings.UseHeadless)
            //    ElementSettings.WebElement.SendKeys(inputText);
            //else if (InteractionType.JavaScript == ElementSettings.InteractionType)
            //    ElementHelper.JavaScriptFillInFrom(ElementSettings.Browser, ElementSettings.WebElement, inputText, WriteMode.Append);
            //else if (InteractionType.Hardware == ElementSettings.InteractionType)
            //    ElementHelper.HardwareFillInFrom(Browser, ElementSettings.WebElement, 5, 5, inputText, WriteMode.Append);   // KLUDGE: 5,5 is to click inside the control
            //else
            //    ElementSettings.WebElement.SendKeys(inputText);
 
            return this;
        }

        public IAllowElementSettingsAndActions SendKey(byte keyCode)
        {
            ElementHelper.SendKey(Browser, keyCode);
            return this;
        }

        public IAllowElementSettingsAndActions SendString(string textToSend)
        {
            ElementHelper.SendString(Browser, textToSend);
            return this;
        }

        public IAllowElementSettingsAndActions PressModifierKey(ModifierKeys modifierKeys)
        {
            if (ModifierKeys.NONE != modifierKeys)
            {
                if (true == ElementSettings.Browser.UseOttoMagic)
                    ElementSettings.Browser.MagicHelper.PressModifierKey(modifierKeys);
                else if (true == ElementSettings.Browser.UsePuppeteer)
                    ElementSettings.Browser.PuppeteerClient.PressModifierKey(modifierKeys);
                else
                    HardwareHelper.PressModifierKey(modifierKeys);
            }
 
            return this;
        }

        public IAllowElementSettingsAndActions ReleaseModifierKey(ModifierKeys modifierKeys)
        {
            if (ModifierKeys.NONE != modifierKeys)
            {
                if (true == ElementSettings.Browser.UseOttoMagic)
                    ElementSettings.Browser.MagicHelper.ReleaseModifierKey(modifierKeys);
                else if (true == ElementSettings.Browser.UsePuppeteer)
                    ElementSettings.Browser.PuppeteerClient.ReleaseModifierKey(modifierKeys);
                else
                    HardwareHelper.ReleaseModifierKeys(modifierKeys);
            }
            return this;
        }

        public IAllowElementSettingsAndActions ScrollHorizontalPixels(int scrollAmount)
        {
            ElementHelper.ScrollElement(Browser, scrollAmount, ScrollTypes.Horizontal);
            return this;
        }

        public IAllowElementSettingsAndActions ScrollVerticalPixels(int scrollAmount)
        {
            ElementHelper.ScrollElement(Browser, scrollAmount, ScrollTypes.Vertical);
            return this;
        }

        internal Browser Browser
        {
            get
            {
                return ElementSettings.Browser;
            }
 
            set
            {
                ElementSettings.Browser = value;
            }
        }

        public ElementAssistant ToGPALObject()
        {
            return this;
        }
    }
}