Verj.io JavaScript API

SectionControl

Section Control A container that wraps content in a section tag. 
  <section>
  .. child controls
  </section>

Further documentation.

BasicBlockControl Functions

getHeight SectionControl.getHeight( ) Panel height.
setHeight SectionControl.setHeight( height ) Sets the panel height, and is equivalent to the CSS height property and any valid value for this CSS property can be used.
getWidth SectionControl.getWidth( ) Panel width.
setWidth SectionControl.setWidth( width ) Sets the panel width.

AriaControlProperties Functions

addAriaCustomAttribute SectionControl.addAriaCustomAttribute( name , value ) Add an ARIA custom attribute with a specified name and value.
getAriaCustomAttributes SectionControl.getAriaCustomAttributes( ) Returns a comma separated list of the ARIA custom attributes for the control.
setAriaCustomAttributes SectionControl.setAriaCustomAttributes( ariaCustomAttributes ) Sets the ARIA custom attributes as a comma separated list associated with the control property and overrides the aria custom attributes value.
getAriaDescribedBy SectionControl.getAriaDescribedBy( ) Returns the ARIA described-by element ID for the control.
getAriaLabelledBy SectionControl.getAriaLabelledBy( ) Returns the ARIA labelled-by element ID for the control.
getAriaLabelText SectionControl.getAriaLabelText( ) Returns the com.ebasetech.xi.api.Text object for the ARIA label text.
getAriaRole SectionControl.getAriaRole( ) Returns the ARIA role for the control.
setAriaRole SectionControl.setAriaRole( role ) Sets the ARIA role for the control.
removeAriaCustomAttribute SectionControl.removeAriaCustomAttribute( name ) Remove an ARIA custom attribute specified by name.

BackgroundStyleProperties Functions

getBackgroundColor SectionControl.getBackgroundColor( ) Background color.
setBackgroundColor SectionControl.setBackgroundColor( backgroundColor ) Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used.
getBackgroundImage SectionControl.getBackgroundImage( ) URL of the background image.
setBackgroundImage SectionControl.setBackgroundImage( backgroundImage ) Sets the URL of the background image.
getBackgroundImagePosition SectionControl.getBackgroundImagePosition( ) Background image position.
setBackgroundImagePosition SectionControl.setBackgroundImagePosition( backgroundImagePosition ) Sets the background image position.
getBackgroundImageRepeat SectionControl.getBackgroundImageRepeat( ) Background image repeat property.
setBackgroundImageRepeat SectionControl.setBackgroundImageRepeat( backgroundImageRepeat ) Sets the background image repeat property.

BorderStyleProperties Functions

getBorderColor SectionControl.getBorderColor( ) Border color applied to all borders.
setBorderColor SectionControl.setBorderColor( borderColor ) Sets border color.
getBorderRadius SectionControl.getBorderRadius( ) Border radius.
setBorderRadius SectionControl.setBorderRadius( borderRadius ) Sets border radius.
getBorderStyle SectionControl.getBorderStyle( ) Border style applied to all borders.
setBorderStyle SectionControl.setBorderStyle( borderStyle ) Sets border style.
getBorderWidth SectionControl.getBorderWidth( ) Border width applied to all four borders.
setBorderWidth SectionControl.setBorderWidth( borderWidth ) Sets the border width applied to all four borders.
getBottomBorderWidth SectionControl.getBottomBorderWidth( ) Bottom border width, overriding property borderWidth.
setBottomBorderWidth SectionControl.setBottomBorderWidth( bottomBorderWidth ) Sets the bottom border width, overriding property borderWidth.
getLeftBorderWidth SectionControl.getLeftBorderWidth( ) Left border width, overriding property borderWidth.
setLeftBorderWidth SectionControl.setLeftBorderWidth( leftBorderWidth ) Sets the left border width, overriding property borderWidth.
getRightBorderWidth SectionControl.getRightBorderWidth( ) Right border width, overriding property borderWidth.
setRightBorderWidth SectionControl.setRightBorderWidth( rightBorderWidth ) Sets the right border width, overriding property borderWidth.
getTopBorderWidth SectionControl.getTopBorderWidth( ) Top border width, overriding property borderWidth.
setTopBorderWidth SectionControl.setTopBorderWidth( topBorderWidth ) Sets the top border width, overriding property borderWidth.

LayoutControl Functions

getLayout SectionControl.getLayout( ) Returns the Layout object configured for the container control or null if no layout is configured.
getLayoutType SectionControl.getLayoutType( ) Returns a String representing the layout type for the container.

MarginStyleProperties Functions

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

PaddingStyleProperties Functions

getAllPadding SectionControl.getAllPadding( ) Single PaddingStyleProperties size value used for top, bottom, left and right padding.
setAllPadding SectionControl.setAllPadding( allPadding ) Sets the PaddingStyleProperties size value used for top, bottom, left and right padding.
getBottomPadding SectionControl.getBottomPadding( ) Bottom PaddingStyleProperties size value.
setBottomPadding SectionControl.setBottomPadding( bottomPadding ) Sets the bottom PaddingStyleProperties size value.
getLeftPadding SectionControl.getLeftPadding( ) Left PaddingStyleProperties size value.
setLeftPadding SectionControl.setLeftPadding( leftPadding ) Sets the left PaddingStyleProperties size value.
getRightPadding SectionControl.getRightPadding( ) Right PaddingStyleProperties size value.
setRightPadding SectionControl.setRightPadding( rightPadding ) Sets the right PaddingStyleProperties size value.
getTopPadding SectionControl.getTopPadding( ) Top PaddingStyleProperties size value.
setTopPadding SectionControl.setTopPadding( topPadding ) Sets the top PaddingStyleProperties size value.

TextStyleProperties Functions

getLineHeight SectionControl.getLineHeight( ) Line height.
setLineHeight SectionControl.setLineHeight( lineHeight ) Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used.
getTextBold SectionControl.getTextBold( ) Text bold setting.
setTextBold SectionControl.setTextBold( textBold ) Sets the text bold setting.
getTextColor SectionControl.getTextColor( ) Text color.
setTextColor SectionControl.setTextColor( textColor ) Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used.
getTextDecoration SectionControl.getTextDecoration( ) Text decoration property (shown as Lines in the designer).
setTextDecoration SectionControl.setTextDecoration( textDecoration ) Sets the text decoration property (shown as Lines in the designer).
getTextFont SectionControl.getTextFont( ) List of text fonts.
setTextFont SectionControl.setTextFont( textFont ) Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used.
getTextItalic SectionControl.getTextItalic( ) Text italic setting.
setTextItalic SectionControl.setTextItalic( textItalic ) Sets the text italic setting.
getTextSize SectionControl.getTextSize( ) Text size.
setTextSize SectionControl.setTextSize( textSize ) Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used.

ContainerControl Functions

getChildControls SectionControl.getChildControls( ) Returns an array of controls that are immediate children of this control.

MessageProperties Functions

getErrorMessageStyle SectionControl.getErrorMessageStyle( ) Returns the MessageStyleProperties object representing error message styling properties.
getInfoMessageStyle SectionControl.getInfoMessageStyle( ) Returns the MessageStyleProperties object representing info message styling properties.
getWarningMessageStyle SectionControl.getWarningMessageStyle( ) Returns the MessageStyleProperties object representing warning message styling properties.

Control Functions

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

MessageContainer Functions

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

Element Functions

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