ButtonColumnControl
ButtonColumnControl Functions
| getButtonHtmlElementProperties | ButtonColumnControl.getButtonHtmlElementProperties( ) | Return the com.ebasetech.xi.api.controls.HtmlElementProperties for the Button Column Control |
| getButtonProperties | ButtonColumnControl.getButtonProperties( ) | Returns the ButtonColumnProperties object representing styling properties for the button on alternate rows. |
| getButtonWidth | ButtonColumnControl.getButtonWidth( ) | Column width. |
| setButtonWidth | ButtonColumnControl.setButtonWidth( buttonWidth ) | Sets the column width. |
| getHeaderText | ButtonColumnControl.getHeaderText( ) | Returns the com.ebasetech.xi.api.Text object for the column header text. |
| getStripedButtonProperties | ButtonColumnControl.getStripedButtonProperties( ) | Returns the ButtonColumnProperties object representing styling properties for the button on alternate rows. |
ButtonControlProperties Functions
| getButtonText | ButtonColumnControl.getButtonText( ) | Returns the com.ebasetech.xi.api.Text object for the button text. |
| isDisabled | ButtonColumnControl.isDisabled( ) | Returns true if the button is marked as disabled, otherwise returns false. |
| setDisabled | ButtonColumnControl.setDisabled( disabled ) | Disables the button and results in the HTML disabled attribute being added to the <button> HTML tag. |
| getMouseOverText | ButtonColumnControl.getMouseOverText( ) | Returns the com.ebasetech.xi.api.Text object for the mouse over text. |
| isSkipValidation | ButtonColumnControl.isSkipValidation( ) | Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the button's on click event. |
| setSkipValidation | ButtonColumnControl.setSkipValidation( skipValidation ) | Specifies whether or not validation of controls higher on the page is skipped prior to executing the button's on click event. |
ColumnStyleProperties Functions
| getColumnCellClass | ButtonColumnControl.getColumnCellClass( ) | Returns the list of CSS classes configured for each table cell. |
| setColumnCellClass | ButtonColumnControl.setColumnCellClass( columnCellClass ) | Sets one or more CSS classes to be applied to each table cell. |
| getColumnCellStyle | ButtonColumnControl.getColumnCellStyle( ) | Returns the inline CSS style configured for each table cell. |
| setColumnCellStyle | ButtonColumnControl.setColumnCellStyle( columnCellStyle ) | Sets the inline CSS style to be applied to each table cell. |
| getColumnDataClass | ButtonColumnControl.getColumnDataClass( ) | Returns the list of CSS classes configured for the content of each table cell. |
| setColumnDataClass | ButtonColumnControl.setColumnDataClass( columnDataClass ) | Sets one or more CSS classes to be applied to the content of each table cell. |
| getColumnDataStyle | ButtonColumnControl.getColumnDataStyle( ) | Returns the inline CSS style configured for the content of each table cell. |
| setColumnDataStyle | ButtonColumnControl.setColumnDataStyle( columnDataStyle ) | Sets the inline CSS style to be applied to the content of each table cell. |
| getColumnHeaderProperties | ButtonColumnControl.getColumnHeaderProperties( ) | Column header properties. |
| getStripeProperties | ButtonColumnControl.getStripeProperties( ) | Cell text, background, border and padding properties applied to alternate (striped) rows. |
Control Functions
| addCssClass | ButtonColumnControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | ButtonColumnControl.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 | ButtonColumnControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | ButtonColumnControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | ButtonColumnControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | ButtonColumnControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | ButtonColumnControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | ButtonColumnControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | ButtonColumnControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | ButtonColumnControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | ButtonColumnControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | ButtonColumnControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | ButtonColumnControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | ButtonColumnControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | ButtonColumnControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | ButtonColumnControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | ButtonColumnControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | ButtonColumnControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | ButtonColumnControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | ButtonColumnControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | ButtonColumnControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | ButtonColumnControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | ButtonColumnControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | ButtonColumnControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | ButtonColumnControl.isNewLine( ) | Returns the new line property. |
| setNewLine | ButtonColumnControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | ButtonColumnControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | ButtonColumnControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | ButtonColumnControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | ButtonColumnControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | ButtonColumnControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | ButtonColumnControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | ButtonColumnControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | ButtonColumnControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | ButtonColumnControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | ButtonColumnControl.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 | ButtonColumnControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | ButtonColumnControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | ButtonColumnControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | ButtonColumnControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | ButtonColumnControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | ButtonColumnControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageProperties Functions
| getErrorMessageStyle | ButtonColumnControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | ButtonColumnControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | ButtonColumnControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
BootstrapButtonStyle Functions
| getBootstrapSize | ButtonColumnControl.getBootstrapSize( ) | The current bootstrap size |
| setBootstrapSize | ButtonColumnControl.setBootstrapSize( alignment ) | Sets the bootstrap size. |
| getBootstrapState | ButtonColumnControl.getBootstrapState( ) | The current bootstrap state |
| setBootstrapState | ButtonColumnControl.setBootstrapState( alignment ) | Sets the bootstrap state. |
| getBootstrapStyle | ButtonColumnControl.getBootstrapStyle( ) | The current bootstrap style |
| setBootstrapStyle | ButtonColumnControl.setBootstrapStyle( alignment ) | Sets the bootstrap style. |
CellStyleProperties Functions
| getHAlign | ButtonColumnControl.getHAlign( ) | Horizontal alignment of table cell content. |
| setHAlign | ButtonColumnControl.setHAlign( hAlign ) | Sets the horizontal alignment of table cell content. |
| getVAlign | ButtonColumnControl.getVAlign( ) | Vertical alignment of table cell content. |
| setVAlign | ButtonColumnControl.setVAlign( vAlign ) | Sets the vertical alignment of table cell content. |
| getWidth | ButtonColumnControl.getWidth( ) | Width of the table column. |
| setWidth | ButtonColumnControl.setWidth( width ) | Sets the width of the table column. |
MarginStyleProperties Functions
| getAllMargin | ButtonColumnControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | ButtonColumnControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | ButtonColumnControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | ButtonColumnControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | ButtonColumnControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | ButtonColumnControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | ButtonColumnControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | ButtonColumnControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | ButtonColumnControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | ButtonColumnControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
BackgroundStyleProperties Functions
| getBackgroundColor | ButtonColumnControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | ButtonColumnControl.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 | ButtonColumnControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | ButtonColumnControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | ButtonColumnControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | ButtonColumnControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | ButtonColumnControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | ButtonColumnControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BorderStyleProperties Functions
| getBorderColor | ButtonColumnControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | ButtonColumnControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | ButtonColumnControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | ButtonColumnControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | ButtonColumnControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | ButtonColumnControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | ButtonColumnControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | ButtonColumnControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | ButtonColumnControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | ButtonColumnControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | ButtonColumnControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | ButtonColumnControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | ButtonColumnControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | ButtonColumnControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | ButtonColumnControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | ButtonColumnControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
PaddingStyleProperties Functions
| getAllPadding | ButtonColumnControl.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | ButtonColumnControl.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | ButtonColumnControl.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | ButtonColumnControl.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | ButtonColumnControl.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | ButtonColumnControl.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | ButtonColumnControl.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | ButtonColumnControl.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | ButtonColumnControl.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | ButtonColumnControl.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
TextStyleProperties Functions
| getLineHeight | ButtonColumnControl.getLineHeight( ) | Line height. |
| setLineHeight | ButtonColumnControl.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 | ButtonColumnControl.getTextBold( ) | Text bold setting. |
| setTextBold | ButtonColumnControl.setTextBold( textBold ) | Sets the text bold setting. |
| getTextColor | ButtonColumnControl.getTextColor( ) | Text color. |
| setTextColor | ButtonColumnControl.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 | ButtonColumnControl.getTextDecoration( ) | Text decoration property (shown as Lines in the designer). |
| setTextDecoration | ButtonColumnControl.setTextDecoration( textDecoration ) | Sets the text decoration property (shown as Lines in the designer). |
| getTextFont | ButtonColumnControl.getTextFont( ) | List of text fonts. |
| setTextFont | ButtonColumnControl.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 | ButtonColumnControl.getTextItalic( ) | Text italic setting. |
| setTextItalic | ButtonColumnControl.setTextItalic( textItalic ) | Sets the text italic setting. |
| getTextSize | ButtonColumnControl.getTextSize( ) | Text size. |
| setTextSize | ButtonColumnControl.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. |
MessageContainer Functions
| addErrorMessage | ButtonColumnControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | ButtonColumnControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | ButtonColumnControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | ButtonColumnControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | ButtonColumnControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | ButtonColumnControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | ButtonColumnControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | ButtonColumnControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | ButtonColumnControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | ButtonColumnControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | ButtonColumnControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | ButtonColumnControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | ButtonColumnControl.getElementName( ) | Returns the element name |
| getElementType | ButtonColumnControl.getElementType( ) | Returns the element type |