Interface FieldGroupCapability

  • All Superinterfaces:
    DFCapability

    public interface FieldGroupCapability
    extends DFCapability
    This capability allows assigning a DFField to a group of fields. The field groups make up a tree-like hierarchical structure and a single field can belong to at most one of those hierarchies. The group membership has no impact on the way how data are loaded into a field, but can be used for better presentation in UI.

    Each group is identified by an arbitrary comparable Object instance and the exact position within the group hierarchy is described by the path from the top level group to the bottom level group. This path is expressed as a List of comparable Object instances denoting the groups along the path.

    The same group can be represented by multiple Object instances, which are all equal to each other in the means of Object.equals(Object). Therefore the group instances may also want to implement Object.equals(Object) and Object.hashCode() methods.

    The Object instance used for a group should implement meaningful Object.toString() method, which will likely be used by the presentation layer for visualizing the group. An example of such a UI can be the IJC table widget, which will use multiple header rows to show the groups that fields belong to.

    Since:
    16.9.26.0
    • Method Detail

      • getGroups

        java.util.List<java.lang.Comparable<?>> getGroups()
        Gets the list of instances representing groups that a DFField belongs to. The list should be immutable.
        Returns:
        The group path for a DFField.