C# Class Habanero.Faces.Win.EditableGridControlWin

Provides a combination of editable grid, filter and buttons used to edit a collection of business objects

Inheritance: UserControlWin, IEditableGridControl

Show file Open project: Chillisoft/habanero.faces Class Usage Examples

Private Properties

Property	Type	Description
Buttons_CancelClicked	void
Buttons_SaveClicked	void
FilterControl_OnFilter	void
Grid_OnBusinessObjectSelected	void
InitialiseButtons	void
InitialiseFilterControl	void

Public Methods

Method	Description
Clear ( ) : void	Clears the business object collection and the rows in the data table
EditableGridControlWin ( ) : System	Constructs a new instance of a EditableGridControlWin. This uses the IControlFactory from the GlobalUIRegistry to construct the control.
EditableGridControlWin ( IControlFactory controlFactory ) : System	Constructs a new instance of a EditableGridControlWin.
GetBusinessObjectAtRow ( int row ) : IBusinessObject	Returns the business object at the specified row number
GetBusinessObjectCollection ( ) : IBusinessObjectCollection	Returns the IBusinessObjectCollection that has been set for this IGridControl.
Initialise ( IClassDef classDef ) : void	Initiliases the grid structure using the default UI class definition (implicitly named "default")
Initialise ( IClassDef classDef, IUIGrid gridDef, string uiDefName ) : void	Initialises the grid structure using the given UI class definition
Initialise ( IClassDef classDef, string uiDefName ) : void	Initialises the grid structure using the specified UI class definition
RefreshFilter ( ) : void	Refresh the Filter.
SetBusinessObjectCollection ( IBusinessObjectCollection boCollection ) : void	Sets the business object collection to display. Loading of the collection needs to be done before it is assigned to the grid. This method assumes a default UI definition is to be used, that is a 'ui' element without a 'name' attribute.

Private Methods

Method	Description
Buttons_CancelClicked ( object sender, EventArgs e ) : void
Buttons_SaveClicked ( object sender, EventArgs e ) : void
FilterControl_OnFilter ( object sender, EventArgs e ) : void
Grid_OnBusinessObjectSelected ( object sender, Habanero.Base.BOEventArgs e ) : void
InitialiseButtons ( ) : void
InitialiseFilterControl ( ) : void

Method Details

Clear() public method

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

public Clear ( ) : void
return	void

EditableGridControlWin() public method

Constructs a new instance of a EditableGridControlWin. This uses the IControlFactory from the GlobalUIRegistry to construct the control.

public EditableGridControlWin ( ) : System
return	System

EditableGridControlWin() public method

Constructs a new instance of a EditableGridControlWin.

public EditableGridControlWin ( IControlFactory controlFactory ) : System
controlFactory	IControlFactory	The to use to construct the control.
return	System

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 IBusinessObjectCollection that has been set for this IGridControl.

public GetBusinessObjectCollection ( ) : IBusinessObjectCollection
return	IBusinessObjectCollection

Initialise() public method

Initiliases the grid structure using the default UI class definition (implicitly named "default")

public Initialise ( IClassDef classDef ) : void
classDef	IClassDef	The class definition of the business objects shown in the grid
return	void

Initialise() public method

Initialises the grid structure using the given UI class definition

public Initialise ( IClassDef classDef, IUIGrid gridDef, string uiDefName ) : void
classDef	IClassDef	The class definition of the business objects shown in the grid
gridDef	IUIGrid	The grid definition to use
uiDefName	string	The name of the grid definition.
return	void

Initialise() public method

Initialises the grid structure using the specified UI class definition

public Initialise ( IClassDef classDef, string uiDefName ) : void
classDef	IClassDef	The class definition of the business objects shown in the grid
uiDefName	string	The UI definition with the given name
return	void

RefreshFilter() public method

Refresh the Filter.

public RefreshFilter ( ) : void
return	void

SetBusinessObjectCollection() public method

Sets the business object collection to display. Loading of the collection needs to be done before it is assigned to the grid. This method assumes a default UI definition is to be used, that is a 'ui' element without a 'name' attribute.

public SetBusinessObjectCollection ( IBusinessObjectCollection boCollection ) : void
boCollection	IBusinessObjectCollection	The new business object collection /// to be shown in the grid
return	void