com.ebasetech.xi.api

Interface Controls

All Superinterfaces:

java.lang.Iterable<Control>

public interface Controls
extends java.lang.Iterable<Control>

The Controls interface acts as a parent object for all controls on all pages within a form. Individual controls are accessed using their control name. When a control's name is not a valid Java identifier e.g. it begins with a numeric, the control can only be accessed using the getControl(String) method.

When running an event that forms part of a deployed component, only controls from the component can be accessed.

All included controls can be iterated using the following code:

 for ( var control in Iterator(controls.iterator()) )
 {
    log(control.elementName);
 }   
 

Examples:

 controls.PANEL1.hide();
 controls.getControl("23BUTTON").backgroundColor = "Yellow";
 

Since:

V4.4

Method Summary

Modifier and Type	Method and Description
Control	getControl(java.lang.String controlName) Returns the Control with name controlName.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getControl

Control getControl(java.lang.String controlName)

Returns the Control with name controlName.

Since:

V4.4