Package org.ametys.runtime.model

Class AbstractViewItemGroup

java.lang.Object

org.ametys.runtime.model.AbstractViewItemGroup

All Implemented Interfaces:

ViewItem, ViewItemAccessor, ViewItemContainer, ViewItemGroup, Labelable, ModifiableLabelable

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	Description
protected List<ViewItem>	_children	The view item group's children
protected I18nizableText	_description	The description of the view item group
protected I18nizableText	_label	The label of the view item group
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	Description
AbstractViewItemGroup()

Method Summary

Modifier and Type	Method	Description
void	addViewItem(ViewItem item)	Add a view item in the accessor
void	clear()	Removes all items of this accessor
void	copyTo(ViewItem item)	Copy the current view item in the given one.
boolean	equals(Object obj)
boolean	equals(Object obj, boolean checkDetails)	Indicates whether some other object is "equal to" this one.
I18nizableText	getDescription()	Retrieves the description.
I18nizableText	getLabel()	Retrieves the label.
String	getRole()	Retrieves the role.
List<ViewItem>	getViewItems()	Retrieves all the view items of this accessor
int	hashCode()
void	insertViewItem(ViewItem item, int index)	Insert a view item in the accessor at the given index
boolean	removeViewItem(ViewItem item)	Removes the given items of this accessor
void	setDescription(I18nizableText description)	Set the description.
void	setLabel(I18nizableText label)	Set the label.
void	setRole(String role)	Set the role.

Methods inherited from class java.lang.Object

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

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

getName

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

setName

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

createInstance, getParent, setParent, toJSON, toSAX

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

addViewItems, getModelViewItem, getViewItem, hasModelViewItem, hasModelViewItem, hasModelViewItem

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

copyTo

Field Details

_role

protected String _role

The role of the view item group

_label

protected I18nizableText _label

The label of the view item group

_description

protected I18nizableText _description

The description of the view item group

_children

protected List<ViewItem> _children

The view item group's children

Constructor Details

AbstractViewItemGroup

public AbstractViewItemGroup()

Method Details

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Returns:

the label.

setLabel

public void setLabel(I18nizableText label)

Description copied from interface: ModifiableLabelable

Set the label.

Specified by:

setLabel in interface ModifiableLabelable

Parameters:

label - the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Returns:

the description.

setDescription

public void setDescription(I18nizableText description)

Description copied from interface: ModifiableLabelable

Set the description.

Specified by:

setDescription in interface ModifiableLabelable

Parameters:

description - the description.

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

Retrieves all the view items of this accessor

Specified by:

getViewItems in interface ViewItemAccessor

Returns:

the view items

addViewItem

public void addViewItem(ViewItem item)

Description copied from interface: ViewItemAccessor

Add a view item in the accessor

Specified by:

addViewItem in interface ViewItemAccessor

Parameters:

item - the item to add

insertViewItem

public void insertViewItem(ViewItem item,
 int index)

Description copied from interface: ViewItemAccessor

Insert a view item in the accessor at the given index

Specified by:

insertViewItem in interface ViewItemAccessor

Parameters:

item - the item to insert

index - index at which the item has to be inserted

removeViewItem

public boolean removeViewItem(ViewItem item)

Description copied from interface: ViewItemAccessor

Removes the given items of this accessor

Specified by:

removeViewItem in interface ViewItemAccessor

Parameters:

item - the item to remove

Returns:

true if this accessor contained the given item, false otherwise

clear

public void clear()

Description copied from interface: ViewItemAccessor

Removes all items of this accessor

Specified by:

clear in interface ViewItemAccessor

copyTo

public void copyTo(ViewItem item)

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 not copied

Specified by:

copyTo in interface ViewItem

Parameters:

item - the copy

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public boolean equals(Object obj,
 boolean checkDetails)

Description copied from interface: ViewItem

Indicates whether some other object is "equal to" this one.

Specified by:

equals in interface ViewItem

Parameters:

obj - the reference object with which to compare.

checkDetails - true to check the view item's details during comparison (label, description, ...)

Returns:

true if this object is the same as the given obj, false otherwise.