Package com.ebasetech.xi.api
Interface Page
- All Superinterfaces:
Element
,EventOwner
,MessageContainer
,java.io.Serializable
,WebFormEventOwner
public interface Page extends Element, WebFormEventOwner
The
Page
interface represents a displayable page of a form. A page can be displayed to a user as a web page or can be included
within a PDF document (see WebForm.generatePdf(PdfOptions)
).
Individual pages can be accessed via the Pages
interface.
- Since:
- V4.4
-
Method Summary
Modifier and Type Method Description void
clearFocus()
Removes any focus set on the page for individual controls using methodControl.requestFocus()
.Control[]
getAllControls()
Returns an array of all controls on the page in display order.Control[]
getControlsByModifier(java.lang.String modifier)
Returns an array of controls that have the named modifier.Page
getNextPage()
Returns thePage
object for the next page or null if no next page exists.Control
getPageControl()
Returns the Page Control that acts as the root control for all controls on the page.Page
getPreviousPage()
Returns thePage
object for the previous page displayed to the user.Methods inherited from interface com.ebasetech.xi.api.Element
getElementName, getElementType
Methods inherited from interface com.ebasetech.xi.api.MessageContainer
addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages
-
Method Details
-
getPageControl
Control getPageControl()Returns the Page Control that acts as the root control for all controls on the page.- Since:
- V4.4
-
getAllControls
Control[] getAllControls()Returns an array of all controls on the page in display order.Javascript example:
for each (var ctrl in pages.PAGE_1.allControls) { log(ctrl.elementName); }
- Returns:
- an array of all controls on the page
- Since:
- V4.4
-
clearFocus
void clearFocus()Removes any focus set on the page for individual controls using methodControl.requestFocus()
. Note that focus is reset automatically each time a page is displayed.- Since:
- V4.4
- See Also:
Control.requestFocus()
-
getControlsByModifier
Returns an array of controls that have the named modifier.Modifiers provide a way of flagging one or more controls so they can be found programatically, e.g. a group of Field Controls might be changed from enterable to display only. Modifiers are assigned to controls at design time using the Modifiers property. Any number of modifiers can be assigned - modifiers are entered as a comma delimited list.
Javascript example:
var page = pages.PAGE_1; for each (var ctrl in page.getControlsByModifier("FINANCE")) { if (!system.securityManager.hasRole("FINANCE_CONTROLLER")) { ctrl.hide(); } }
- Parameters:
modifier
-- Returns:
- an array of controls that have the named modifier
- Since:
- V4.4
- See Also:
Control.hasModifier(String)
-
getNextPage
Page getNextPage()Returns thePage
object for the next page or null if no next page exists. This is the page which will be displayed to the user when a Next Page Button is clicked.- Returns:
- next page
- Since:
- V4.5
-
getPreviousPage
Page getPreviousPage()Returns thePage
object for the previous page displayed to the user. This method only returns a valid Page object when the page on which it is invoked has been displayed to the user, otherwise it returns null.- Returns:
- previous page
- Since:
- V4.5
-