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