IncludeControl

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.

IncludeControl Functions

getFile	IncludeControl.getFile( )	The URL of the JSP/HTML file relative to the document root of the Ebase web application.
setFile	IncludeControl.setFile( file )	Sets the URL of the JSP/HTML file relative to the document root of the Ebase web application.
isStatic	IncludeControl.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.
setStatic	IncludeControl.setStatic( 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.

Control Functions

addCssClass	IncludeControl.addCssClass( cssClass )	Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes.
getAll	IncludeControl.getAll( )	Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page.
isContainer	IncludeControl.isContainer( )	Returns true if this control is a container control i.e.
getCssClass	IncludeControl.getCssClass( )	Returns the list of CSS classes configured for the control.
setCssClass	IncludeControl.setCssClass( cssClass )	Sets one or more CSS classes to be applied to the control.
isDisplayOnly	IncludeControl.isDisplayOnly( )	Returns `true` if the control is marked as display only, otherwise returns `false`.
setDisplayOnly	IncludeControl.setDisplayOnly( displayOnly )	Marks the control and all its children as display only (when `displayOnly` is `true`) or enterable (when `displayOnly` is `false`).
isDisplayOnlyIncludingParents	IncludeControl.isDisplayOnlyIncludingParents( )	Returns `true` if the control or any of its parents is marked as display only, otherwise returns `false`.
getErrorMsgClass	IncludeControl.getErrorMsgClass( )	Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control.
setErrorMsgClass	IncludeControl.setErrorMsgClass( errorMsgClass )	Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control.
getErrorMsgStyle	IncludeControl.getErrorMsgStyle( )	Returns the inline CSS style configured for error messages when the messages are displayed locally to the control.
setErrorMsgStyle	IncludeControl.setErrorMsgStyle( errorMsgStyle )	Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control.
isEventField	IncludeControl.isEventField( )	Returns `true` if the control is an event field i.e.
hasModifier	IncludeControl.hasModifier( modifier )	Returns true if the control has the specified modifier, otherwise returns false.
isHidden	IncludeControl.isHidden( )	Returns `true` if the control is marked as hidden, otherwise returns `false`.
setHidden	IncludeControl.setHidden( hidden )	Hides or shows the control and all its children.
hide	IncludeControl.hide( )	Hides the control, this is equivalent to setting property `hidden` to `true`.
getInfoMsgClass	IncludeControl.getInfoMsgClass( )	Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control.
setInfoMsgClass	IncludeControl.setInfoMsgClass( infoMsgClass )	Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control.
getInfoMsgStyle	IncludeControl.getInfoMsgStyle( )	Returns the inline CSS style configured for info messages when the messages are displayed locally to the control.
setInfoMsgStyle	IncludeControl.setInfoMsgStyle( infoMsgStyle )	Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control.
isInheritMsg	IncludeControl.isInheritMsg( )	Returns `true` if Use parent control setting is checked in the Message Options properties for the control, otherwise returns `false`.
getLayoutCell	IncludeControl.getLayoutCell( )	Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control.
isLocalMsg	IncludeControl.isLocalMsg( )	Returns `true` if Local Message is checked in the Message Options properties for the control, otherwise returns `false`.
isNewLine	IncludeControl.isNewLine( )	Returns the new line property.
setNewLine	IncludeControl.setNewLine( newLine )	Sets or unsets the control's new line property.
getNextSiblingControl	IncludeControl.getNextSiblingControl( )	Returns the control that appears after this control within the same parent, or null if no such control exists.
getPage	IncludeControl.getPage( )	Returns the com.ebasetech.xi.api.Page where this control is located.
getParentControl	IncludeControl.getParentControl( )	Returns this control's parent control or null if no such parent exists.
getPreviousSiblingControl	IncludeControl.getPreviousSiblingControl( )	Returns the control that appears before this control within the same parent, or null if no such control exists.
refresh	IncludeControl.refresh( )	Refreshes this control in the user's browser when the page is next displayed.
removeCssClass	IncludeControl.removeCssClass( cssClass )	Removes one or more CSS classes from the control.
requestFocus	IncludeControl.requestFocus( )	Sets the browser focus to the control.
getRootHtmlElementProperties	IncludeControl.getRootHtmlElementProperties( )	Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control
show	IncludeControl.show( )	Shows the control, this is equivalent to setting property `hidden` to `false`.
isShowing	IncludeControl.isShowing( )	Returns `true` if the control will be included in the web page when it's next displayed to the user, otherwise returns `false`.
getStyle	IncludeControl.getStyle( )	Returns the inline CSS style configured for the control.
setStyle	IncludeControl.setStyle( style )	Sets inline CSS style to be applied to the control.
getWarningMsgClass	IncludeControl.getWarningMsgClass( )	Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control.
setWarningMsgClass	IncludeControl.setWarningMsgClass( warningMsgClass )	Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control.
getWarningMsgStyle	IncludeControl.getWarningMsgStyle( )	Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control.
setWarningMsgStyle	IncludeControl.setWarningMsgStyle( warningMsgStyle )	Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control.

MessageContainer Functions

addErrorMessage	IncludeControl.addErrorMessage( message [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessage	IncludeControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessageText	IncludeControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage	IncludeControl.addInfoMessage( message [, stopProcessing ] )	Adds an information message that will be displayed to the user.
addInfoMessageText	IncludeControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage	IncludeControl.addWarningMessage( message [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessage	IncludeControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessageText	IncludeControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages	IncludeControl.existErrorMessages( )	Returns `true` if undisplayed error messages exist for this element, otherwise returns `false`.
existInfoMessages	IncludeControl.existInfoMessages( )	Returns `true` if undisplayed info messages exist for this element, otherwise returns `false`.
existMessages	IncludeControl.existMessages( )	Returns `true` if undisplayed info, warning or error messages exist for this element, otherwise returns `false`.
existWarningMessages	IncludeControl.existWarningMessages( )	Returns `true` if undisplayed warning messages exist for this element, otherwise returns `false`.

Element Functions

getElementName	IncludeControl.getElementName( )	Returns the element name
getElementType	IncludeControl.getElementType( )	Returns the element type