HorizontalLineControl

HorizontalLineControl Functions

getColor	HorizontalLineControl.getColor( )	The line color.
setColor	HorizontalLineControl.setColor( color )	Sets the line color.
getWidth	HorizontalLineControl.getWidth( )	Line width.
setWidth	HorizontalLineControl.setWidth( width )	Sets the line width.

Control Functions

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

MarginStyleProperties Functions

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

MessageContainer Functions

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

Element Functions

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