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