CategorizedElementDefinitionProxy (Ametys 4.2.x

java.lang.Object
- org.ametys.runtime.model.AbstractModelItem
- - org.ametys.runtime.model.ElementDefinition<T>
  - - org.ametys.runtime.model.CategorizedElementDefinitionProxy<T>

Type Parameters:

T - Type of the element value

All Implemented Interfaces:

Comparable<ModelItem>, ModelItem, Labelable, ModifiableLabelable

Direct Known Subclasses:

SiteParameter
```
public class CategorizedElementDefinitionProxy<T>
extends ElementDefinition<T>
```
Object containing the definition of an element and informations about its categories / groups

Field Summary

Fields
Modifier and Type	Field and Description
`private ElementDefinition<T>`	`_definition`
`private I18nizableText`	`_displayCategory`
`private I18nizableText`	`_displayGroup`
`private boolean`	`_isGroupSwitch`
`private long`	`_position`

Fields inherited from interface org.ametys.runtime.model.ModelItem
ITEM_PATH_SEPARATOR

Constructor Summary

Constructors
Constructor and Description

CategorizedElementDefinitionProxy()
Default constructor

Constructors
Constructor and Description
`CategorizedElementDefinitionProxy()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addItemChecker(ItemCheckerDescriptor itemChecker)` Add an item checker to the group
`int`	`compareTo(ModelItem item)`
`boolean`	`equals(Object obj)`
`T`	`getDefaultValue()` Retrieves the default value.
`ElementDefinition<T>`	`getDefinition()` Retrieves the element definition
`I18nizableText`	`getDescription()` Retrieves the description.
`DisableConditions`	`getDisableConditions()` Retrieves the disable condition.
`I18nizableText`	`getDisplayCategory()` Retrieves the category in which to display the element
`I18nizableText`	`getDisplayGroup()` Retrieves the group in which to display the element
`Enumerator<T>`	`getEnumerator()` Retrieves the enumerator.
`Set<ItemCheckerDescriptor>`	`getItemCheckers()` Returns the `ItemCheckerDescriptor`s associated with this group.
`I18nizableText`	`getLabel()` Retrieves the label.
`Model`	`getModel()` Retrieves the model of the item
`String`	`getName()` Get the name.
`ModelItemGroup`	`getParent()` Retrieves the parent of the item
`String`	`getPath()` Retrieves the path of the model item
`String`	`getPluginName()` Retrieves the name of the plugin declaring this element.
`long`	`getPosition()` Retrieves the position in the group where the element has to be displayed
`ElementType<T>`	`getType()` Retrieves the type.
`Validator`	`getValidator()` Retrieves the validator.
`String`	`getWidget()` Retrieves the widget to use for rendering.
`Map<String,I18nizableText>`	`getWidgetParameters()` Get the widget's parameters
`int`	`hashCode()`
`boolean`	`isGroupSwitch()` Retrieves true if this definition is the group switch
`boolean`	`isMultiple()` Test if the element is multiple.
`void`	`setDefaultValue(T defaultValue)` Set the default value.
`void`	`setDescription(I18nizableText description)` Set the description.
`void`	`setDisableConditions(DisableConditions disableConditions)` Sets the disable condition.
`void`	`setDisplayCategory(I18nizableText displayCategory)` Sets the category in which to display the element
`void`	`setDisplayGroup(I18nizableText displayGroup)` Sets the group in which to display the element
`void`	`setEnumerator(Enumerator<T> enumerator)` Set the enumerator.
`void`	`setGroupSwitch(boolean isGroupSwitch)` Sets the group switch
`void`	`setLabel(I18nizableText label)` Set the label.
`void`	`setModel(Model model)` Sets the model of the element
`void`	`setMultiple(boolean isMultiple)` Set the element multiple status.
`void`	`setName(String name)` Set the name.
`void`	`setParent(ModelItemGroup parent)` Sets the parent of the item
`void`	`setPluginName(String pluginName)` Set the name of the plugin declaring this element.
`void`	`setPosition(long position)` Sets the position of the element in the group
`void`	`setType(ModelItemType type)` Set the type.
`void`	`setValidator(Validator validator)` Set the validator.
`void`	`setWidget(String widget)` Set the widget.
`void`	`setWidgetParameters(Map<String,I18nizableText> params)` Set the widget's parameters
`Map<String,Object>`	`toJSON()` Converts the model item in a JSON map
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - _definition
```
private ElementDefinition<T> _definition
```
  - _displayCategory
```
private I18nizableText _displayCategory
```
  - _displayGroup
```
private I18nizableText _displayGroup
```
  - _position
```
private long _position
```
  - _isGroupSwitch
```
private boolean _isGroupSwitch
```
- Constructor Detail
  - CategorizedElementDefinitionProxy
```
public CategorizedElementDefinitionProxy()
```
    Default constructor
- Method Detail
  - getDefinition
```
public ElementDefinition<T> getDefinition()
```
    Retrieves the element definition
    
    Returns:
    
    the element definition
  - getDisplayCategory
```
public I18nizableText getDisplayCategory()
```
    Retrieves the category in which to display the element
    
    Returns:
    
    the category
  - setDisplayCategory
```
public void setDisplayCategory(I18nizableText displayCategory)
```
    Sets the category in which to display the element
    
    Parameters:
    
    displayCategory - the category to set
  - getDisplayGroup
```
public I18nizableText getDisplayGroup()
```
    Retrieves the group in which to display the element
    
    Returns:
    
    the group
  - setDisplayGroup
```
public void setDisplayGroup(I18nizableText displayGroup)
```
    Sets the group in which to display the element
    
    Parameters:
    
    displayGroup - the group to set
  - getPosition
```
public long getPosition()
```
    Retrieves the position in the group where the element has to be displayed
    
    Returns:
    
    the position in the group
  - setPosition
```
public void setPosition(long position)
```
    Sets the position of the element in the group
    
    Parameters:
    
    position - the position to set
  - isGroupSwitch
```
public boolean isGroupSwitch()
```
    Retrieves true if this definition is the group switch
    
    Returns:
    
    true if this definition is the group switch, false otherwise
  - setGroupSwitch
```
public void setGroupSwitch(boolean isGroupSwitch)
```
    Sets the group switch
    
    Parameters:
    
    isGroupSwitch - true if this definition is the group switch
  - getPluginName
```
public String getPluginName()
```
    Description copied from class: ElementDefinition
    
    Retrieves the name of the plugin declaring this element.
    
    Overrides:
    
    getPluginName in class ElementDefinition<T>
    
    Returns:
    
    the plugin name.
  - setPluginName
```
public void setPluginName(String pluginName)
```
    Description copied from class: ElementDefinition
    
    Set the name of the plugin declaring this element.
    
    Overrides:
    
    setPluginName in class ElementDefinition<T>
    
    Parameters:
    
    pluginName - the plugin name.
  - getType
```
public ElementType<T> getType()
```
    Description copied from interface: ModelItem
    
    Retrieves the type.
    
    Specified by:
    
    getType in interface ModelItem
    
    Overrides:
    
    getType in class ElementDefinition<T>
    
    Returns:
    
    the type.
  - setType
```
public void setType(ModelItemType type)
```
    Description copied from interface: ModelItem
    
    Set the type.
    
    Specified by:
    
    setType in interface ModelItem
    
    Overrides:
    
    setType in class ElementDefinition<T>
    
    Parameters:
    
    type - the type.
  - getWidget
```
public String getWidget()
```
    Description copied from class: ElementDefinition
    
    Retrieves the widget to use for rendering.
    
    Overrides:
    
    getWidget in class ElementDefinition<T>
    
    Returns:
    
    the widget or null if none is defined.
  - setWidget
```
public void setWidget(String widget)
```
    Description copied from class: ElementDefinition
    
    Set the widget.
    
    Overrides:
    
    setWidget in class ElementDefinition<T>
    
    Parameters:
    
    widget - the widget.
  - getWidgetParameters
```
public Map<String,I18nizableText> getWidgetParameters()
```
    Description copied from class: ElementDefinition
    
    Get the widget's parameters
    
    Overrides:
    
    getWidgetParameters in class ElementDefinition<T>
    
    Returns:
    
    the widget's parameters
  - setWidgetParameters
```
public void setWidgetParameters(Map<String,I18nizableText> params)
```
    Description copied from class: ElementDefinition
    
    Set the widget's parameters
    
    Overrides:
    
    setWidgetParameters in class ElementDefinition<T>
    
    Parameters:
    
    params - the parameters to set
  - getEnumerator
```
public Enumerator<T> getEnumerator()
```
    Description copied from class: ElementDefinition
    
    Retrieves the enumerator.
    
    Overrides:
    
    getEnumerator in class ElementDefinition<T>
    
    Returns:
    
    the enumerator or null if none is defined.
  - setEnumerator
```
public void setEnumerator(Enumerator<T> enumerator)
```
    Description copied from class: ElementDefinition
    
    Set the enumerator.
    
    Overrides:
    
    setEnumerator in class ElementDefinition<T>
    
    Parameters:
    
    enumerator - the enumerator.
  - getValidator
```
public Validator getValidator()
```
    Description copied from class: ElementDefinition
    
    Retrieves the validator.
    
    Overrides:
    
    getValidator in class ElementDefinition<T>
    
    Returns:
    
    the validator or null if none is defined.
  - setValidator
```
public void setValidator(Validator validator)
```
    Description copied from class: ElementDefinition
    
    Set the validator.
    
    Overrides:
    
    setValidator in class ElementDefinition<T>
    
    Parameters:
    
    validator - the validator.
  - getDefaultValue
```
public T getDefaultValue()
```
    Description copied from class: ElementDefinition
    
    Retrieves the default value.
    
    Overrides:
    
    getDefaultValue in class ElementDefinition<T>
    
    Returns:
    
    the default value or null if none is defined.
  - setDefaultValue
```
public void setDefaultValue(T defaultValue)
```
    Description copied from class: ElementDefinition
    
    Set the default value.
    
    Overrides:
    
    setDefaultValue in class ElementDefinition<T>
    
    Parameters:
    
    defaultValue - the default value.
  - isMultiple
```
public boolean isMultiple()
```
    Description copied from class: ElementDefinition
    
    Test if the element is multiple.
    
    Overrides:
    
    isMultiple in class ElementDefinition<T>
    
    Returns:
    
    true if the metadata is multiple.
  - setMultiple
```
public void setMultiple(boolean isMultiple)
```
    Description copied from class: ElementDefinition
    
    Set the element multiple status.
    
    Overrides:
    
    setMultiple in class ElementDefinition<T>
    
    Parameters:
    
    isMultiple - the element multiple status.
  - getDisableConditions
```
public DisableConditions getDisableConditions()
```
    Description copied from class: ElementDefinition
    
    Retrieves the disable condition.
    
    Overrides:
    
    getDisableConditions in class ElementDefinition<T>
    
    Returns:
    
    the disable condition or null if none is defined.
  - setDisableConditions
```
public void setDisableConditions(DisableConditions disableConditions)
```
    Description copied from class: ElementDefinition
    
    Sets the disable condition.
    
    Overrides:
    
    setDisableConditions in class ElementDefinition<T>
    
    Parameters:
    
    disableConditions - the disable condition.
  - toJSON
```
public Map<String,Object> toJSON()
                          throws ProcessingException
```
    Description copied from interface: ModelItem
    
    Converts the model item in a JSON map
    
    Specified by:
    
    toJSON in interface ModelItem
    
    Overrides:
    
    toJSON in class ElementDefinition<T>
    
    Returns:
    
    The model item as a JSON map
    
    Throws:
    
    ProcessingException - If an error occurs when converting the model item
  - getName
```
public String getName()
```
    Description copied from interface: Labelable
    
    Get the name.
    
    Specified by:
    
    getName in interface Labelable
    
    Overrides:
    
    getName in class AbstractModelItem
    
    Returns:
    
    the name.
  - setName
```
public void setName(String name)
```
    Description copied from interface: ModifiableLabelable
    
    Set the name.
    
    Specified by:
    
    setName in interface ModifiableLabelable
    
    Overrides:
    
    setName in class AbstractModelItem
    
    Parameters:
    
    name - the name.
  - getLabel
```
public I18nizableText getLabel()
```
    Description copied from interface: Labelable
    
    Retrieves the label.
    
    Specified by:
    
    getLabel in interface Labelable
    
    Overrides:
    
    getLabel in class AbstractModelItem
    
    Returns:
    
    the label.
  - setLabel
```
public void setLabel(I18nizableText label)
```
    Description copied from interface: ModifiableLabelable
    
    Set the label.
    
    Specified by:
    
    setLabel in interface ModifiableLabelable
    
    Overrides:
    
    setLabel in class AbstractModelItem
    
    Parameters:
    
    label - the label.
  - getDescription
```
public I18nizableText getDescription()
```
    Description copied from interface: Labelable
    
    Retrieves the description.
    
    Specified by:
    
    getDescription in interface Labelable
    
    Overrides:
    
    getDescription in class AbstractModelItem
    
    Returns:
    
    the description.
  - setDescription
```
public void setDescription(I18nizableText description)
```
    Description copied from interface: ModifiableLabelable
    
    Set the description.
    
    Specified by:
    
    setDescription in interface ModifiableLabelable
    
    Overrides:
    
    setDescription in class AbstractModelItem
    
    Parameters:
    
    description - the description.
  - addItemChecker
```
public void addItemChecker(ItemCheckerDescriptor itemChecker)
```
    Description copied from interface: ModelItem
    
    Add an item checker to the group
    
    Specified by:
    
    addItemChecker in interface ModelItem
    
    Overrides:
    
    addItemChecker in class AbstractModelItem
    
    Parameters:
    
    itemChecker - the item checker to add
  - getItemCheckers
```
public Set<ItemCheckerDescriptor> getItemCheckers()
```
    Description copied from interface: ModelItem
    
    Returns the ItemCheckerDescriptors associated with this group.
    
    Specified by:
    
    getItemCheckers in interface ModelItem
    
    Overrides:
    
    getItemCheckers in class AbstractModelItem
    
    Returns:
    
    the ItemCheckerDescriptors associated with this group.
  - getPath
```
public String getPath()
```
    Description copied from interface: ModelItem
    
    Retrieves the path of the model item
    
    Specified by:
    
    getPath in interface ModelItem
    
    Overrides:
    
    getPath in class AbstractModelItem
    
    Returns:
    
    the item path
  - getModel
```
public Model getModel()
```
    Description copied from interface: ModelItem
    
    Retrieves the model of the item
    
    Specified by:
    
    getModel in interface ModelItem
    
    Overrides:
    
    getModel in class AbstractModelItem
    
    Returns:
    
    the model
  - setModel
```
public void setModel(Model model)
```
    Description copied from interface: ModelItem
    
    Sets the model of the element
    
    Specified by:
    
    setModel in interface ModelItem
    
    Overrides:
    
    setModel in class AbstractModelItem
    
    Parameters:
    
    model - the model to set
  - getParent
```
public ModelItemGroup getParent()
```
    Description copied from interface: ModelItem
    
    Retrieves the parent of the item
    
    Specified by:
    
    getParent in interface ModelItem
    
    Overrides:
    
    getParent in class AbstractModelItem
    
    Returns:
    
    the parent group
  - setParent
```
public void setParent(ModelItemGroup parent)
```
    Description copied from interface: ModelItem
    
    Sets the parent of the item
    
    Specified by:
    
    setParent in interface ModelItem
    
    Overrides:
    
    setParent in class AbstractModelItem
    
    Parameters:
    
    parent - the parent to set
  - compareTo
```
public int compareTo(ModelItem item)
```
    Specified by:
    
    compareTo in interface Comparable<ModelItem>
    
    Overrides:
    
    compareTo in class AbstractModelItem
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractModelItem
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractModelItem
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractModelItem

Class CategorizedElementDefinitionProxy<T>

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_definition

_displayCategory

_displayGroup

_position

_isGroupSwitch

Constructor Detail

CategorizedElementDefinitionProxy

Method Detail

getDefinition

getDisplayCategory

setDisplayCategory

getDisplayGroup

setDisplayGroup

getPosition

setPosition

isGroupSwitch

setGroupSwitch

getPluginName

setPluginName

getType

setType

getWidget

setWidget

getWidgetParameters

setWidgetParameters

getEnumerator

setEnumerator

getValidator

setValidator

getDefaultValue

setDefaultValue

isMultiple

setMultiple

getDisableConditions

setDisableConditions

toJSON

getName

setName

getLabel

setLabel

getDescription

setDescription

addItemChecker

getItemCheckers

getPath

getModel

setModel

getParent

setParent

compareTo

equals

hashCode

toString