org.ametys.runtime.model

Class AbstractViewItemGroup

java.lang.Object

org.ametys.runtime.model.AbstractViewItemGroup

All Implemented Interfaces:

ViewItem, ViewItemContainer, ViewItemGroup

Direct Known Subclasses:

ModelViewItemGroup, SimpleViewItemGroup

public abstract class AbstractViewItemGroup
extends Object
implements ViewItemGroup

Abstract class for group of view items

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ViewItem>	_children The view item group's children
protected String	_role The role of the view item group

Fields inherited from interface org.ametys.runtime.model.ViewItemGroup

FIELDSET_ROLE, TAB_ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractViewItemGroup()

Method Summary

Modifier and Type	Method and Description
void	addViewItem(ViewItem item) Add a view item in the container
String	getRole() Retrieves the role.
List<ViewItem>	getViewItems() Retrieves all the view items of this container
boolean	hasViewItem(String itemName) Checks if there is a view item with the given name
void	insertViewItem(ViewItem item, int index) Insert a view item in the container at the given index
void	setRole(String role) Set the role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.runtime.model.ViewItem

getName, toJSON

Field Detail

_role

protected String _role

The role of the view item group

_children

protected List<ViewItem> _children

The view item group's children

Constructor Detail

AbstractViewItemGroup

public AbstractViewItemGroup()

Method Detail

getRole

public String getRole()

Description copied from interface: ViewItemGroup

Retrieves the role.

Specified by:

getRole in interface ViewItemGroup

Returns:

the role.

setRole

public void setRole(String role)

Description copied from interface: ViewItemGroup

Set the role.

Specified by:

setRole in interface ViewItemGroup

Parameters:

role - the role.

getViewItems

public List<ViewItem> getViewItems()

Description copied from interface: ViewItemContainer

Retrieves all the view items of this container

Specified by:

getViewItems in interface ViewItemContainer

Returns:

the view items

hasViewItem

public boolean hasViewItem(String itemName)

Description copied from interface: ViewItemContainer

Checks if there is a view item with the given name

Specified by:

hasViewItem in interface ViewItemContainer

Parameters:

itemName - the name of the item

Returns:

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

addViewItem

public void addViewItem(ViewItem item)

Description copied from interface: ViewItemContainer

Add a view item in the container

Specified by:

addViewItem in interface ViewItemContainer

Parameters:

item - the item to add

insertViewItem

public void insertViewItem(ViewItem item,
                           int index)

Description copied from interface: ViewItemContainer

Insert a view item in the container at the given index

Specified by:

insertViewItem in interface ViewItemContainer

Parameters:

item - the item to insert

index - index at which the item has to be inserted