Package org.ametys.runtime.model
Class TemporaryViewReference
java.lang.Object
org.ametys.runtime.model.TemporaryViewReference
- All Implemented Interfaces:
ViewItem
,Labelable
,ModifiableLabelable
Reference to a view to included in another view.
Use this temporary reference only in view parsers, and resolve it before using the first view
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Copy the current view item in the given one.Create an instance ofViewItem
boolean
Indicates whether some other object is "equal to" this one.Retrieves the description.getLabel()
Retrieves the label.getName()
Get the name.void
setDescription
(I18nizableText description) Set the description.void
setLabel
(I18nizableText label) Set the label.void
Set the name.toJSON
(DefinitionContext context) Converts the view item in a JSON map
-
Constructor Details
-
TemporaryViewReference
public TemporaryViewReference()
-
-
Method Details
-
setName
Description copied from interface:ModifiableLabelable
Set the name.- Specified by:
setName
in interfaceModifiableLabelable
- Parameters:
name
- the name.
-
getName
Description copied from interface:Labelable
Get the name. -
setLabel
Description copied from interface:ModifiableLabelable
Set the label.- Specified by:
setLabel
in interfaceModifiableLabelable
- Parameters:
label
- the label.
-
setDescription
Description copied from interface:ModifiableLabelable
Set the description.- Specified by:
setDescription
in interfaceModifiableLabelable
- Parameters:
description
- the description.
-
getLabel
Description copied from interface:Labelable
Retrieves the label. -
getDescription
Description copied from interface:Labelable
Retrieves the description.- Specified by:
getDescription
in interfaceLabelable
- Returns:
- the description.
-
toJSON
Description copied from interface:ViewItem
Converts the view item in a JSON map- Specified by:
toJSON
in interfaceViewItem
- 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
-
equals
Description copied from interface:ViewItem
Indicates whether some other object is "equal to" this one. -
createInstance
Description copied from interface:ViewItem
Create an instance ofViewItem
- Specified by:
createInstance
in interfaceViewItem
- Returns:
- the created instance
-
copyTo
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
-