Package com.ebasetech.xi.api.controls
Interface ListControl
- All Superinterfaces:
AriaControlProperties
,BackgroundStyleProperties
,BasicBlockControl
,BorderStyleProperties
,ContainerControl
,Control
,Element
,EventOwner
,LayoutControl
,ListPanelControl
,MarginStyleProperties
,MessageContainer
,MessageProperties
,PaddingStyleProperties
,java.io.Serializable
,TextStyleProperties
,WebFormEventOwner
public interface ListControl extends ListPanelControl
List Control
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
Repeating List Text Control
or a Repeating List Hyperlink Control
to the single child list item.
<ul> <li> list item text 1 </li> <li> list item text 2 </li> </ul>Further documentation.
-
Method Summary
Modifier and Type Method Description CustomList
createCustomList()
Creates and returns an empty list and associates the list with this repeating list control.CustomList
createCustomList(java.lang.String[] entries)
Creates a list for this control and adds the passed entries.FieldList
getList()
Returns the list associated with this control or null if no list exists.Methods inherited from interface com.ebasetech.xi.api.controls.AriaControlProperties
addAriaCustomAttribute, getAriaCustomAttributes, getAriaDescribedBy, getAriaLabelledBy, getAriaLabelText, getAriaRole, removeAriaCustomAttribute, setAriaCustomAttributes, setAriaRole
Methods inherited from interface com.ebasetech.xi.api.controls.BackgroundStyleProperties
getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeat
Methods inherited from interface com.ebasetech.xi.api.controls.BasicBlockControl
getHeight, getWidth, setHeight, setWidth
Methods inherited from interface com.ebasetech.xi.api.controls.BorderStyleProperties
getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth
Methods inherited from interface com.ebasetech.xi.api.controls.ContainerControl
getChildControls
Methods inherited from interface com.ebasetech.xi.api.controls.Control
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getRootHtmlElementProperties, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show
Methods inherited from interface com.ebasetech.xi.api.Element
getElementName, getElementType
Methods inherited from interface com.ebasetech.xi.api.controls.LayoutControl
getLayout, getLayoutType
Methods inherited from interface com.ebasetech.xi.api.controls.ListPanelControl
getContainingListType, getListStyleImage, getListStylePosition, getListStyleType, setContainingListType, setListStyleImage, setListStylePosition, setListStyleType
Methods inherited from interface com.ebasetech.xi.api.controls.MarginStyleProperties
getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin
Methods inherited from interface com.ebasetech.xi.api.MessageContainer
addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages
Methods inherited from interface com.ebasetech.xi.api.controls.MessageProperties
getErrorMessageStyle, getInfoMessageStyle, getWarningMessageStyle
Methods inherited from interface com.ebasetech.xi.api.controls.PaddingStyleProperties
getAllPadding, getBottomPadding, getLeftPadding, getRightPadding, getTopPadding, setAllPadding, setBottomPadding, setLeftPadding, setRightPadding, setTopPadding
Methods inherited from interface com.ebasetech.xi.api.controls.TextStyleProperties
getLineHeight, getTextBold, getTextColor, getTextDecoration, getTextFont, getTextItalic, getTextSize, setLineHeight, setTextBold, setTextColor, setTextDecoration, setTextFont, setTextItalic, setTextSize
-
Method Details
-
getList
FieldList getList()Returns the list associated with this control or null if no list exists. The list can be one of three types:Dynamic List
- values are retrieved from a databaseStatic List
- supports multiple languages, values are defined using the Ebase Xi DesignerCustom List
- the list is created programmatically using thecreateCustomList()
method
- Returns:
- the list associated with this control, if any
- Since:
- V5.3
-
createCustomList
CustomList createCustomList()Creates and returns an empty list and associates the list with this repeating list control. List entries can then be added to the list.Javascript example:
var list = controls.List1.createCustomList(); list.add("Item 1"); list.add("Item 2"); list.add("Item 3");
- Returns:
- an empty custom list connected to the repeating list control
- Since:
- V5.3
-
createCustomList
Creates a list for this control and adds the passed entries. The created custom list object is returned.Javascript example:
var list = controls.List1.createCustomList(["Item 1", "Item 2", "Item 3"]);
- Returns:
- custom list
- Since:
- V5.3
-