Package 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.
-
Method Summary
Modifier and Type Method Description 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
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getRootHtmlElementProperties, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, 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, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages
-
Method Details
-
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
-