Interface IFormItemManagementService

All Known Implementing Classes:
FormItemManagementService

public interface IFormItemManagementService
The Service of management of form items.
  • Field Details

  • Method Details

    • addButton

      default Button addButton(FormItemContainer parent, Command command, AbstractDataPath path, Form form, FormNewItemDescriptor itemDescriptor)
      Add default button to end of parent
      Parameters:
      parent - in which added new button
      command - the command for button (Button#getCommandName())
      path - the data path is parameter of command, can be null
      form - the form
      itemDescriptor - the item descriptor, can be null
      Returns:
      was added button, never null
    • addButton

      Button addButton(FormItemContainer parent, int index, Command command, AbstractDataPath path, Form form, FormNewItemDescriptor itemDescriptor)
      Add button with command and data path to parent index position.
      Parameters:
      parent - in which added a new button, cannot be null
      index - the position of parent
      command - the command for button (Button#getCommandName())
      path - the data path is parameter of command, can be null
      form - the form, cannot be null
      itemDescriptor - the item descriptor, can be null
      Returns:
      the added button, never null
    • addGroup

      default FormGroup addGroup(FormItemContainer parent, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds group to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the group the suitable type and ext info will be set.
      Parameters:
      parent - the parental element to which the group will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support group.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new group with the established actual data, never null
    • addGroup

      default FormGroup addGroup(FormItemContainer parent, ManagedFormGroupType type, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds FormGroup to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the group the type and ext info will be set.
      Parameters:
      parent - the parental element to which the group will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support group.
      type - the type which will be set to group. If type is null then sets the actual for current parameters type. If current type is not support, then throws IllegalArgumentException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new group with the established actual data, never null
    • addGroup

      FormGroup addGroup(FormItemContainer parent, int index, ManagedFormGroupType type, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds group to the index position of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the group the type and corresponding the extInfo will be set.
      Parameters:
      parent - the parental element to which the group will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support group.
      index - of a position of a parental container in which the group will be added. If index out of bound in parental container, then throws IndexOutOfBoundsException.
      type - the type which will be set to group. If type is null then sets the actual for current parameters type. If current type is not support, then throws IllegalArgumentException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new group with the established actual data, never null
    • addField

      default FormField addField(FormItemContainer parent, AbstractDataPath path, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds FormField to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the field the suitable type and ext info will be set.
      Parameters:
      parent - the parental element to which the field will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support field.
      path - the path to data depends on it form field type and ext info. If path is null sets default type and ext info.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new field with the established actual data, never null
    • addField

      default FormField addField(FormItemContainer parent, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds FormField to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the field the suitable type and ext info will be set.
      Parameters:
      parent - the parental element to which the field will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support field.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new field with the established actual data, never null
    • addField

      FormField addField(FormItemContainer parent, AbstractDataPath path, int index, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds FormField to the index position of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the field the suitable type and ext info will be set.
      Parameters:
      parent - the parental element to which the field will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support field.
      path - the path to data depends on it form field type and ext info. If path is null sets default type and ext info.
      index - of a position of a parental container in which the field will be added. If index out of bound in parental container, then throws IndexOutOfBoundsException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new field with the established actual data, never null
    • addField

      default FormField addField(FormItemContainer parent, int index, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds FormField to the index position of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the field the suitable type and ext info will be set.
      Parameters:
      parent - the parental element to which the field will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support field.
      index - of a position of a parental container in which the field will be added. If index out of bound in parental container, then throws IndexOutOfBoundsException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new field with the established actual data, never null
    • addTable

      default Table addTable(FormVisualEntity parent, AbstractDataPath path, boolean createColumns, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Table to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the table the suitable type and ext info will be set.
      Parameters:
      parent - the parental container to which the table will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support table.
      path - the path to data depends on it form table ext info. If path is null sets default ext info.
      createColumns - the flag for creation of the columns from children PropertyInfo of the path PropertyInfo.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new table with the established actual data, never null
    • addTable

      default Table addTable(FormVisualEntity parent, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Table to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the table the default type and ext info will be set.
      Parameters:
      parent - the parental container to which the table will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support table.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new table with the established actual data, never null
    • addTable

      Table addTable(FormVisualEntity parent, AbstractDataPath path, boolean createColumns, int index, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Table to the index position of a parental container( FormItemContainer) also the method sets all necessary data(unique id, name and etc.). At addition to the table the suitable type and ext info will be set.
      Parameters:
      parent - the parental container to which the table will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support table.
      path - the path to data depends on it form table ext info. If path is null sets default ext info.
      createColumns - the flag for creation of the columns from children PropertyInfo of the path PropertyInfo.
      index - of a position of a parental container in which the table will be added. If index out of bound in parental container, then throws IndexOutOfBoundsException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new table with the established actual data, never null
    • addTable

      default Table addTable(FormItemContainer parent, int index, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Table to the index position of a parental container( FormItemContainer) also the method sets all necessary data(unique id, name and etc.). At addition to the table the default type and ext info will be set.
      Parameters:
      parent - the parental container to which the table will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support table.
      index - of a position of a parental container in which the table will be added. If index out of bound in parental container, then throws IndexOutOfBoundsException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new table with the established actual data, never null
    • addTableFieldsByDataPath

      List<FormField> addTableFieldsByDataPath(Table table, AbstractDataPath path, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds FormField for Table.
      Parameters:
      table - the table in which the field is added.
      path - the table path
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new adding fields, never null
    • addFieldWithTable

      default FormField addFieldWithTable(FormItemContainer parent, AbstractDataPath path, boolean createColumns, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds FormField to the index position of a parental container( FormItemContainer) also the method sets all necessary data (unique id, name and etc.). In addition to the field the auto-table will be created and the suitable type and ext info will be set.
      Parameters:
      parent - the parental element to which the field will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support field.
      path - the path to data depends on it form field type and ext info. If path is null sets default type and ext info.
      createColumns - the flag for creation of the columns from children PropertyInfo of the path PropertyInfo. parental container, then throws IndexOutOfBoundsException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new field with the contained table and established actual data, never null
    • addFieldWithTable

      FormField addFieldWithTable(FormItemContainer parent, AbstractDataPath path, boolean createColumns, int index, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds FormField to the index position of a parental container( FormItemContainer) also the method sets all necessary data (unique id, name and etc.). In addition to the field the auto-table will be created and the suitable type and ext info will be set.
      Parameters:
      parent - the parental element to which the field will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support field.
      path - the path to data depends on it form field type and ext info. If path is null sets default type and ext info.
      createColumns - the flag for creation of the columns from children PropertyInfo of the path PropertyInfo.
      index - of a position of a parental container in which the field will be added. If index out of bound in parental container, then throws IndexOutOfBoundsException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new field with the contained table and established actual data, never null
    • addDecoration

      default Decoration addDecoration(FormItemContainer parent, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Decoration to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the decoration the suitable type and ext info will be set
      Parameters:
      parent - the parental container to which the decoration will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support a decoration.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new decoration with the established actual data, never null
    • addDecoration

      default Decoration addDecoration(FormItemContainer parent, ManagedFormDecorationType type, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Decoration to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the decoration the type and ext info will be set.
      Parameters:
      parent - the parental container to which the decoration will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support a decoration.
      type - the type which will be set to decoration. If type is null then sets the actual for current parameters type. If current type is not support, then throws IllegalArgumentException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new decoration with the established actual data, never null
    • addDecoration

      Decoration addDecoration(FormItemContainer parent, int index, ManagedFormDecorationType type, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Decoration to the index position of a parental container( FormItemContainer) also the method sets all necessary data(unique id, name and etc.). At addition to the decoration the type and a corresponding ext info will be set.
      Parameters:
      parent - the parental container to which the decoration will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support a decoration.
      index - of a position of a parental container in which the decoration will be added. If index out of bound in parental container, then throws IndexOutOfBoundsException.
      type - the type which will be set to decoration. If type is null then sets the actual for current parameters type. If current type is not support, then throws IllegalArgumentException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      a new decoration with the established actual data, never null
    • addAddition

      default Addition addAddition(FormItemContainer parent, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Addition to the end of a parental container( FormItemContainer) also the method sets all necessary data( unique id, name and etc.). At addition to the addition the suitable type and ext info will be set
      Parameters:
      parent - the parental container to which the addition will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support an addition.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      an new addition with the established actual data, never null
    • addAddition

      Addition addAddition(FormItemContainer parent, int index, Form form, FormNewItemDescriptor itemDescriptor)
      The method adds Addition to the index position of a parental container( FormItemContainer) also the method sets all necessary data(unique id, name and etc.). At addition to the addition the default type and ext info will be set.
      Parameters:
      parent - the parental container to which the addition will be added. The parent can not be null. Throws IllegalArgumentException if the parent does not support an addition.
      index - of a position of a parental container in which the addition will be added. If index out of bound in parental container, then throws IndexOutOfBoundsException.
      form - the form in which there are all objects. The form can not be null.
      itemDescriptor - the item descriptor, can be null
      Returns:
      an new addition with the established actual data, never null