BootstrapRowControl
BootstrapRowControl Functions
| isGutter | BootstrapRowControl.isGutter( ) | Have the gutters between columns been enabled. |
| setGutter | BootstrapRowControl.setGutter( enabled ) | The gutters between columns in our predefined grid classes are removed when gutters are disabled. |
| getGutterSize | BootstrapRowControl.getGutterSize( ) | |
| setGutterSize | BootstrapRowControl.setGutterSize( gutterSize ) | |
| getHeight | BootstrapRowControl.getHeight( ) | Row height. |
| setHeight | BootstrapRowControl.setHeight( height ) | Sets the row height, and is equivalent to the CSS height property and any valid value for this CSS property can be used. |
| getHorizontalAlignment | BootstrapRowControl.getHorizontalAlignment( ) | How the row is horizontally aligning all immediate child columns |
| setHorizontalAlignment | BootstrapRowControl.setHorizontalAlignment( alignment ) | Horizontally aligns the columns in the row. |
| getRowType | BootstrapRowControl.getRowType( ) | The type of row being represented see #setRowType(String) |
| setRowType | BootstrapRowControl.setRowType( type ) | The type of bootstrap row can be changed here. |
| getVerticalAlignment | BootstrapRowControl.getVerticalAlignment( ) | How the row is vertically aligning all immediate child columns |
| setVerticalAlignment | BootstrapRowControl.setVerticalAlignment( alignment ) | Vertically aligns the columns in the row. |
BackgroundStyleProperties Functions
| getBackgroundColor | BootstrapRowControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | BootstrapRowControl.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 | BootstrapRowControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | BootstrapRowControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | BootstrapRowControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | BootstrapRowControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | BootstrapRowControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | BootstrapRowControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BootstrapRowColumnsProperties Functions
| getExtraExtraLargeColumns | BootstrapRowControl.getExtraExtraLargeColumns( ) | Gets the number of columns for extra extra large screens. |
| setExtraExtraLargeColumns | BootstrapRowControl.setExtraExtraLargeColumns( numberOfColumns ) | Sets the number of columns for extra large screens. |
| getExtraLargeColumns | BootstrapRowControl.getExtraLargeColumns( ) | Gets the number of columns for extra large screens. |
| setExtraLargeColumns | BootstrapRowControl.setExtraLargeColumns( numberOfColumns ) | Sets the number of columns for extra large screens. |
| getExtraSmallColumns | BootstrapRowControl.getExtraSmallColumns( ) | Gets the number of columns for extra-small screens. |
| setExtraSmallColumns | BootstrapRowControl.setExtraSmallColumns( numberOfColumns ) | Sets the number of columns for extra-small screens. |
| getLargeColumns | BootstrapRowControl.getLargeColumns( ) | Gets the number of columns for large screens. |
| setLargeColumns | BootstrapRowControl.setLargeColumns( numberOfColumns ) | Gets the number of columns for large screens. |
| getMediumColumns | BootstrapRowControl.getMediumColumns( ) | Gets the number of columns for medium screens. |
| setMediumColumns | BootstrapRowControl.setMediumColumns( numberOfColumns ) | Sets the number of columns for medium screens. |
| getSmallColumns | BootstrapRowControl.getSmallColumns( ) | Gets the number of columns for small screens. |
| setSmallColumns | BootstrapRowControl.setSmallColumns( numberOfColumns ) | Sets the number of columns for small screens. |
BorderStyleProperties Functions
| getBorderColor | BootstrapRowControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | BootstrapRowControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | BootstrapRowControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | BootstrapRowControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | BootstrapRowControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | BootstrapRowControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | BootstrapRowControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | BootstrapRowControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | BootstrapRowControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | BootstrapRowControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | BootstrapRowControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | BootstrapRowControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | BootstrapRowControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | BootstrapRowControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | BootstrapRowControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | BootstrapRowControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
ContainerControl Functions
| getChildControls | BootstrapRowControl.getChildControls( ) | Returns an array of controls that are immediate children of this control. |
MarginStyleProperties Functions
| getAllMargin | BootstrapRowControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | BootstrapRowControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | BootstrapRowControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | BootstrapRowControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | BootstrapRowControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | BootstrapRowControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | BootstrapRowControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | BootstrapRowControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | BootstrapRowControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | BootstrapRowControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
PaddingStyleProperties Functions
| getAllPadding | BootstrapRowControl.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | BootstrapRowControl.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | BootstrapRowControl.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | BootstrapRowControl.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | BootstrapRowControl.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | BootstrapRowControl.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | BootstrapRowControl.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | BootstrapRowControl.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | BootstrapRowControl.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | BootstrapRowControl.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
TextStyleProperties Functions
| getLineHeight | BootstrapRowControl.getLineHeight( ) | Line height. |
| setLineHeight | BootstrapRowControl.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 | BootstrapRowControl.getTextBold( ) | Text bold setting. |
| setTextBold | BootstrapRowControl.setTextBold( textBold ) | Sets the text bold setting. |
| getTextColor | BootstrapRowControl.getTextColor( ) | Text color. |
| setTextColor | BootstrapRowControl.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 | BootstrapRowControl.getTextDecoration( ) | Text decoration property (shown as Lines in the designer). |
| setTextDecoration | BootstrapRowControl.setTextDecoration( textDecoration ) | Sets the text decoration property (shown as Lines in the designer). |
| getTextFont | BootstrapRowControl.getTextFont( ) | List of text fonts. |
| setTextFont | BootstrapRowControl.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 | BootstrapRowControl.getTextItalic( ) | Text italic setting. |
| setTextItalic | BootstrapRowControl.setTextItalic( textItalic ) | Sets the text italic setting. |
| getTextSize | BootstrapRowControl.getTextSize( ) | Text size. |
| setTextSize | BootstrapRowControl.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. |
Control Functions
| addCssClass | BootstrapRowControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | BootstrapRowControl.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 | BootstrapRowControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | BootstrapRowControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | BootstrapRowControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | BootstrapRowControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | BootstrapRowControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | BootstrapRowControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | BootstrapRowControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | BootstrapRowControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | BootstrapRowControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | BootstrapRowControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | BootstrapRowControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | BootstrapRowControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | BootstrapRowControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | BootstrapRowControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | BootstrapRowControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | BootstrapRowControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | BootstrapRowControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | BootstrapRowControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | BootstrapRowControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | BootstrapRowControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | BootstrapRowControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | BootstrapRowControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | BootstrapRowControl.isNewLine( ) | Returns the new line property. |
| setNewLine | BootstrapRowControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | BootstrapRowControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | BootstrapRowControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | BootstrapRowControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | BootstrapRowControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | BootstrapRowControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | BootstrapRowControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | BootstrapRowControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | BootstrapRowControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | BootstrapRowControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | BootstrapRowControl.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 | BootstrapRowControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | BootstrapRowControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | BootstrapRowControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | BootstrapRowControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | BootstrapRowControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | BootstrapRowControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageContainer Functions
| addErrorMessage | BootstrapRowControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | BootstrapRowControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | BootstrapRowControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | BootstrapRowControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | BootstrapRowControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | BootstrapRowControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | BootstrapRowControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | BootstrapRowControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | BootstrapRowControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | BootstrapRowControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | BootstrapRowControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | BootstrapRowControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | BootstrapRowControl.getElementName( ) | Returns the element name |
| getElementType | BootstrapRowControl.getElementType( ) | Returns the element type |
A container representing a row within the bootstrap framework. Outside of this framework it functions as a simple div. Bootstrap Column Controls can be placed in this control.
Further documentation.