EbaseButtonControlProperties
EbaseButtonControlProperties is one these types:
EbaseButtonControlPropertiesFinishButtonControl
NextPageButtonControl
PrevPageButtonControl
RestoreButtonControl
SaveButtonControl
EbaseButtonControlProperties Functions
| isDisplayAsImage | EbaseButtonControlProperties.isDisplayAsImage( ) | Indicates whether or not the button is displayed as an image. |
| setDisplayAsImage | EbaseButtonControlProperties.setDisplayAsImage( displayAsImage ) | Sets whether or not the button is displayed as an image. |
| getImageUrl | EbaseButtonControlProperties.getImageUrl( ) | Returns the URL of the image when property #isDisplayAsImage() is true. |
| setImageUrl | EbaseButtonControlProperties.setImageUrl( imageUrl ) | Sets the URL of the image when property #isDisplayAsImage() is true. |
BackgroundStyleProperties Functions
| getBackgroundColor | EbaseButtonControlProperties.getBackgroundColor( ) | Background color. |
| setBackgroundColor | EbaseButtonControlProperties.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 | EbaseButtonControlProperties.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | EbaseButtonControlProperties.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | EbaseButtonControlProperties.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | EbaseButtonControlProperties.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | EbaseButtonControlProperties.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | EbaseButtonControlProperties.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BorderStyleProperties Functions
| getBorderColor | EbaseButtonControlProperties.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | EbaseButtonControlProperties.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | EbaseButtonControlProperties.getBorderRadius( ) | Border radius. |
| setBorderRadius | EbaseButtonControlProperties.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | EbaseButtonControlProperties.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | EbaseButtonControlProperties.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | EbaseButtonControlProperties.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | EbaseButtonControlProperties.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | EbaseButtonControlProperties.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | EbaseButtonControlProperties.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | EbaseButtonControlProperties.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | EbaseButtonControlProperties.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | EbaseButtonControlProperties.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | EbaseButtonControlProperties.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | EbaseButtonControlProperties.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | EbaseButtonControlProperties.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
Control Functions
| addCssClass | EbaseButtonControlProperties.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | EbaseButtonControlProperties.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 | EbaseButtonControlProperties.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | EbaseButtonControlProperties.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | EbaseButtonControlProperties.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | EbaseButtonControlProperties.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | EbaseButtonControlProperties.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | EbaseButtonControlProperties.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | EbaseButtonControlProperties.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | EbaseButtonControlProperties.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | EbaseButtonControlProperties.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | EbaseButtonControlProperties.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | EbaseButtonControlProperties.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | EbaseButtonControlProperties.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | EbaseButtonControlProperties.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | EbaseButtonControlProperties.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | EbaseButtonControlProperties.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | EbaseButtonControlProperties.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | EbaseButtonControlProperties.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | EbaseButtonControlProperties.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | EbaseButtonControlProperties.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | EbaseButtonControlProperties.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | EbaseButtonControlProperties.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | EbaseButtonControlProperties.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | EbaseButtonControlProperties.isNewLine( ) | Returns the new line property. |
| setNewLine | EbaseButtonControlProperties.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | EbaseButtonControlProperties.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | EbaseButtonControlProperties.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | EbaseButtonControlProperties.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | EbaseButtonControlProperties.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | EbaseButtonControlProperties.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | EbaseButtonControlProperties.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | EbaseButtonControlProperties.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | EbaseButtonControlProperties.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | EbaseButtonControlProperties.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | EbaseButtonControlProperties.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 | EbaseButtonControlProperties.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | EbaseButtonControlProperties.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | EbaseButtonControlProperties.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | EbaseButtonControlProperties.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | EbaseButtonControlProperties.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | EbaseButtonControlProperties.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MarginStyleProperties Functions
| getAllMargin | EbaseButtonControlProperties.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | EbaseButtonControlProperties.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | EbaseButtonControlProperties.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | EbaseButtonControlProperties.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | EbaseButtonControlProperties.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | EbaseButtonControlProperties.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | EbaseButtonControlProperties.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | EbaseButtonControlProperties.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | EbaseButtonControlProperties.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | EbaseButtonControlProperties.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
PaddingStyleProperties Functions
| getAllPadding | EbaseButtonControlProperties.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | EbaseButtonControlProperties.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | EbaseButtonControlProperties.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | EbaseButtonControlProperties.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | EbaseButtonControlProperties.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | EbaseButtonControlProperties.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | EbaseButtonControlProperties.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | EbaseButtonControlProperties.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | EbaseButtonControlProperties.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | EbaseButtonControlProperties.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
TextStyleProperties Functions
| getLineHeight | EbaseButtonControlProperties.getLineHeight( ) | Line height. |
| setLineHeight | EbaseButtonControlProperties.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 | EbaseButtonControlProperties.getTextBold( ) | Text bold setting. |
| setTextBold | EbaseButtonControlProperties.setTextBold( textBold ) | Sets the text bold setting. |
| getTextColor | EbaseButtonControlProperties.getTextColor( ) | Text color. |
| setTextColor | EbaseButtonControlProperties.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 | EbaseButtonControlProperties.getTextDecoration( ) | Text decoration property (shown as Lines in the designer). |
| setTextDecoration | EbaseButtonControlProperties.setTextDecoration( textDecoration ) | Sets the text decoration property (shown as Lines in the designer). |
| getTextFont | EbaseButtonControlProperties.getTextFont( ) | List of text fonts. |
| setTextFont | EbaseButtonControlProperties.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 | EbaseButtonControlProperties.getTextItalic( ) | Text italic setting. |
| setTextItalic | EbaseButtonControlProperties.setTextItalic( textItalic ) | Sets the text italic setting. |
| getTextSize | EbaseButtonControlProperties.getTextSize( ) | Text size. |
| setTextSize | EbaseButtonControlProperties.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 | EbaseButtonControlProperties.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | EbaseButtonControlProperties.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | EbaseButtonControlProperties.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | EbaseButtonControlProperties.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | EbaseButtonControlProperties.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | EbaseButtonControlProperties.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | EbaseButtonControlProperties.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | EbaseButtonControlProperties.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | EbaseButtonControlProperties.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | EbaseButtonControlProperties.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | EbaseButtonControlProperties.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | EbaseButtonControlProperties.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | EbaseButtonControlProperties.getElementName( ) | Returns the element name |
| getElementType | EbaseButtonControlProperties.getElementType( ) | Returns the element type |
EbaseButtonControlPropertiesinterface represents common properties for all Ebase navigation buttons.Further documentation.