Package nl.gx.forms.wmpformapi.api
Interface BasicFormFragmentContainer
-
- All Known Subinterfaces:
BasicFormLogicContainer
,BasicFormSectionVersion
,BasicFormStep
,CompositeFormFragment
,FormFragmentContainer
,FormFragmentFormSection
,FormFragmentRepeat
,FormFragmentRepeatFormSection
,FormLogicContainer
,FormSectionVersion
,FormStep
public interface BasicFormFragmentContainer
Basic interface for the FormFragmentContainer. All FormFragmentContainers should implement this interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<BasicFormFragment>
getAllChildFormFragments()
Returns a list of all child form fragments of this BasicFormFragmentContainer.List<BasicFormFragment>
getAllChildFormFragments(boolean includeFormSectionFragments)
Returns a list of all child form fragments of this BasicFormFragmentContainer.List<BasicFormFragment>
getAllFormFragments()
Returns a list of all form fragments "below" this BasicFormFragmentContainer.List<BasicFormFragment>
getFormFragments()
Returns a list of all top level form fields in this BasicFormFragmentContainer.String
getIdentifier()
Returns the unique identifier or this BasicFormFragmentContainer.String
getNestedPath()
Returns the nested path of this BasicFormFragmentContainer.
-
-
-
Method Detail
-
getIdentifier
String getIdentifier()
Returns the unique identifier or this BasicFormFragmentContainer.- Returns:
- the unique identifier of this BasicFormFragmentContainer.
-
getNestedPath
String getNestedPath()
Returns the nested path of this BasicFormFragmentContainer. Note that this method only returns a proper result when it is invoked in the context of a rendering request since it depends on its' parent having been rendered previously.- Returns:
- the nested path of this BasicFormFragmentContainer
-
getFormFragments
List<BasicFormFragment> getFormFragments()
Returns a list of all top level form fields in this BasicFormFragmentContainer.- Returns:
- the list of all top level form fields in this BasicFormFragmentContainer
-
getAllFormFragments
List<BasicFormFragment> getAllFormFragments()
Returns a list of all form fragments "below" this BasicFormFragmentContainer. Recurses into underlying CompositeFormFragments.- Returns:
- a list of all form fragments
-
getAllChildFormFragments
List<BasicFormFragment> getAllChildFormFragments()
Returns a list of all child form fragments of this BasicFormFragmentContainer. Recurses into underlying BasicFormFragmentContainers and FormFragmentFormSections.- Returns:
- a list of all child form fragments
-
getAllChildFormFragments
List<BasicFormFragment> getAllChildFormFragments(boolean includeFormSectionFragments)
Returns a list of all child form fragments of this BasicFormFragmentContainer. Recurses into underlying BasicFormFragmentContainers and optionally into FormFragmentFormSections.- Parameters:
includeFormSectionFragments
- Indicates whether the fragments inside form section fragments must be returned as well- Returns:
- a list of all child form fragments
- Since:
- 10.33.0
-
-