position – sets the position for the drop-down list. The attribute can take two values: TOP, BOTTOM. Default is TOP.

inline attribute defines how the list with selected items will be displayed: vertically or horizontally. true corresponds to horizontal alignment, false – to vertical. An example of a component with horizontal alignment:

simple – when set to true, the items selection component will be hidden with only the Add button left. Clicking the Add button opens the screen with the list of entity instances which type is defined by the data container. Selection screen identifier is selected according to the rules for the PickerField standard lookup action. Clicking the Clear button will remove all elements from the TokenList component’s container.

clearEnabled - when set to false, the Clear button is hidden.

lookup − values selection component descriptor.

addButton – descriptor of the button for adding items. Can contain caption and icon attributes.

setOptionsList() enables specifying programmatically a list of entities to be used as component options. To do this, declare a component in the XML descriptor:

<tokenList id="tokenList"
           dataContainer="orderDc"
           property="items"
           width="320px">
    <lookup/>
</tokenList>

@Inject
private TokenList<OrderItem> tokenList;
@Inject
private CollectionContainer<OrderItem> allItemsDc;

@Subscribe
public void onAfterShow(AfterShowEvent event) {
    tokenList.setOptionsList(allItemsDc.getItems());
}

@Inject
private TokenList<OrderItem> tokenList;
@Inject
private CollectionContainer<OrderItem> allItemsDc;

@Subscribe
public void onAfterShow(AfterShowEvent event) {
    tokenList.setOptions(new ContainerOptions<>(allItemsDc));
}

Declaratively using the @Install annotation in the screen controller:

@Inject
private CollectionContainer<Tag> tagsDc;
@Inject
private Metadata metadata;

@Install(to = "tokenList", subject = "newOptionHandler")
private void tokenListNewOptionHandler(String string) {
    Tag newTag = metadata.create(Tag.class);
    newTag.setName(string);
    tagsDc.getMutableItems().add(newTag);
}

Programmatically with the help of the setNewOptionHandler() method:

@Inject
private CollectionContainer<Tag> tagsDc;
@Inject
private Metadata metadata;
@Inject
private TokenList<Tag> tokenList;

@Subscribe
public void onInit(InitEvent event) {
    tokenList.setNewOptionHandler(string -> {
        Tag newTag = metadata.create(Tag.class);
        newTag.setName(string);
        tagsDc.getMutableItems().add(newTag);
    });
}

ItemClickListener allows you to track the click on tokenList items.

ValueChangeListener enables tracking the changes of the tokenList value, as well as of any other components implementing the Field interface. The origin of the ValueChangeEvent can be tracked using isUserOriginated() method.