C# Class Habanero.Faces.Base.HabaneroAppUI

Provides a template for a standard Habanero application, including standard fields and initialisations. Specific details covered are:
  • The class definitions that define how the data is represented and limited
  • The database configuration, connection and settings
  • A logger to record debugging and error messages
  • An exception notifier to communicate exceptions to the user
  • Automatic version upgrades when an application is out-of-date
  • A synchronisation controller
  • A control factory to create controls
  • A data accessor that specifies what type of data source is used (DB by default)
To set up and launch an application:
  1. Instantiate the application with the constructor
  2. Specify any individual settings as required
  3. Call the Startup() method to launch the application
Inheritance: Habanero.Base.HabaneroApp
Show file Open project: Chillisoft/habanero.faces

Protected Properties

Property Type Description
_privateKey string

Public Methods

Method Description
SetPrivateKey ( string xmlPrivateKey ) : void

Sets the private key used to decrypt the database password. If your database password as supplied is in plaintext then this is not necessary. If you supply the DatabaseConfig object you can also set the private key on that instead.
Startup ( ) : bool

Protected Methods

Method Description
HabaneroAppUI ( string appName, string appVersion ) : System

Constructor to initialise a new application with basic application information. Use the Startup() method to launch the application.
SetupClassDefs ( ) : void

Loads the class definitions
SetupControlFactory ( ) : void

Sets the control factory used to create controls
SetupDateDisplaySettings ( ) : void

Sets up the class that stores the date display settings
SetupUISettings ( ) : void

Sets up the class that stores the user interface settings

Private Methods

Method Description
GetXmlClassDefsLoader ( ) : Habanero.BO.Loaders.XmlClassDefsLoader

Gets the loader for the xml class definitions
LogAppStartingInfo ( IHabaneroLogger log ) : void
SetupHabaneroAppUI ( ) : void

Method Details

HabaneroAppUI() protected method

Constructor to initialise a new application with basic application information. Use the Startup() method to launch the application.
protected HabaneroAppUI ( string appName, string appVersion ) : System
appName string The application name
appVersion string The application version
return System

SetPrivateKey() public method

Sets the private key used to decrypt the database password. If your database password as supplied is in plaintext then this is not necessary. If you supply the DatabaseConfig object you can also set the private key on that instead.
public SetPrivateKey ( string xmlPrivateKey ) : void
xmlPrivateKey string The private key (RSA) in xml format
return void

SetupClassDefs() protected method

Loads the class definitions
protected SetupClassDefs ( ) : void
return void

SetupControlFactory() protected abstract method

Sets the control factory used to create controls
protected abstract SetupControlFactory ( ) : void
return void

SetupDateDisplaySettings() protected method

Sets up the class that stores the date display settings
protected SetupDateDisplaySettings ( ) : void
return void

SetupUISettings() protected method

Sets up the class that stores the user interface settings
protected SetupUISettings ( ) : void
return void

Startup() public method

public Startup ( ) : bool
return bool

Property Details

_privateKey protected property

The application's private key
protected string _privateKey
return string