Package org.ametys.runtime.model

Interface ViewItemGroup

All Superinterfaces:

Labelable, ModifiableLabelable, ViewItem, ViewItemAccessor, ViewItemContainer

All Known Implementing Classes:

AbstractViewItemGroup, ModelViewItemGroup, SimpleViewItemGroup

public interface ViewItemGroup
extends ViewItem, ViewItemContainer

interface for group of view items

Field Summary

Fields

Modifier and Type	Field	Description
static String	FIELDSET_ROLE	Role for fieldset view items
static String	TAB_ROLE	Role for tab view items

Method Summary

Modifier and Type	Method	Description
default void	copyTo(ViewItem item, View referenceView, String itemPath)	Copy the current view item in the given one.
String	getRole()	Retrieves the role.
void	setRole(String role)	Set the role.

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

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

copyTo, createInstance, equals, toJSON, toSAX

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

addViewItem, addViewItems, clear, getModelViewItem, getViewItems, hasModelViewItem, hasModelViewItem, hasModelViewItem, insertViewItem, removeViewItem

Field Detail

TAB_ROLE

static final String TAB_ROLE

Role for tab view items

See Also:

Constant Field Values

FIELDSET_ROLE

static final String FIELDSET_ROLE

Role for fieldset view items

See Also:

Constant Field Values

Method Detail

getRole

String getRole()

Retrieves the role.

Returns:

the role.

setRole

void setRole(String role)

Set the role.

Parameters:

role - the role.

copyTo

default void copyTo(ViewItem item,
                    View referenceView,
                    String itemPath)

Description copied from interface: ViewItem

Copy the current view item in the given one. If the view item is an accessor, its view items are copied only if they are not already present in the reference view

Specified by:

copyTo in interface ViewItem

Parameters:

item - the copy

referenceView - the reference view

itemPath - the path of the view item in the reference view