Package nl.gx.forms.wmpformapi.api.form
Interface FormFragmentContainer
-
- All Superinterfaces:
BasicFormFragmentContainer
,Presentable
,Wrapper
- All Known Subinterfaces:
FormLogicContainer
,FormSectionVersion
,FormStep
public interface FormFragmentContainer extends Presentable, BasicFormFragmentContainer
Container for FormFragments.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FormFragment
createFormFragment(String interfaceClassName)
Creates a new FormFragment with the specified classname in this container.void
deleteFormFragment(FormFragment formFragment)
Deletes a FormFragment from this FormFragmentContainer.BasicFormFragment
getFragmentById(String jcrUuid)
Looks up the FormFragment with the specified JCR uuid in this container.BasicFormFragment
getFragmentByIdentifier(String identifier)
Looks up the FormFragment with the specified identifier in this container.List<FormLanguageLabelContainer>
getLanguageContainers()
Returns all language label containers that hold translations of specific properties for this form fragment.FormLanguageLabelContainer
getOrCreateLanguageContainer(String locale)
Retrieves or creates a language label container that holds translations of specific properties for this form fragment for the specified locale.Map
getScope()
While rendering, this method returns the scope in which the values for the FormFragments in this FormFragmentContainer are stored.String
getTitle()
The title of this form step.int
getUniqueFormFragmentId(String prefix, int startIndex)
WmId
getWmId()
Returns the WebManager ID (UUID) for this form step.void
setFormFragments(List<BasicFormFragment> formFragments)
Sets of updates the list of all top level form fields on this step.void
setIdentifier(String identifier)
Sets the unique identifier of this stepvoid
setLanguageContainers(List<FormLanguageLabelContainer> containers)
Sets all language label containers that hold translations of specific properties for this form fragment.void
setTitle(String title)
Sets the title of this step.-
Methods inherited from interface nl.gx.forms.wmpformapi.api.BasicFormFragmentContainer
getAllChildFormFragments, getAllChildFormFragments, getAllFormFragments, getFormFragments, getIdentifier, getNestedPath
-
Methods inherited from interface nl.gx.webmanager.cms.core.Presentable
getPresentation, getPresentationVariant, render, render, setPresentation, setPresentationVariant
-
-
-
-
Method Detail
-
setFormFragments
void setFormFragments(List<BasicFormFragment> formFragments)
Sets of updates the list of all top level form fields on this step.- Parameters:
formFragments
- the new set of form fields for this step
-
getTitle
String getTitle()
The title of this form step.- Returns:
- the title of this form step
-
setTitle
void setTitle(String title)
Sets the title of this step.- Parameters:
title
- the new title of this step
-
getScope
Map getScope()
While rendering, this method returns the scope in which the values for the FormFragments in this FormFragmentContainer are stored.- Returns:
- the scope in which the values for the FormFragments are stored
-
setIdentifier
void setIdentifier(String identifier)
Sets the unique identifier of this step- Parameters:
identifier
- the new unique identifier of this step
-
getWmId
WmId getWmId()
Returns the WebManager ID (UUID) for this form step.- Returns:
- the WebManager ID (UUID) for this form step
-
getFragmentByIdentifier
BasicFormFragment getFragmentByIdentifier(String identifier)
Looks up the FormFragment with the specified identifier in this container.- Parameters:
identifier
- the identifier of the FormFragment to look up- Returns:
- the FormFragment with the specified identifier or null if none was found
-
getFragmentById
BasicFormFragment getFragmentById(String jcrUuid)
Looks up the FormFragment with the specified JCR uuid in this container.- Parameters:
jcrUuid
- the JCR uuid of the FormFragment to look up- Returns:
- the FormFragment with the specified jcr id or null if none was found
- Since:
- 10.33.0
-
getUniqueFormFragmentId
int getUniqueFormFragmentId(String prefix, int startIndex)
-
deleteFormFragment
void deleteFormFragment(FormFragment formFragment)
Deletes a FormFragment from this FormFragmentContainer.- Parameters:
formFragment
- the FormFragment to delete
-
createFormFragment
FormFragment createFormFragment(String interfaceClassName)
Creates a new FormFragment with the specified classname in this container.- Parameters:
interfaceClassName
- the classname of the new FormFragment- Returns:
- the new FormFragment
-
getLanguageContainers
List<FormLanguageLabelContainer> getLanguageContainers()
Returns all language label containers that hold translations of specific properties for this form fragment.- Returns:
- all language containers that hold translations of specific properties for this form fragment
-
setLanguageContainers
void setLanguageContainers(List<FormLanguageLabelContainer> containers)
Sets all language label containers that hold translations of specific properties for this form fragment.- Parameters:
containers
- all language containers that hold translations of specific properties for this form fragment
-
getOrCreateLanguageContainer
FormLanguageLabelContainer getOrCreateLanguageContainer(String locale)
Retrieves or creates a language label container that holds translations of specific properties for this form fragment for the specified locale.- Parameters:
locale
- the locale for which to return or create a language label container- Returns:
- a language label container that holds translations of specific properties for this form fragment for the specified locale
-
-