Class FormRoot

  • All Implemented Interfaces:
    FormSelectable

    public class FormRoot
    extends FormContainer
    A form root is a container for all top-level components in a form model.
    • Constructor Detail

      • FormRoot

        public FormRoot()
        Constructs a form root.
    • Method Detail

      • getBindingGroupCount

        public int getBindingGroupCount()
        Returns the number of form binding groups in this form root.
        Since:
        5.0
      • getBindingGroup

        public FormBindingGroup getBindingGroup​(int index)
        Returns the form binding group at index.
        Since:
        5.0
      • getBindingGroup

        public FormBindingGroup getBindingGroup​(String name)
        Returns the form binding group for the given name.
        Since:
        5.0
      • getBindingGroups

        public FormBindingGroup[] getBindingGroups()
        Returns all form binding groups in this form root.
        Since:
        5.0
      • getBindingGroupIndex

        public int getBindingGroupIndex​(FormBindingGroup bindingGroup)
        Returns the index of bindingGroup in this form; or -1 if the binding group is not a child of this form.
      • addBindingGroup

        public void addBindingGroup​(FormBindingGroup bindingGroup)
        Adds a form binding group to the end of this form root.
        Since:
        5.0
      • addBindingGroup

        public void addBindingGroup​(FormBindingGroup bindingGroup,
                                    int index)
        Adds a form binding group to this form root at the specified position.
        Parameters:
        bindingGroup - The form binding group to be added.
        index - The position in the binding group list at which to insert the binding group; or -1 to insert at the end
        Since:
        5.0
      • removeBindingGroup

        public void removeBindingGroup​(FormBindingGroup bindingGroup)
        Removes the specified form binding group from this form root.
        Since:
        5.0
      • removeBindingGroup

        public void removeBindingGroup​(int index)
        Removes the form binding group at the specified index from this form root.
        Since:
        5.0