Interface WebFormEventContext

All Superinterfaces:
EventContext

public interface WebFormEventContext
extends EventContext
The WebFormEventContext interface provides context information about an Ebase event executed by an interactive form.
Since:
V4.4
  • Method Summary

    Modifier and Type Method Description
    java.lang.String getComponentPrefix()
    Returns the component prefix when the event currently being executed forms part of a deployed component i.e.
    WebFormEventOwner getOwner()
    Returns the object that owns the event currently being executed.
    boolean isComponent()
    Returns true if the event currently being executed forms part of a deployed component i.e.

    Methods inherited from interface com.ebasetech.xi.api.EventContext

    getEventDescription, stopExecution
  • Method Details

    • getOwner

      WebFormEventOwner getOwner()
      Returns the object that owns the event currently being executed. This will be one of:
      • Control for control level events e.g. button click, hyperlinks, immediate validation
      • Page for page level events e.g. before page, after page
      • Form for form level events e.g. before form, after form, on error and client API calls to run a function using executeFunction()
      Specified by:
      getOwner in interface EventContext
      Returns:
      event owner object
      Since:
      V4.4
    • isComponent

      boolean isComponent()
      Returns true if the event currently being executed forms part of a deployed component i.e. the control or page that is the event owner forms part of a deployed component, otherwise returns false.
      Since:
      V4.4
    • getComponentPrefix

      java.lang.String getComponentPrefix()
      Returns the component prefix when the event currently being executed forms part of a deployed component i.e. the control or page that is the event owner forms part of a deployed component, or null otherwise.
      Returns:
      component prefix
      Since:
      V4.4