import {DataField} from '../../data-fields/models/abstract-data-field';
import {DataGroupLayout} from './data-group-layout';

/**
 * Object from Backend
 */
export interface DataGroup extends ParentDataGroupInformation{
    /**
     * Array [DataField]{@link DataField}
     */
    fields: Array<DataField<any>>;
    /**
     * Name of the data group
     */
    title?: string;
    /**
     * Design alignment
     * ***Example:*** start
     */
    alignment: DataGroupAlignment;
    /**
     * Design stretch
     *
     * ***Example:*** true
     */
    stretch: boolean;
    layout?: DataGroupLayout;
}

/**
 * An object containing the information about the parent of a data group
 */
export interface ParentDataGroupInformation {
    /**
     * String id of parent task, only set if dataGroup is loaded by {@link TaskRefField}
     */
    parentTaskId?: string;
    /**
     * String id of parent task, only set if dataGroup is loaded by {@link TaskRefField}
     */
    parentTransitionId?: string;
    /**
     * String id of parent case, only set if dataGroup is loaded by {@link TaskRefField}
     */
    parentCaseId?: string;
    /**
     * String id of the parent task ref. Only set if the data group is loaded via a {@link TaskRefField}
     */
    parentTaskRefId?: string;
    /**
     * Level of nesting in a task reffed data group. Only set if the data group is loaded via a {@link TaskRefField}
     */
    nestingLevel?: number;
}

/**
 * Determines the position of the last data field when the number of data fields in a data group is odd.
 */
export enum DataGroupAlignment {
    /**
     * Positioned in the left column
     */
    START = 'start',
    /**
     * Positioned in the center of the screen
     */
    CENTER = 'center',
    /**
     * Positioned in the right column
     */
    END = 'end'
}