Class NumberFieldTester

  • All Implemented Interfaces:
    com.vaadin.browserless.Clickable

    
    public class NumberFieldTester<T extends AbstractNumberField<T, V>, V extends Number>
    extends ComponentTester<T>
                        

    Tester for NumberField components.

    Since:

    1.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final T component
    • Constructor Summary

      Constructors 
      Constructor Description
      NumberFieldTester(T component) Wrap given component for testing.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      void setValue(V value) Set the given value for the component, as the user would type it.
      void clear() Empties the field, as when the user deletes its contents (or clicks the clear button, where one is shown).
      void clickClearButton() Empties the field by clicking its clear button, as the user would.
      boolean isValid() Checks whether the field is currently valid, running the component's own default validator — required, min, max and, when it is explicitly set, the step scale — and honouring an invalid state set from the outside, as a com.vaadin.flow.data.binder.Binder or a custom validator does.
      void stepUp() Simulates the user clicking the step up button once.
      void stepUp(int times) Simulates the user clicking the step up button the given number of times.
      void stepDown() Simulates the user clicking the step down button once.
      void stepDown(int times) Simulates the user clicking the step down button the given number of times.
      • Methods inherited from class com.vaadin.browserless.ComponentTester

        blur, ensureComponentIsUsable, find, focus, getComponent, isFocused, isUsable, setModal
      • Methods inherited from class com.vaadin.browserless.Clickable

        click, click, click, middleClick, middleClick, rightClick, rightClick
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • NumberFieldTester

        NumberFieldTester(T component)

        Wrap given component for testing.

        Parameters:
        component - target component
    • Method Detail

      • setValue

         void setValue(V value)

        Set the given value for the component, as the user would type it.

        A value that violates the component's constraints — outside min - max, off the step scale, or the empty value on a required field — is committed all the same, because the browser commits it too and simply leaves the field invalid. Assert that outcome with isValid instead of expecting this method to throw.
        Parameters:
        value - value to set
      • clear

         void clear()

        Empties the field, as when the user deletes its contents (or clicks the clear button, where one is shown).

        Emptying is something the user can always do, so it needs no clear button: a field may legitimately end up invalid — a required field, for instance — once emptied.
        Since:

        25.3

      • clickClearButton

         void clickClearButton()

        Empties the field by clicking its clear button, as the user would.

        Unlike clear, which models selecting the contents and deleting them and is therefore always available, this requires the clear button to be visible — a hidden clear button is not something the user can click.
        Since:

        25.3

      • isValid

         boolean isValid()

        Checks whether the field is currently valid, running the component's own default validator — required, min, max and, when it is explicitly set, the step scale — and honouring an invalid state set from the outside, as a com.vaadin.flow.data.binder.Binder or a custom validator does.

        A field can hold a value that does not satisfy its constraints — the user can type one, setValue commits it as the browser does, and the value can also be set on the server or stepped from an unaligned value — so a test asserting on validation state checks this instead of expecting a value to be refused.

        Returns:

        true if the field is not marked invalid and its current value satisfies the constraints of the field

        Since:

        25.3

      • stepUp

         void stepUp()

        Simulates the user clicking the step up button once.

        The step buttons are only rendered when setStepButtonsVisible is enabled, so stepping a field without them throws an IllegalStateException.

        Since:

        25.3

      • stepUp

         void stepUp(int times)

        Simulates the user clicking the step up button the given number of times.

        Each click sets the value on its own, so one value change event is fired per click, as in the browser. If a click cannot be performed, the value keeps the steps that were applied before it.

        Parameters:
        times - how many times the step up button is clicked, must be a positive integer
        Since:

        25.3

      • stepDown

         void stepDown()

        Simulates the user clicking the step down button once.

        The step buttons are only rendered when setStepButtonsVisible is enabled, so stepping a field without them throws an IllegalStateException.

        Since:

        25.3

      • stepDown

         void stepDown(int times)

        Simulates the user clicking the step down button the given number of times.

        Each click sets the value on its own, so one value change event is fired per click, as in the browser. If a click cannot be performed, the value keeps the steps that were applied before it.

        Parameters:
        times - how many times the step down button is clicked, must be a positive integer
        Since:

        25.3