SpacerControl

SpacerControl Functions

getHeight	SpacerControl.getHeight( )	Spacer height.
setHeight	SpacerControl.setHeight( height )	Sets the spacer height.
getWidth	SpacerControl.getWidth( )	Spacer width.
setWidth	SpacerControl.setWidth( width )	Sets the spacer width.

Control Functions

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

MarginStyleProperties Functions

getAllMargin	SpacerControl.getAllMargin( )	Single MarginStyleProperties size value used for top, bottom, left and right margin.
setAllMargin	SpacerControl.setAllMargin( allMargin )	Sets the MarginStyleProperties size value used for top, bottom, left and right margin.
getBottomMargin	SpacerControl.getBottomMargin( )	Bottom MarginStyleProperties size value.
setBottomMargin	SpacerControl.setBottomMargin( bottomMargin )	Sets the bottom MarginStyleProperties size value.
getLeftMargin	SpacerControl.getLeftMargin( )	Left MarginStyleProperties size value.
setLeftMargin	SpacerControl.setLeftMargin( leftMargin )	Sets the left MarginStyleProperties size value.
getRightMargin	SpacerControl.getRightMargin( )	Right MarginStyleProperties size value.
setRightMargin	SpacerControl.setRightMargin( rightMargin )	Sets the right MarginStyleProperties size value.
getTopMargin	SpacerControl.getTopMargin( )	Top MarginStyleProperties size value.
setTopMargin	SpacerControl.setTopMargin( topMargin )	Sets the top MarginStyleProperties size value.

MessageContainer Functions

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

Element Functions

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