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