Package org.ametys.runtime.model

Interface ViewItemContainer

All Known Subinterfaces:

ViewItemGroup

All Known Implementing Classes:

AbstractViewItemGroup, CompareView, CompareView.AbstractCompareViewItemGroup, CompareView.CompareModelViewItemGroup, CompareView.CompareSimpleViewItemGroup, ModelViewItemGroup, SimpleViewItemGroup, View

public interface ViewItemContainer

Interface for view item containers

Method Summary

Modifier and Type	Method	Description
void	addViewItem(ViewItem item)	Add a view item in the container
default ModelViewItem	getModelViewItem(String itemName)	Retrieves the model view item with the given name Usually, a container can't have more than one references to the same model item.
List<ViewItem>	getViewItems()	Retrieves all the view items of this container
default boolean	hasModelViewItem(String itemName)	Checks if there is a model view item with the given name Usually, a container can't have more than one references to the same model item.
void	insertViewItem(ViewItem item, int index)	Insert a view item in the container at the given index

Method Detail

getViewItems

List<ViewItem> getViewItems()

Retrieves all the view items of this container

Returns:

the view items

addViewItem

void addViewItem(ViewItem item)

Add a view item in the container

Parameters:

item - the item to add

insertViewItem

void insertViewItem(ViewItem item,
                    int index)

Insert a view item in the container at the given index

Parameters:

item - the item to insert

index - index at which the item has to be inserted

hasModelViewItem

default boolean hasModelViewItem(String itemName)

Checks if there is a model view item with the given name Usually, a container can't have more than one references to the same model item. But it can have view items with the same name if they are not references to the model (model view items).

Parameters:

itemName - the name of the item

Returns:

true if the container contains an item with the given name, false otherwise

getModelViewItem

default ModelViewItem getModelViewItem(String itemName)

Retrieves the model view item with the given name Usually, a container can't have more than one references to the same model item. But it can have view items with the same name if they are not references to the model (model view items).

Parameters:

itemName - the name of the item

Returns:

the model view item, or null if none was found