import { IPSModelObject } from '../../ipsmodel-object';
import { IPSLanguageRes } from '../../res/ipslanguage-res';
import { IPSSysCss } from '../../res/ipssys-css';
import { IPSSysImage } from '../../res/ipssys-image';
import { IPSSysPFPlugin } from '../../res/ipssys-pfplugin';

/**
 *
 * 子接口类型识别属性[columnType]
 * @export
 * @interface IPSDEGridColumn
 */
export interface IPSDEGridColumn extends IPSModelObject {
  /**
   * 聚合值存储属性
   * @type {string}
   */
  aggField: string;

  /**
   * 聚合模式
   * @description 值模式 [表格列聚合模式] {NONE：无聚合、 SUM：合计、 AVG：平均、 MAX：最大值、 MIN：最小值、 USER：用户自定义、 USER2：用户自定义2、 USER3：用户自定义3、 USER4：用户自定义4 }
   * @type {( string | 'NONE' | 'SUM' | 'AVG' | 'MAX' | 'MIN' | 'USER' | 'USER2' | 'USER3' | 'USER4')}
   * @default NONE
   */
  aggMode: string | 'NONE' | 'SUM' | 'AVG' | 'MAX' | 'MIN' | 'USER' | 'USER2' | 'USER3' | 'USER4';

  /**
   * 聚合值格式化
   * @type {string}
   */
  aggValueFormat: string;

  /**
   * 列水平对齐
   * @description 值模式 [云实体属性界面模式表格列对齐] {LEFT：左对齐、 CENTER：居中、 RIGHT：右对齐 }
   * @type {( string | 'LEFT' | 'CENTER' | 'RIGHT')}
   */
  align: string | 'LEFT' | 'CENTER' | 'RIGHT';

  /**
   * 标题语言资源
   *
   * @type {IPSLanguageRes}
   */
  getCapPSLanguageRes(): IPSLanguageRes | null;

  /**
   * 标题语言资源
   *
   * @type {IPSLanguageRes}
   */
  get capPSLanguageRes(): IPSLanguageRes | null;

  /**
   * 标题语言资源（必须存在）
   *
   * @type {IPSLanguageRes}
   */
  getCapPSLanguageResMust(): IPSLanguageRes;

  /**
   * 标题
   * @type {string}
   */
  caption: string;

  /**
   * 单元格样式对象
   *
   * @type {IPSSysCss}
   */
  getCellPSSysCss(): IPSSysCss | null;

  /**
   * 单元格样式对象
   *
   * @type {IPSSysCss}
   */
  get cellPSSysCss(): IPSSysCss | null;

  /**
   * 单元格样式对象（必须存在）
   *
   * @type {IPSSysCss}
   */
  getCellPSSysCssMust(): IPSSysCss;

  /**
   * 代码标识
   * @type {string}
   */
  codeName: string;

  /**
   * 表格列样式
   * @type {string}
   */
  columnStyle: string;

  /**
   * 列类型
   * @description 值模式 [云实体表格列类型] {DEFGRIDCOLUMN：属性列、 UAGRIDCOLUMN：操作列、 GROUPGRIDCOLUMN：属性分组列 }
   * @type {( string | 'DEFGRIDCOLUMN' | 'UAGRIDCOLUMN' | 'GROUPGRIDCOLUMN')}
   */
  columnType: string | 'DEFGRIDCOLUMN' | 'UAGRIDCOLUMN' | 'GROUPGRIDCOLUMN';

  /**
   * 列数据项名称
   * @type {string}
   */
  dataItemName: string;

  /**
   * Excel导出标题
   * @type {string}
   */
  excelCaption: string;

  /**
   * 头部样式对象
   *
   * @type {IPSSysCss}
   */
  getHeaderPSSysCss(): IPSSysCss | null;

  /**
   * 头部样式对象
   *
   * @type {IPSSysCss}
   */
  get headerPSSysCss(): IPSSysCss | null;

  /**
   * 头部样式对象（必须存在）
   *
   * @type {IPSSysCss}
   */
  getHeaderPSSysCssMust(): IPSSysCss;

  /**
   * 无权限显示模式
   * @description 值模式 [应用无权限内容显示模式] {1：显示空或*内容、 2：隐藏 }
   * @type {( number | 1 | 2)}
   */
  noPrivDisplayMode: number | 1 | 2;

  /**
   * 头部图片对象
   *
   * @type {IPSSysImage}
   */
  getPSSysImage(): IPSSysImage | null;

  /**
   * 头部图片对象
   *
   * @type {IPSSysImage}
   */
  get psSysImage(): IPSSysImage | null;

  /**
   * 头部图片对象（必须存在）
   *
   * @type {IPSSysImage}
   */
  getPSSysImageMust(): IPSSysImage;

  /**
   * 列前端扩展插件
   *
   * @type {IPSSysPFPlugin}
   */
  getPSSysPFPlugin(): IPSSysPFPlugin | null;

  /**
   * 列前端扩展插件
   *
   * @type {IPSSysPFPlugin}
   */
  get psSysPFPlugin(): IPSSysPFPlugin | null;

  /**
   * 列前端扩展插件（必须存在）
   *
   * @type {IPSSysPFPlugin}
   */
  getPSSysPFPluginMust(): IPSSysPFPlugin;

  /**
   * 列宽
   * @type {number}
   */
  width: number;

  /**
   * 列宽单位
   * @description 值模式 [云实体表格列宽度单位] {PX：px、 STAR：* }
   * @type {( string | 'PX' | 'STAR')}
   */
  widthUnit: string | 'PX' | 'STAR';

  /**
   * 支持行编辑
   * @type {boolean}
   * @default false
   */
  enableRowEdit: boolean;

  /**
   * 支持排序
   * @type {boolean}
   */
  enableSort: boolean;

  /**
   * 隐藏数据项
   * @type {boolean}
   * @default false
   */
  hiddenDataItem: boolean;

  /**
   * 默认隐藏
   * @type {boolean}
   * @default false
   */
  hideDefault: boolean;
}