Class TFireGridModelController

Unit

FireDataGridModelController

Declaration

type TFireGridModelController = class(TObject)

Description

Hierarchy

• TObject
• TFireGridModelController

Overview

Nested Types

	TChangeFlag = (...);
	TChangeFlags = set of TChangeFlag;

Methods

	constructor Create(ViewHost: TFireGridViewInterface);
	destructor Destroy; override;
	procedure SetModel(Model: TFireModelAbstract; Parent: TModelIndex);
	function GetParentIndex: TModelIndex;
	procedure SetSortOrder(dataBinding: TFireGridModelDataBinding; sortIndex: Integer; order: TFireGridSortOrder; caseSensitivity: Boolean = false; localeAware: Boolean = false);
	function GetSortOrder(dataBinding: TFireGridModelDataBinding): TFireGridSortOrder;
	procedure SetGroupOrder(DataBinding: TFireGridModelDataBinding; GroupIndex: Integer; Order: TFireGridSortOrder; CaseSensitivity: Boolean = false; LocaleAware: Boolean = false);
	function GetGroupOrder(DataBinding: TFireGridModelDataBinding): TFireGridSortOrder;
	procedure ClearSorting;
	procedure ClearGrouping;
	function IsGrouping: Boolean;
	function GetGroupingDepth: Integer;
	function GetModelColumnCount: Integer;
	function GetGridRowCount: Integer;
	function GetGridRow(Index: Integer): PFireGridRow;
	function GetGridRowByModelRow(ModelRow: Integer): PFireGridRow;
	function GetFrozenTopGridRowCount: Integer;
	function GetFrozenBottomGridRowCount: Integer;
	function ModelGroupCount: Integer;
	function ModelGroup(Index: Integer): PFireGridModelGroup;
	function GetGroups: TFireGridModelGroupArray;
	procedure ExpandAllGroup;
	procedure CollapseAllGroup;
	function ExpandGroup(Group: PFireGridModelGroup; DisableChanged: Boolean = false): Boolean;
	function CollapseGroup(Group: PFireGridModelGroup; DisableChanged: Boolean = false): Boolean;
	procedure Refresh;
	function GetSummary: TFireGridSummary;
	function GetFilter: TFireGridFilter;
	function GetModelFilter: TFireGridFilter;
	function GetFrozenRowsFilter: TFireGridFilter;
	function GetModelValue(Column: Integer; ModelRow: Integer; Role: TModelItemDataRole; var Value: Variant): Boolean;
	function SetModelValue(Column: Integer; ModelRow: Integer; Role: TModelItemDataRole; const Value: Variant): Boolean;
	function EnsureVisible(modelRow: Integer): Integer;
	procedure EnsureFocus;
	function GetFocusedRowIndex: Integer;
	function GetFocusedColumnIndex: Integer;
	function GetFocusedRow: PFireGridRow;
	function GetOldFocusedRowIndex: Integer;
	function GetOldFocusedColumnIndex: Integer;
	function IsRowFocused(Row: PFireGridRow): Boolean;
	function IsCellFocused(Row: PFireGridRow; ColumnIndex: Integer): Boolean;
	function SetCellFocus(Row: PFireGridRow; ColumnIndex: Integer): Boolean;
	function GetSelection: TFireGridSelection;
	procedure BeginUpdate;
	procedure EndUpdate;
	function IsDataUpdating: Boolean;
	function InsertModelRow(ModelRow: Integer): Boolean;
	function RemoveModelRow(ModelRow: Integer): Boolean;
	procedure BeginAddRow(ModelRowIndex: Integer);
	procedure EndAddRow;
	function IsNewRowMode: Boolean;
	function GetAddingModelRowIndex: Integer;
	function GetDefaultValue(ModelColumn: Integer; Role: TModelItemDataRole; var Value: Variant): Boolean;
	procedure SetDefaultValue(ModelColumn: Integer; const Value: Variant; Role: TModelItemDataRole);
	procedure RemoveDefaultValue(ModelColumn: Integer; Role: TModelItemDataRole);
	procedure RemoveDefaultValues(ModelColumn: Integer);
	function ShowWaitCursor: Boolean;
	procedure SetShowWaitCursor(Show: Boolean);
	function GetEditStrategy: TFireGridEditStrategy;
	procedure SetEditStrategy(Strategy: TFireGridEditStrategy);
	function GetFrozenPlace: TFireGridRowFrozenPlace;
	procedure SetFrozenPlace(Place: TFireGridRowFrozenPlace);
	procedure AddModelRowToFrozenFilter(ModelRowIndex: Integer; Place: TFireGridRowFrozenPlace);
	procedure RemoveModelRowFromFrozenFilter(ModelRowIndex: Integer);
	procedure ClearSelect;
	procedure SelectRanges(const Ranges: TFireGridSelectionRanges; Operation: TFireGridSelectionOperation = [sopSelect]);
	function IsRowSelected(const Row: PFireGridRow): Boolean;
	function IsCellSelected(const Cell: TFireGridCell): Boolean;
	function IsAllSelected: Boolean;
	function GetRowIndexByPersistentRow(const PersistentRow: TFireGridPersistentRow): Integer;
	function GetPureRowCount: Integer;
	function GetRecordCount: Integer;
	function GetModelRowIndexByRecord(RecordVal: Integer): Integer;
	function SubmitData: Boolean;
	function SetFocusInternal(Row: PFireGridRow; ColumnIndex: Integer): Boolean;
	procedure CommitCurrentSelect;
	procedure DoControllerChanged;
	procedure ClearModelGroups;
	procedure ClearPersistRows;
	procedure CreateModelGroups;
	procedure ResizeModelRows(Size: Integer);
	function AppendModelGroup: PFireGridModelGroup;
	function AddModelRowToMap(ModelRow: Integer): Boolean;
	procedure FillRecords;
	procedure CreateGridRows;
	function DoFindGroup(RowIndex: Integer; var GroupIndex: Integer): PFireGridModelGroup;
	function DoFindRowIndexByRecord(RecordVal: Integer): Integer;
	function DoFindRecordByModelRow(ModelRow: Integer): Integer;
	procedure SaveGroupingState;
	procedure RestoreSelectState;
	procedure ClearGroupingState;
	procedure ApplyChanges;
	procedure ModelColumnsInserted(const Parent: TModelIndex; StartRow: Integer; EndRow: Integer);
	procedure ModelColumnsRemoved(const Parent: TModelIndex; StartRow: Integer; EndRow: Integer);
	procedure ModelLayoutChanged(Sender: TObject);
	procedure ModelDataChanged(Sender: TObject; const Index: TModelIndex);
	procedure ModelRowsAboutToBeInserted(const parent: TModelIndex; startRow: Integer; endRow: Integer);
	procedure ModelRowsAboutToBeRemoved(const parent: TModelIndex; startRow: Integer; endRow: Integer);
	procedure ModelRowsInserted(Sender: TObject; const Parent: TModelIndex; Row: Integer);
	procedure ModelRowsRemoved(Sender: TObject; const Parent: TModelIndex; StartRow: Integer; EndRow: Integer);
	procedure ModelAboutToBeReset(Sender: TObject);
	procedure ModelReset(Sender: TObject);
	procedure ModelDestroyed;

Properties

	property Model: TFireModelAbstract read FModel;
	property OnChange: TNotifyEvent read FOnChange write FOnChange;
	property OnSelectedChange: TNotifyEvent read FOnSelectedChange write FOnSelectedChange;
	property OnDataChange: TNotifyEvent read FOnDataChange write FOnDataChange;
	property OnLayoutChange: TNotifyEvent read FOnLayoutChange write FOnLayoutChange;

Description

Nested Types

	TChangeFlag = (...);
Values ccfSortingChanged ccfGroupingChanged ccfRowsChanged ccfDataChanged ccfLayoutChanged ccfFocusChanged ccfSelectionChanged ccfModelRowsChanged

	TChangeFlags = set of TChangeFlag;

Methods

	constructor Create(ViewHost: TFireGridViewInterface);

	destructor Destroy; override;

	procedure SetModel(Model: TFireModelAbstract; Parent: TModelIndex);

	function GetParentIndex: TModelIndex;

	procedure SetSortOrder(dataBinding: TFireGridModelDataBinding; sortIndex: Integer; order: TFireGridSortOrder; caseSensitivity: Boolean = false; localeAware: Boolean = false);

	function GetSortOrder(dataBinding: TFireGridModelDataBinding): TFireGridSortOrder;

	procedure SetGroupOrder(DataBinding: TFireGridModelDataBinding; GroupIndex: Integer; Order: TFireGridSortOrder; CaseSensitivity: Boolean = false; LocaleAware: Boolean = false);

	function GetGroupOrder(DataBinding: TFireGridModelDataBinding): TFireGridSortOrder;

	procedure ClearSorting;

	procedure ClearGrouping;

	function IsGrouping: Boolean;

	function GetGroupingDepth: Integer;

	function GetModelColumnCount: Integer;

	function GetGridRowCount: Integer;

	function GetGridRow(Index: Integer): PFireGridRow;

	function GetGridRowByModelRow(ModelRow: Integer): PFireGridRow;

	function GetFrozenTopGridRowCount: Integer;

	function GetFrozenBottomGridRowCount: Integer;

	function ModelGroupCount: Integer;

	function ModelGroup(Index: Integer): PFireGridModelGroup;

	function GetGroups: TFireGridModelGroupArray;

	procedure ExpandAllGroup;

	procedure CollapseAllGroup;

	function ExpandGroup(Group: PFireGridModelGroup; DisableChanged: Boolean = false): Boolean;

	function CollapseGroup(Group: PFireGridModelGroup; DisableChanged: Boolean = false): Boolean;

	procedure Refresh;

	function GetSummary: TFireGridSummary;

	function GetFilter: TFireGridFilter;

	function GetModelFilter: TFireGridFilter;

	function GetFrozenRowsFilter: TFireGridFilter;

	function GetModelValue(Column: Integer; ModelRow: Integer; Role: TModelItemDataRole; var Value: Variant): Boolean;

	function SetModelValue(Column: Integer; ModelRow: Integer; Role: TModelItemDataRole; const Value: Variant): Boolean;

	function EnsureVisible(modelRow: Integer): Integer;

	procedure EnsureFocus;

	function GetFocusedRowIndex: Integer;

	function GetFocusedColumnIndex: Integer;

	function GetFocusedRow: PFireGridRow;

	function GetOldFocusedRowIndex: Integer;

	function GetOldFocusedColumnIndex: Integer;

	function IsRowFocused(Row: PFireGridRow): Boolean;

	function IsCellFocused(Row: PFireGridRow; ColumnIndex: Integer): Boolean;

	function SetCellFocus(Row: PFireGridRow; ColumnIndex: Integer): Boolean;

	function GetSelection: TFireGridSelection;

	procedure BeginUpdate;

	procedure EndUpdate;

	function IsDataUpdating: Boolean;

	function InsertModelRow(ModelRow: Integer): Boolean;

	function RemoveModelRow(ModelRow: Integer): Boolean;

	procedure BeginAddRow(ModelRowIndex: Integer);

	procedure EndAddRow;

	function IsNewRowMode: Boolean;

	function GetAddingModelRowIndex: Integer;

	function GetDefaultValue(ModelColumn: Integer; Role: TModelItemDataRole; var Value: Variant): Boolean;

	procedure SetDefaultValue(ModelColumn: Integer; const Value: Variant; Role: TModelItemDataRole);

	procedure RemoveDefaultValue(ModelColumn: Integer; Role: TModelItemDataRole);

	procedure RemoveDefaultValues(ModelColumn: Integer);

	function ShowWaitCursor: Boolean;

	procedure SetShowWaitCursor(Show: Boolean);

	function GetEditStrategy: TFireGridEditStrategy;

	procedure SetEditStrategy(Strategy: TFireGridEditStrategy);

	function GetFrozenPlace: TFireGridRowFrozenPlace;

	procedure SetFrozenPlace(Place: TFireGridRowFrozenPlace);

	procedure AddModelRowToFrozenFilter(ModelRowIndex: Integer; Place: TFireGridRowFrozenPlace);

	procedure RemoveModelRowFromFrozenFilter(ModelRowIndex: Integer);

	procedure ClearSelect;

	procedure SelectRanges(const Ranges: TFireGridSelectionRanges; Operation: TFireGridSelectionOperation = [sopSelect]);

	function IsRowSelected(const Row: PFireGridRow): Boolean;

	function IsCellSelected(const Cell: TFireGridCell): Boolean;

	function IsAllSelected: Boolean;

	function GetRowIndexByPersistentRow(const PersistentRow: TFireGridPersistentRow): Integer;

	function GetPureRowCount: Integer;

	function GetRecordCount: Integer;

	function GetModelRowIndexByRecord(RecordVal: Integer): Integer;

	function SubmitData: Boolean;

	function SetFocusInternal(Row: PFireGridRow; ColumnIndex: Integer): Boolean;

	procedure CommitCurrentSelect;

	procedure DoControllerChanged;

	procedure ClearModelGroups;

	procedure ClearPersistRows;

	procedure CreateModelGroups;

	procedure ResizeModelRows(Size: Integer);

	function AppendModelGroup: PFireGridModelGroup;

	function AddModelRowToMap(ModelRow: Integer): Boolean;

	procedure FillRecords;

	procedure CreateGridRows;

	function DoFindGroup(RowIndex: Integer; var GroupIndex: Integer): PFireGridModelGroup;

	function DoFindRowIndexByRecord(RecordVal: Integer): Integer;

	function DoFindRecordByModelRow(ModelRow: Integer): Integer;

	procedure SaveGroupingState;

	procedure RestoreSelectState;

	procedure ClearGroupingState;

	procedure ApplyChanges;

	procedure ModelColumnsInserted(const Parent: TModelIndex; StartRow: Integer; EndRow: Integer);

	procedure ModelColumnsRemoved(const Parent: TModelIndex; StartRow: Integer; EndRow: Integer);

	procedure ModelLayoutChanged(Sender: TObject);

	procedure ModelDataChanged(Sender: TObject; const Index: TModelIndex);

	procedure ModelRowsAboutToBeInserted(const parent: TModelIndex; startRow: Integer; endRow: Integer);

	procedure ModelRowsAboutToBeRemoved(const parent: TModelIndex; startRow: Integer; endRow: Integer);

	procedure ModelRowsInserted(Sender: TObject; const Parent: TModelIndex; Row: Integer);

	procedure ModelRowsRemoved(Sender: TObject; const Parent: TModelIndex; StartRow: Integer; EndRow: Integer);

	procedure ModelAboutToBeReset(Sender: TObject);

	procedure ModelReset(Sender: TObject);

	procedure ModelDestroyed;

Properties

	property Model: TFireModelAbstract read FModel;

	property OnChange: TNotifyEvent read FOnChange write FOnChange;

	property OnSelectedChange: TNotifyEvent read FOnSelectedChange write FOnSelectedChange;

	property OnDataChange: TNotifyEvent read FOnDataChange write FOnDataChange;

	property OnLayoutChange: TNotifyEvent read FOnLayoutChange write FOnLayoutChange;

---

Generated by PasDoc 0.15.0.