Package org.zkoss.zats.mimic.operation

Interface InputAgent

All Superinterfaces:
Agent, OperationAgent
All Known Implementing Classes:
AbstractInputAgentBuilder.AbstractInputAgentImpl, DateInputAgentBuilder.InputAgentImpl, DateTypeAgentBuilderZK96.InputAgentZK96Impl, TimeInputAgentBuilder.InputAgentImpl
public interface InputAgent extends OperationAgent
To perform input to a component that extends from InputElement. For most input components that can type text in, use type(String) and for others use input(Object).
Author:
pao, dennis

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    input(Object value)
    To input value into a component.
    void
    select(int start, int end)
    To select (highlight) a range to text of an InputElement by specifying 2 indexes.
    void
    type(String value)
    To type text into a component.
    void
    typing(String value)
    To simulate typing data into a component and it will send onChanging event to server.

    Methods inherited from interface org.zkoss.zats.mimic.Agent

    getClient, getDelegatee

  • Method Details

    • input

      void input(Object value)
      To input value into a component. This method generalizes various input operation to a InputElement, e.g. typing in a Textbox, or scrolling a Slider. For those components that you cannot type text in, e.g. Slider is inputed by scrolling its bar. you can use this method to mimic the special input operation other than typing.
      You can pass in an Integer for a a intbox, Double for a doublebox, and Date for a datebox. Parameter's type depends on target component.
      Parameters:
      value - the input value

    • type

      void type(String value)
      To type text into a component. The value should be valid for target component, e.g. Intbox only accepts integer. If the target is Datebox or Timebox, your input text format should match "format" attribute's pattern.
      Parameters:
      value - the input value

    • typing

      void typing(String value)
      To simulate typing data into a component and it will send onChanging event to server.
      Parameters:
      value - the typing value.

    • select

      void select(int start, int end)
      To select (highlight) a range to text of an InputElement by specifying 2 indexes.
      Parameters:
      start - the beginning index,start from 0, inclusive.
      end - the ending index, exclusive.