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