| // <copyright file="ActionSequence.cs" company="Selenium Committers"> | |
| // Licensed to the Software Freedom Conservancy (SFC) under one | |
| // or more contributor license agreements. See the NOTICE file | |
| // distributed with this work for additional information | |
| // regarding copyright ownership. The SFC licenses this file | |
| // to you under the Apache License, Version 2.0 (the | |
| // "License"); you may not use this file except in compliance | |
| // with the License. You may obtain a copy of the License at | |
| // | |
| // http://www.apache.org/licenses/LICENSE-2.0 | |
| // | |
| // Unless required by applicable law or agreed to in writing, | |
| // software distributed under the License is distributed on an | |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| // KIND, either express or implied. See the License for the | |
| // specific language governing permissions and limitations | |
| // under the License. | |
| // </copyright> | |
| using System.Globalization; | |
| using System.Text; | |
| namespace OpenQA.Selenium.Interactions; | |
| /// <summary> | |
| /// Represents a sequence of actions to be performed in the target browser. | |
| /// </summary> | |
| public class ActionSequence | |
| { | |
| private readonly List<Interaction> interactions = new List<Interaction>(); | |
| /// <summary> | |
| /// Initializes a new instance of the <see cref="ActionSequence"/> class. | |
| /// </summary> | |
| /// <param name="device">The input device that executes this sequence of actions.</param> | |
| public ActionSequence(InputDevice device) | |
| : this(device, 0) | |
| { | |
| } | |
| /// <summary> | |
| /// Initializes a new instance of the <see cref="ActionSequence"/> class. | |
| /// </summary> | |
| /// <param name="device">The input device that executes this sequence of actions.</param> | |
| /// <param name="initialSize">the initial size of the sequence.</param> | |
| public ActionSequence(InputDevice device, int initialSize) | |
| { | |
| this.InputDevice = device ?? throw new ArgumentNullException(nameof(device), "Input device cannot be null."); | |
| for (int i = 0; i < initialSize; i++) | |
| { | |
| this.AddAction(new PauseInteraction(this.InputDevice, TimeSpan.Zero)); | |
| } | |
| } | |
| /// <summary> | |
| /// Gets the count of actions in the sequence. | |
| /// </summary> | |
| public int Count => this.interactions.Count; | |
| /// <summary> | |
| /// Gets the input device for this Action sequence. | |
| /// </summary> | |
| public InputDevice InputDevice { get; } | |
| /// <summary> | |
| /// Adds an action to the sequence. | |
| /// </summary> | |
| /// <param name="interactionToAdd">The action to add to the sequence.</param> | |
| /// <returns>A self-reference to this sequence of actions.</returns> | |
| public ActionSequence AddAction(Interaction interactionToAdd) | |
| { | |
| if (interactionToAdd == null) | |
| { | |
| throw new ArgumentNullException(nameof(interactionToAdd), "Interaction to add to sequence must not be null"); | |
| } | |
| if (!interactionToAdd.IsValidFor(this.InputDevice.DeviceKind)) | |
| { | |
| throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, "Interaction {0} is invalid for device type {1}.", interactionToAdd.GetType(), this.InputDevice.DeviceKind), nameof(interactionToAdd)); | |
| } | |
| this.interactions.Add(interactionToAdd); | |
| return this; | |
| } | |
| /// <summary> | |
| /// Converts this action sequence into an object suitable for serializing across the wire. | |
| /// </summary> | |
| /// <returns>A <see cref="Dictionary{TKey, TValue}"/> containing the actions in this sequence.</returns> | |
| public Dictionary<string, object> ToDictionary() | |
| { | |
| Dictionary<string, object> toReturn = this.InputDevice.ToDictionary(); | |
| List<object> encodedActions = new List<object>(); | |
| foreach (Interaction action in this.interactions) | |
| { | |
| encodedActions.Add(action.ToDictionary()); | |
| } | |
| toReturn["actions"] = encodedActions; | |
| return toReturn; | |
| } | |
| /// <summary> | |
| /// Returns a string that represents the current <see cref="ActionSequence"/>. | |
| /// </summary> | |
| /// <returns>A string that represents the current <see cref="ActionSequence"/>.</returns> | |
| public override string ToString() | |
| { | |
| StringBuilder builder = new StringBuilder("Action sequence - ").Append(this.InputDevice.ToString()); | |
| foreach (Interaction action in this.interactions) | |
| { | |
| builder.AppendLine(); | |
| builder.AppendFormat(" {0}", action.ToString()); | |
| } | |
| return builder.ToString(); | |
| } | |
| } |