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 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:
      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

      CustomList createCustomList​(java.lang.String[] entries)
      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