com.ebasetech.xi.api.controls
Interface IncludeControl

All Superinterfaces:

Control, Element, EventOwner, MessageContainer, java.io.Serializable, WebFormEventOwner

public interface IncludeControl
extends Control

An Include Control represents an external JSP or HTML file that is to be inserted into the generated page output at the location represented by the control. Only files within the Ebase web application can be included.

Further documentation.

Method Summary

java.lang.String	getFile() The URL of the JSP/HTML file relative to the document root of the Ebase web application.
boolean	isStatic() Indicates whether the JSP/HTML file represented by this control should be refreshed when Ajax communication is enabled and a page is redisplayed e.g.
void	setFile(java.lang.String file) Sets the URL of the JSP/HTML file relative to the document root of the Ebase web application.
void	setStatic(boolean isStatic) Sets whether the JSP/HTML file represented by this control should be refreshed when Ajax communication is enabled and a page is redisplayed e.g.

Methods inherited from interface com.ebasetech.xi.api.controls.Control

getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show

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, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, existErrorMessages, existMessages, existWarningMessages

Method Detail

getFile

java.lang.String getFile()

The URL of the JSP/HTML file relative to the document root of the Ebase web application. Only files within the Ebase web application can be included.

Since:

V4.4

See Also:

setFile(String)

setFile

void setFile(java.lang.String file)

Sets the URL of the JSP/HTML file relative to the document root of the Ebase web application. Only files within the Ebase web application can be included.

Examples:

 controls.INCLUDE1.file = "samples/jsps/JSP001.jsp";
 

Since:

V4.4

isStatic

boolean isStatic()

Indicates whether the JSP/HTML file represented by this control should be refreshed when Ajax communication is enabled and a page is redisplayed e.g. when an event such as a button click, hyperlink or field immediate validation results in the same page being redisplayed. Note that JSP/HTML files are always refreshed when moving to a different page or when Ajax communication is disabled.

Since:

V4.5.2

See Also:

setStatic(boolean)

setStatic

void setStatic(boolean isStatic)

Sets whether the JSP/HTML file represented by this control should be refreshed when Ajax communication is enabled and a page is redisplayed e.g. when an event such as a button click, hyperlink or field immediate validation results in the same page being redisplayed. Note that JSP/HTML files are always refreshed when moving to a different page or when Ajax communication is disabled.

Since:

V4.5.2