Interface ILookupComponent

Namespace

GroupeIsa.Neos.EndToEndTests.UI.Components

Assembly

GroupeIsa.Neos.EndToEndTests.UI.dll

Provides the functionalities of the automation of a lookup component.

[AbstractionComponent("lookup")]
public interface ILookupComponent : IFormFieldComponent, IAutomationComponent, IInputComponent, IValidationComponent, IFocusableComponent, ISelectableComponent, IClearableComponent

Inherited Members

IFormFieldComponent.HasRequiredIndicator

IFormFieldComponent.IsReadOnly

IFormFieldComponent.GetCaptionText()

IAutomationComponent.OwnerComponent

IAutomationComponent.IsVisible

IAutomationComponent.IsVisibleInViewPort

IAutomationComponent.Size

IAutomationComponent.WaitUntilVisible()

IAutomationComponent.WaitUntilHidden()

IAutomationComponent.ScrollIntoView()

IAutomationComponent.GetOwnerUIViewName()

IValidationComponent.HasErrorIndicator

IValidationComponent.ErrorMessage

IValidationComponent.WaitUntilHasErrorIndicator()

IValidationComponent.WaitUntilHasNoErrorIndicator()

IFocusableComponent.IsActiveElement

IFocusableComponent.Focus()

IFocusableComponent.SendKeys(string)

IFocusableComponent.SendKeys(params KeyboardKeys[])

IFocusableComponent.WaitUntilIsActiveElement()

IFocusableComponent.WaitUntilIsNotActiveElement()

ISelectableComponent.SelectAllText()

ISelectableComponent.GetSelectedText()

IClearableComponent.CanClear

IClearableComponent.Clear()

Properties

HasCreateButton

Gets a value indicating whether the create button is displayed before input.

bool HasCreateButton { get; }

Property Value

bool

HasEditButton

Gets a value indicating whether the edit button is displayed before input.

bool HasEditButton { get; }

Property Value

bool

HasSuggestionsCreateButton

Gets a value indicating whether the create button of the lookup suggestions is displayed.

bool HasSuggestionsCreateButton { get; }

Property Value

bool

HasSuggestionsListOpen

Gets a value indicating whether the lookup suggestion list is opened.

bool HasSuggestionsListOpen { get; }

Property Value

bool

IsLoading

Gets a value indicating whether the lookup is loading.

bool IsLoading { get; }

Property Value

bool

IsLoadingSuggestions

Gets a value indicating whether the lookup suggestion list is loading.

[Obsolete("Use the IsLoading property instead.")]
bool IsLoadingSuggestions { get; }

Property Value

bool

Suggestions

Gets the list of displayed suggestions.

IEnumerable<string> Suggestions { get; }

Property Value

IEnumerable<string>

Methods

ClickOnCreateButton()

Opens the creation view by clicking on the create button in the input.

Task<IFrameComponent> ClickOnCreateButton()

Returns

Task<IFrameComponent>

The frame containing the creation UI view component.

Remarks

The creation view is expected to be opened in a popup.
If the lookup is configured to open it in a new or nested frame, use ClickOnCreateButton(OpenMode) instead.

Exceptions

AutomationException

Throws when the create button is not displayed.

ClickOnCreateButton(OpenMode)

Opens the creation view by clicking on the create button in the input.

Task<IFrameComponent> ClickOnCreateButton(ILookupComponent.OpenMode openMode)

Parameters

openMode ILookupComponent.OpenMode

Open mode configured on the lookup.

Returns

Task<IFrameComponent>

The frame containing the creation UI view component.

Exceptions

AutomationException

Throws when the create button is not displayed.

ClickOnCreateButtonInSuggestions()

Opens the creation view by clicking on the create button in suggestions.

Task<IFrameComponent> ClickOnCreateButtonInSuggestions()

Returns

Task<IFrameComponent>

The frame containing the creation UI view component.

Remarks

The suggestions list has to be visible before using this function. It can be done by typing some input.

The creation view is expected to be opened in a popup.
If the lookup is configured to open it in a new or nested frame, use ClickOnCreateButtonInSuggestions(OpenMode) instead.

Exceptions

AutomationException

Throws when the create button is not displayed.

ClickOnCreateButtonInSuggestions(OpenMode)

Opens the creation view by clicking on the create button in suggestions.

Task<IFrameComponent> ClickOnCreateButtonInSuggestions(ILookupComponent.OpenMode openMode)

Parameters

openMode ILookupComponent.OpenMode

Open mode configured on the lookup.

Returns

Task<IFrameComponent>

The frame containing the creation IO view component.

Remarks

The suggestions list has to be visible before using this function. It can be done by typing some input.

Exceptions

AutomationException

Throws when the create button is not displayed.

ClickOnEditButton()

Opens the editing view by clicking on the create button in the input.

Task<IFrameComponent> ClickOnEditButton()

Returns

Task<IFrameComponent>

The frame containing the editing UI view component.

Remarks

The editing view is expected to be opened in a popup.
If the lookup is configured to open it in a new or nested frame, use ClickOnCreateButton(OpenMode) instead.

Exceptions

AutomationException

Throws when the edit button is not displayed.

ClickOnEditButton(OpenMode)

Opens the editing view by clicking on the create button in the input.

Task<IFrameComponent> ClickOnEditButton(ILookupComponent.OpenMode openMode)

Parameters

openMode ILookupComponent.OpenMode

Open mode configured on the lookup.

Returns

Task<IFrameComponent>

The frame containing the editing UI view component.

Exceptions

AutomationException

Throws when the edit button is not displayed.

CreateFromButton()

Opens the creation view by clicking on the create button in the input.

[Obsolete("Use the ClickOnCreateButton method instead.")]
Task<IUIViewComponent> CreateFromButton()

Returns

Task<IUIViewComponent>

The creation UI view component.

Remarks

The creation view is expected to be opened in a popup.
If the lookup is configured to open it in a new or nested frame, use ClickOnCreateButton(OpenMode) instead.

Exceptions

AutomationException

Throws when the create button is not displayed.

CreateFromButton(OpenMode)

Opens the creation view by clicking on the create button in the input.

[Obsolete("Use the ClickOnCreateButton method instead.")]
Task<IUIViewComponent> CreateFromButton(ILookupComponent.OpenMode openMode)

Parameters

openMode ILookupComponent.OpenMode

Open mode configured on the lookup.

Returns

Task<IUIViewComponent>

The creation UI view component.

Exceptions

AutomationException

Throws when the create button is not displayed.

CreateFromSuggestions()

Opens the creation view by clicking on the create button in the suggestions.

[Obsolete("Use the ClickOnCreateButtonInSuggestions method instead.")]
Task<IUIViewComponent> CreateFromSuggestions()

Returns

Task<IUIViewComponent>

The creation UI view component.

Remarks

The suggestions list has to be visible before using this function. It can be done by typing some input.

The creation view is expected to be opened in a popup.
If the lookup is configured to open it in a new or nested frame, use ClickOnCreateButtonInSuggestions(OpenMode) instead.

Exceptions

AutomationException

Throws when the create button is not displayed.

CreateFromSuggestions(OpenMode)

Opens the creation view by clicking on the create button in the suggestions.

[Obsolete("Use the ClickOnCreateButtonInSuggestions method instead.")]
Task<IUIViewComponent> CreateFromSuggestions(ILookupComponent.OpenMode openMode)

Parameters

openMode ILookupComponent.OpenMode

Open mode configured on the lookup.

Returns

Task<IUIViewComponent>

The creation UI view component.

Remarks

The suggestions list has to be visible before using this function. It can be done by typing some input.

Exceptions

AutomationException

Throws when the create button is not displayed.

EditFromButton()

Opens the editing view by clicking on the edit button in the input.

[Obsolete("Use the ClickOnEditButton method instead.")]
Task<IUIViewComponent> EditFromButton()

Returns

Task<IUIViewComponent>

The editing UI view component.

Remarks

The edit view is expected to be opened in a popup.
If the lookup is configured to open it in a new or nested frame, use ClickOnEditButton(OpenMode) instead.

Exceptions

AutomationException

Throws when the edit button is not displayed.

EditFromButton(OpenMode)

Opens the editing view by clicking on the edit button in the input.

[Obsolete("Use the ClickOnEditButton method instead.")]
Task<IUIViewComponent> EditFromButton(ILookupComponent.OpenMode openMode)

Parameters

openMode ILookupComponent.OpenMode

Open mode configured on the lookup.

Returns

Task<IUIViewComponent>

The editing UI view component.

Exceptions

AutomationException

Throws when the edit button is not displayed.

GetInputValue()

Gets the input current value.

string? GetInputValue()

Returns

string

The input current value.

OpenLookupModal()

Opens the lookup selection modal.

ILookupModalComponent OpenLookupModal()

Returns

ILookupModalComponent

The modal content.

SelectSuggestion(int)

Selects the displayed suggestion at index (starts at 0) to update the lookup value.

void SelectSuggestion(int index)

Parameters

index int

The index of the displayed suggestion (starts at 0).

Exceptions

AutomationException

Throws when there is no suggestion displayed at the provided index.

SetValueAndWaitValidation(string)

Sets the value of the lookup component. Waits for the suggestions list to be displayed. Validates the value by pressing enter. Waits validation.

bool SetValueAndWaitValidation(string value)

Parameters

value string

Value of the input.

Returns

bool

A value indicating whether the input is valid otherwise false if an error has occured.