C# Class Habanero.Faces.Win.GridBaseWin

Provides a DataGridView that is adapted to show business objects

Inheritance: DataGridViewWin, IGridBase

Show file Open project: Chillisoft/habanero.faces

Private Properties

Property	Type	Description
ApproachColor	byte
DetermineRequiredColumnWidths	void
DistributeAvailableColumnWidths	void
DoubleClickHandler	void
FireBusinessObjectSelected	void
FireCollectionChanged	void
FireFilterUpdated	void
GetBusinessObjectCollection	IBusinessObjectCollection
GetColumnHeaderRequiredWidths	List
ImplementAlternatRowColoring	void
SetBusinessObjectCollection	void
SetIDColumnVisibility	void

Public Methods

Method	Description
ApplyFilter ( IFilterClause filterClause ) : void	Applies a filter clause to the data table and updates the filter. The filter allows you to determine which objects to display using some criteria. This is typically generated by an IFilterControl.
ApplySearch ( IFilterClause searchClause, string orderBy ) : void	Applies a search clause to the underlying collection and reloads the grid. The search allows you to determine which objects to display using some criteria. This is typically generated by the an IFilterControl.
ApplySearch ( string searchClause, string orderBy ) : void	Applies a search clause to the underlying collection and reloads the grid. The search allows you to determine which objects to display using some criteria. This is typically generated by the an IFilterControl.
CheckUserWantsToDelete ( ) : bool	Displays a message box to the user to check if they want to proceed with deleting the selected rows.
Clear ( ) : void	Clears the business object collection and the rows in the data table
CreateDataSetProvider ( IBusinessObjectCollection col ) : IDataSetProvider	Creates a dataset provider that is applicable to this grid. For example, a readonly grid would return a ReadOnlyDataSetProvider, while an editable grid would return an editable one.
FireRowDoubleClicked ( IBusinessObject selectedBo ) : void	Creates an event for a row being double-clicked
GetBusinessObjectAtRow ( int row ) : IBusinessObject	Returns the business object at the specified row number
GetBusinessObjectRow ( IBusinessObject businessObject ) : IDataGridViewRow	Returns the row for the specified IBusinessObject.
RefreshBusinessObjectRow ( IBusinessObject businessObject ) : void	Refreshes the row values for the specified IBusinessObject.
RefreshGrid ( ) : void	Reloads the grid based on the grid returned by GetBusinessObjectCollection

Protected Methods

Method	Description
GridBaseWin ( ) : System	Constructor for GridBaseWin
ImplementColumnAutoSizingStrategy ( ) : void
MustDelete ( ) : bool	Uses the ConfirmDeletion and CheckUserConfirmsDeletion to determine Whether the SelectedBusinessObject must be deleted or not.

Private Methods

Method	Description
ApproachColor ( byte fg, byte bg ) : byte
DetermineRequiredColumnWidths ( List requiredWidths, int columnCount ) : void
DistributeAvailableColumnWidths ( List requiredWidths ) : void
DoubleClickHandler ( object sender, EventArgs e ) : void	Handles the event of a double-click
FireBusinessObjectSelected ( ) : void
FireCollectionChanged ( ) : void
FireFilterUpdated ( ) : void	Calls the FilterUpdated() method, passing this instance as the sender
GetBusinessObjectCollection ( ) : IBusinessObjectCollection
GetColumnHeaderRequiredWidths ( ) : List
ImplementAlternatRowColoring ( ) : void
SetBusinessObjectCollection ( IBusinessObjectCollection col ) : void
SetIDColumnVisibility ( bool visible ) : void

Method Details

ApplyFilter() public method

Applies a filter clause to the data table and updates the filter. The filter allows you to determine which objects to display using some criteria. This is typically generated by an IFilterControl.

public ApplyFilter ( IFilterClause filterClause ) : void
filterClause	IFilterClause	The filter clause
return	void

ApplySearch() public method

Applies a search clause to the underlying collection and reloads the grid. The search allows you to determine which objects to display using some criteria. This is typically generated by the an IFilterControl.

public ApplySearch ( IFilterClause searchClause, string orderBy ) : void
searchClause	IFilterClause	The search clause
orderBy	string
return	void

ApplySearch() public method

public ApplySearch ( string searchClause, string orderBy ) : void
searchClause	string	The search clause
orderBy	string
return	void

CheckUserWantsToDelete() public method

Displays a message box to the user to check if they want to proceed with deleting the selected rows.

public CheckUserWantsToDelete ( ) : bool
return	bool

Clear() public method

Clears the business object collection and the rows in the data table

public Clear ( ) : void
return	void

CreateDataSetProvider() public abstract method

Creates a dataset provider that is applicable to this grid. For example, a readonly grid would return a ReadOnlyDataSetProvider, while an editable grid would return an editable one.

public abstract CreateDataSetProvider ( IBusinessObjectCollection col ) : IDataSetProvider
col	IBusinessObjectCollection	The collection to create the datasetprovider for
return	IDataSetProvider

FireRowDoubleClicked() public method

Creates an event for a row being double-clicked

public FireRowDoubleClicked ( IBusinessObject selectedBo ) : void
selectedBo	IBusinessObject	The business object to which the /// double-click applies
return	void

GetBusinessObjectAtRow() public method

Returns the business object at the specified row number

public GetBusinessObjectAtRow ( int row ) : IBusinessObject
row	int	The row number in question
return	IBusinessObject

GetBusinessObjectRow() public method

Returns the row for the specified IBusinessObject.

public GetBusinessObjectRow ( IBusinessObject businessObject ) : IDataGridViewRow
businessObject	IBusinessObject	The to search for.
return	IDataGridViewRow

GridBaseWin() protected method

Constructor for GridBaseWin

protected GridBaseWin ( ) : System
return	System

ImplementColumnAutoSizingStrategy() protected method

protected ImplementColumnAutoSizingStrategy ( ) : void
return	void

MustDelete() protected method

Uses the ConfirmDeletion and CheckUserConfirmsDeletion to determine Whether the SelectedBusinessObject must be deleted or not.

protected MustDelete ( ) : bool
return	bool

RefreshBusinessObjectRow() public method

Refreshes the row values for the specified IBusinessObject.

public RefreshBusinessObjectRow ( IBusinessObject businessObject ) : void
businessObject	IBusinessObject	The for which the row must be refreshed.
return	void

RefreshGrid() public method

Reloads the grid based on the grid returned by GetBusinessObjectCollection

public RefreshGrid ( ) : void
return	void