com.tle.web.wizard.scripting.objects
Interface PageScriptObject
Declaration: public interface PageScriptObject extends ScriptObject
All Superinterfaces: ScriptObject, java.io.Serializable

 

Referenced by the 'page' variable in script

 

 

Methods Summary
abstract ControlScriptObject getControlByIndex(int index)
    
abstract int getControlCount()
    
abstract int getPageNumber()
    
abstract java.lang.String getPageTitle()
    
abstract boolean isEnabled()
    
abstract boolean isValid()
    
abstract void setEnabled(boolean enabled)
    
abstract void setPageTitle(java.lang.String title)
    
abstract void setValid(boolean valid)
    

 

Methods inherited from interface: com.tle.common.scripting.ScriptObject
scriptEnter, scriptExit

 

 

 

 

isEnabled

 

public abstract boolean isEnabled( )

 

Returns:
Controls on the page are editable

 

 

 

setEnabled

 

public abstract void setEnabled( boolean enabled)

 

Parameters:
enabled-
Controls on the page are editable

 

 

 

getPageTitle

 

public abstract java.lang.String getPageTitle( )

 

Returns:
The title of the page

 

 

 

setPageTitle

 

public abstract void setPageTitle( java.lang.String title)

 

Parameters:
title-
The new title of the page

 

 

 

isValid

 

public abstract boolean isValid( )

 

Returns:
All mandatory controls are filled in

 

 

 

setValid

 

public abstract void setValid( boolean valid)

 

Parameters:
valid-
You can cause the page to become invalid. This will prevent the item from being submitted.

 

 

 

getPageNumber

 

public abstract int getPageNumber( )

 

Returns:
The number of this page, starting at zero

 

 

 

getControlCount

 

public abstract int getControlCount( )

 

Returns:
The number of controls on this page.

 

 

 

getControlByIndex

 

public abstract ControlScriptObject getControlByIndex( int index)

 

Parameters:
index-
A zero-based control index
Returns:
Will return null if the index is out of range, otherwise a ControlScriptObject instance will be returned.