Package org.ametys.runtime.model

Class ModelViewItemGroup

java.lang.Object

org.ametys.runtime.model.AbstractViewItemGroup

org.ametys.runtime.model.ModelViewItemGroup

All Implemented Interfaces:

ModelViewItem<ModelItemGroup>, ViewItem, ViewItemAccessor, ViewItemContainer, ViewItemGroup, Labelable, ModifiableLabelable

public class ModelViewItemGroup
extends AbstractViewItemGroup
implements ModelViewItem<ModelItemGroup>

View reference to a group of model items

Field Summary

Fields inherited from class org.ametys.runtime.model.AbstractViewItemGroup

_children, _description, _label, _role

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

FIELDSET_ROLE, TAB_ROLE

Constructor Summary

Constructors

Constructor	Description
ModelViewItemGroup()

Method Summary

Modifier and Type	Method	Description
void	copyTo(ViewItem item)	Copy the current view item in the given one.
ModelViewItemGroup	createInstance()	Create an instance of ViewItem
boolean	equals(Object obj)
ModelItemGroup	getDefinition()	Retrieves the referenced model item definition
I18nizableText	getDescription()	Retrieves the description.
I18nizableText	getLabel()	Retrieves the label.
String	getName()	Get the name.
int	hashCode()
static ModelViewItemGroup	of(ModelItemGroup modelItem)	Creates a ModelViewItemGroup with the items of the given ModelItemGroup
static ModelViewItemGroup	of(ModelItemGroup modelItem, String... itemPaths)	Creates a ModelViewItemGroup with the given items
void	setDefinition(ModelItemGroup definition)	Sets the referenced model item definition
Map<String,Object>	toJSON(DefinitionContext context)	Converts the view item in a JSON map
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the view item
String	toString()

Methods inherited from class org.ametys.runtime.model.AbstractViewItemGroup

addViewItem, clear, equals, getRole, getViewItems, insertViewItem, removeViewItem, setDescription, setLabel, setRole

Methods inherited from class java.lang.Object

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

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

setName

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

setDescription, setLabel

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

equals

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

addViewItems, getModelViewItem, hasModelViewItem, hasModelViewItem, hasModelViewItem

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

copyTo

Constructor Detail

ModelViewItemGroup

public ModelViewItemGroup()

Method Detail

of

public static ModelViewItemGroup of(ModelItemGroup modelItem)
                             throws IllegalArgumentException

Creates a ModelViewItemGroup with the items of the given ModelItemGroup

Parameters:

modelItem - the model item group

Returns:

the created ModelViewItemGroup

Throws:

IllegalArgumentException - if the model item is null

of

public static ModelViewItemGroup of(ModelItemGroup modelItem,
                                    String... itemPaths)
                             throws IllegalArgumentException,
                                    BadItemTypeException

Creates a ModelViewItemGroup with the given items

Parameters:

modelItem - the model item containing items definitions

itemPaths - the paths of the items to put in the view item

Returns:

the created ModelViewItemGroup

Throws:

IllegalArgumentException - if the model item is null or if an item path is null, empty, or is not defined in the given model items

BadItemTypeException - if a segment in a path (but not the last) does not represent a group item

getDefinition

public ModelItemGroup getDefinition()

Description copied from interface: ModelViewItem

Retrieves the referenced model item definition

Specified by:

getDefinition in interface ModelViewItem<ModelItemGroup>

Returns:

the referenced definition

setDefinition

public void setDefinition(ModelItemGroup definition)

Description copied from interface: ModelViewItem

Sets the referenced model item definition

Specified by:

setDefinition in interface ModelViewItem<ModelItemGroup>

Parameters:

definition - the referenced definition

getName

public String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Returns:

the name.

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Overrides:

getLabel in class AbstractViewItemGroup

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Overrides:

getDescription in class AbstractViewItemGroup

Returns:

the description.

toJSON

public Map<String,Object> toJSON(DefinitionContext context)
                                throws ProcessingException

Description copied from interface: ViewItem

Converts the view item in a JSON map

Specified by:

toJSON in interface ViewItem

Parameters:

context - the context of the definitions referenced in this view item and/or its children

Returns:

The view item as a JSON map

Throws:

ProcessingException - If an error occurs when converting the view item

toSAX

public void toSAX(ContentHandler contentHandler,
                  DefinitionContext context)
           throws SAXException

Description copied from interface: ViewItem

Generates SAX events for the view item

Specified by:

toSAX in interface ViewItem

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - the context of the definitions included in the view item

Throws:

SAXException - if an error occurs during the SAX events generation

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

Overrides:

copyTo in class AbstractViewItemGroup

Parameters:

item - the copy

createInstance

public ModelViewItemGroup createInstance()

Description copied from interface: ViewItem

Create an instance of ViewItem

Specified by:

createInstance in interface ViewItem

Returns:

the created instance

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractViewItemGroup

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractViewItemGroup

toString

public String toString()

Overrides:

toString in class Object