Package org.ametys.runtime.model
Interface ViewItem
- All Superinterfaces:
Labelable
,ModifiableLabelable
- All Known Subinterfaces:
ModelViewItem<T>
,ViewItemGroup
- All Known Implementing Classes:
AbstractViewItemGroup
,ModelViewItemGroup
,SimpleViewItemGroup
,TemporaryViewReference
,ViewElement
,ViewElementAccessor
Interface for view items
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Copy the current view item in the given one.default void
Copy the current view item in the given one.Create an instance ofViewItem
boolean
Indicates whether some other object is "equal to" this one.toJSON
(DefinitionContext context) Converts the view item in a JSON mapMethods inherited from interface org.ametys.runtime.util.Labelable
getDescription, getLabel, getName
Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable
setDescription, setLabel, setName
-
Method Details
-
toJSON
Converts the view item in a JSON map- 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
-
createInstance
Create an instance ofViewItem
- Returns:
- the created instance
-
copyTo
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- Parameters:
item
- the copyreferenceView
- the reference view
-
copyTo
Copy the current view item in the given one. If the view item is an accessor, its view items are not copied- Parameters:
item
- the copy
-
equals
Indicates whether some other object is "equal to" this one.- 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.
-