com.ebasetech.xi.api

Interface Pages

All Superinterfaces:

java.lang.Iterable<Page>

public interface Pages
extends java.lang.Iterable<Page>

The Pages interface acts as a parent object for all pages within an interactive form. Individual pages are accessed using their page name. When the name is not a valid Java identifier e.g. it begins with a numeric, the page can only be accessed using the getPage(String) method.

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

All included pages can be iterated using the following code, pages are presented in the same order as they appear in the designer:

 for ( var page in Iterator(pages.iterator()) )
 {
    log(page.elementName);
 }   
 

Examples:

 var p1 = pages.PAGE1;
 var p10 = pages.getPage("10PAGE");
 

Since:

V4.4

Method Summary

Modifier and Type	Method and Description
Page	getPage(java.lang.String pageName) Returns the Page with name pageName.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getPage

Page getPage(java.lang.String pageName)

Returns the Page with name pageName.

Since:

V4.4