C# Class Habanero.Faces.VWG.GridBaseVWG

Provides a DataGridView that is adapted to show business objects

Inheritance: DataGridViewVWG, IGridBase

Mostrar archivo Open project: Chillisoft/habanero.faces

Private Properties

Property	Type	Description
FireBusinessObjectSelected	void
FireCollectionChanged	void
SetIDColumnVisibility	void
ToPreventCompilerWarnings	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.
GetBusinessObjectAtRow ( int row ) : IBusinessObject	Returns the business object at the specified row number
GetBusinessObjectCollection ( ) : IBusinessObjectCollection	Returns the business object collection being displayed in the grid
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
SetBusinessObjectCollection ( IBusinessObjectCollection col ) : void	Sets the business object collection displayed in the grid. This collection must be pre-loaded using the collection's Load() command. The default UI definition will be used, that is a 'ui' element without a 'name' attribute.

Protected Methods

Method	Description
GridBaseVWG ( ) : System	Constructor for GridBaseVWG

Private Methods

Method	Description
FireBusinessObjectSelected ( ) : void
FireCollectionChanged ( ) : void
SetIDColumnVisibility ( bool visible ) : void
ToPreventCompilerWarnings ( ) : 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 abstract method

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

public abstract 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

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

GetBusinessObjectCollection() public method

Returns the business object collection being displayed in the grid

public GetBusinessObjectCollection ( ) : IBusinessObjectCollection
return	IBusinessObjectCollection

GetBusinessObjectRow() public method

Returns the row for the specified IBusinessObject.

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

GridBaseVWG() protected method

Constructor for GridBaseVWG

protected GridBaseVWG ( ) : System
return	System

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

SetBusinessObjectCollection() public method

Sets the business object collection displayed in the grid. This collection must be pre-loaded using the collection's Load() command. The default UI definition will be used, that is a 'ui' element without a 'name' attribute.

public SetBusinessObjectCollection ( IBusinessObjectCollection col ) : void
col	IBusinessObjectCollection	The collection of business objects to display. This /// collection must be pre-loaded.
return	void