C# Class Habanero.Faces.Win.DefaultBOEditorFormWin

Provides a form used to edit business objects. This form will usually be constructed using a UI Form definition provided in the class definitions. The appropriate UI definition is typically set in the constructor.

Inheritance: FormWin, IDefaultBOEditorForm

Show file Open project: Chillisoft/habanero.faces

Public Methods

Method	Description
DefaultBOEditorFormWin ( BusinessObject bo, string uiDefName, IControlFactory controlFactory ) : System	Constructs the DefaultBOEditorFormWin class with the specified BusinessObject, uiDefName and IControlFactory.
DefaultBOEditorFormWin ( BusinessObject bo, string uiDefName, IControlFactory controlFactory, GroupControlCreator creator ) : System	Constructs the DefaultBOEditorFormWin class with the specified businessObject, uiDefName and post edit action.
DefaultBOEditorFormWin ( BusinessObject bo, string uiDefName, IControlFactory controlFactory, PostObjectEditDelegate action ) : System	Constructs the DefaultBOEditorFormWin class with the specified BusinessObject, uiDefName, IControlFactory and post edit action.

Protected Methods

Method	Description
CancelButtonHandler ( object sender, EventArgs e ) : void	A handler to respond when the "Cancel" button has been pressed. Any unsaved edits are cancelled and the dialog is closed.
CreateLayout ( ) : void	Sets all the controls up in a layout manager. By default uses the border layout manager with the editor control centre and the buttons south.
CreateSaveTransaction ( ) : ITransactionCommitter	Creates a transaction Committer with the Business Object added.
OkButtonHandler ( object sender, EventArgs e ) : void	A handler to respond when the "OK" button has been pressed. All changes are committed to the database and the dialog is closed.
SetupFormSize ( IUIForm def ) : void	Sets up the forms size based on the BOPanel and the Buttons.

Private Methods

Method	Description
CancelEditsToBusinessObject ( ) : bool
FocusOnFirstControl ( ) : void
IDefaultBOEditorForm ( ) : bool	Pops the form up in a modal dialog. If the BO is successfully edited and saved, returns true, else returns false.
OnFormClosing ( object sender, FormClosingEventArgs e ) : void
SafeCloseForm ( ) : void

Method Details

CancelButtonHandler() protected method

A handler to respond when the "Cancel" button has been pressed. Any unsaved edits are cancelled and the dialog is closed.

protected CancelButtonHandler ( object sender, EventArgs e ) : void
sender	object	The object that notified of the event
e	System.EventArgs	Attached arguments regarding the event
return	void

CreateLayout() protected method

Sets all the controls up in a layout manager. By default uses the border layout manager with the editor control centre and the buttons south.

protected CreateLayout ( ) : void
return	void

CreateSaveTransaction() protected method

Creates a transaction Committer with the Business Object added.

protected CreateSaveTransaction ( ) : ITransactionCommitter
return	ITransactionCommitter

DefaultBOEditorFormWin() public method

Constructs the DefaultBOEditorFormWin class with the specified BusinessObject, uiDefName and IControlFactory.

public DefaultBOEditorFormWin ( BusinessObject bo, string uiDefName, IControlFactory controlFactory ) : System
bo	BusinessObject	The business object to represent
uiDefName	string	The name of the ui def to use.
controlFactory	IControlFactory	The to use for creating the Editor form controls
return	System

DefaultBOEditorFormWin() public method

Constructs the DefaultBOEditorFormWin class with the specified businessObject, uiDefName and post edit action.

public DefaultBOEditorFormWin ( BusinessObject bo, string uiDefName, IControlFactory controlFactory, GroupControlCreator creator ) : System
bo	BusinessObject	The business object to represent
uiDefName	string	The name of the ui def to use.
controlFactory	IControlFactory	The to use for creating the Editor form controls
creator	GroupControlCreator	The Creator used to Create the Group Control.
return	System

DefaultBOEditorFormWin() public method

Constructs the DefaultBOEditorFormWin class with the specified BusinessObject, uiDefName, IControlFactory and post edit action.

public DefaultBOEditorFormWin ( BusinessObject bo, string uiDefName, IControlFactory controlFactory, PostObjectEditDelegate action ) : System
bo	BusinessObject	The business object to represent
uiDefName	string	The name of the ui def to use.
controlFactory	IControlFactory	The to use for creating the Editor form controls
action	PostObjectEditDelegate	Action to be performed when the editing is completed or cancelled. Typically used if you want to update /// a grid or a list in an asynchronous environment (E.g. to select the recently edited item in the grid).
return	System

OkButtonHandler() protected method

A handler to respond when the "OK" button has been pressed. All changes are committed to the database and the dialog is closed.

protected OkButtonHandler ( object sender, EventArgs e ) : void
sender	object	The object that notified of the event
e	System.EventArgs	Attached arguments regarding the event
return	void

SetupFormSize() protected method

Sets up the forms size based on the BOPanel and the Buttons.

protected SetupFormSize ( IUIForm def ) : void
def	IUIForm
return	void