com.japisoft.framework
Class ApplicationModel

java.lang.Object
  com.japisoft.framework.ApplicationModel

public class ApplicationModel

extends java.lang.Object

This is a global reference part. All the main elements of the application are stored here like the application properties or the application steps.

Version:

1.0

Author:

(c) 2004-2006 JAPISoft / http://www.japisoft.com

Field Summary

static java.lang.String	APP_IMG_PATH Path (classpath) for an application logo image
static java.lang.String	AUTODOC_FILE File for generating a documentation
static int	BETA_VERSION A Beta version number
static java.lang.String	BUILD A build version
static java.lang.String	DEBUG_AUTODOC_FILE Temporary path for storing the generated documentation
static boolean	DEBUG_MODE Debug mode.
static java.lang.String	DEF_MANUAL_PATH Manual path
static InterfaceBuilder	INTERFACE_BUILDER The object that builds all the menus, popup and toolbar
static java.lang.String	LONG_APPNAME The application full name
static boolean	MACOSX_MODE Flag to know if it running under mac os x
static javax.swing.JFrame	MAIN_FRAME The main application frame
static java.lang.String	MAIN_SUPPORT_EMAIL Main contact for email support
static int	MAJOR_VERSION A major version number
static int	MINOR_VERSION A Minor version number
static java.lang.String	REGISTERED_FILE Registered file name
static java.lang.String	REPORTING_URL URL for reporting a problem
static java.lang.String	SHORT_APPNAME A short application name.
static int	SUBMINOR_VERSION A Sub minor version number
static java.lang.String	USERINTERFACE_FILE Main application descriptor

Constructor Summary

ApplicationModel()

Method Summary

static void	addApplicationStep(ApplicationStep step) Add a new application step
static void	addApplicationStep(ApplicationStep step, int index) Add a new application step at this location (starting from 0)
static void	debug(java.lang.String message) Show this message only in a debug mode
static void	debug(java.lang.Throwable th) Show this stacktrace only in a debug mode
static ApplicationStep	getApplicationStepAt(int index)
static int	getApplicationStepCount()
static java.lang.String	getAppNameVersion()
static java.io.File	getAppUserPath()
static java.lang.String	getAppVersion()
static java.lang.String	getCurrentFileEncoding()
static java.lang.Object	getSharedProperty(java.lang.String key)
static void	removeApplicationStep(ApplicationStep step) Remove an application step
static void	setSharedProperty(java.lang.String key, java.lang.Object value) Stored a value available anywhere inside the application parts
static void	starting() Console message while starting the application

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LONG_APPNAME

public static java.lang.String LONG_APPNAME

The application full name

SHORT_APPNAME

public static java.lang.String SHORT_APPNAME

A short application name. This is used for the user home directory name

BUILD

public static java.lang.String BUILD

A build version

MAJOR_VERSION

public static int MAJOR_VERSION

A major version number

MINOR_VERSION

public static int MINOR_VERSION

A Minor version number

SUBMINOR_VERSION

public static int SUBMINOR_VERSION

A Sub minor version number

BETA_VERSION

public static int BETA_VERSION

A Beta version number

MAIN_SUPPORT_EMAIL

public static java.lang.String MAIN_SUPPORT_EMAIL

Main contact for email support

REGISTERED_FILE

public static java.lang.String REGISTERED_FILE

Registered file name

REPORTING_URL

public static java.lang.String REPORTING_URL

URL for reporting a problem

USERINTERFACE_FILE

public static java.lang.String USERINTERFACE_FILE

Main application descriptor

AUTODOC_FILE

public static java.lang.String AUTODOC_FILE

File for generating a documentation

APP_IMG_PATH

public static java.lang.String APP_IMG_PATH

Path (classpath) for an application logo image

DEF_MANUAL_PATH

public static java.lang.String DEF_MANUAL_PATH

Manual path

MACOSX_MODE

public static boolean MACOSX_MODE

Flag to know if it running under mac os x

DEBUG_MODE

public static boolean DEBUG_MODE

Debug mode. Bound to the system property 'application.debug'

DEBUG_AUTODOC_FILE

public static java.lang.String DEBUG_AUTODOC_FILE

Temporary path for storing the generated documentation

MAIN_FRAME

public static javax.swing.JFrame MAIN_FRAME

The main application frame

INTERFACE_BUILDER

public static InterfaceBuilder INTERFACE_BUILDER

The object that builds all the menus, popup and toolbar

Constructor Detail

ApplicationModel

public ApplicationModel()

Method Detail

getAppUserPath

public static java.io.File getAppUserPath()

Returns:

the user directory for this application. Useful for storing personal data

getAppNameVersion

public static java.lang.String getAppNameVersion()

Returns:

a complete application name + version

getAppVersion

public static java.lang.String getAppVersion()

Returns:

a complete application version

starting

public static void starting()

Console message while starting the application

getCurrentFileEncoding

public static java.lang.String getCurrentFileEncoding()

debug

public static void debug(java.lang.String message)

Show this message only in a debug mode

debug

public static void debug(java.lang.Throwable th)

Show this stacktrace only in a debug mode

setSharedProperty

public static void setSharedProperty(java.lang.String key,
                                     java.lang.Object value)

Stored a value available anywhere inside the application parts

getSharedProperty

public static java.lang.Object getSharedProperty(java.lang.String key)

Returns:

a value available anywhere inside the application parts

addApplicationStep

public static void addApplicationStep(ApplicationStep step)

Add a new application step

addApplicationStep

public static void addApplicationStep(ApplicationStep step,
                                      int index)

Add a new application step at this location (starting from 0)

removeApplicationStep

public static void removeApplicationStep(ApplicationStep step)

Remove an application step

getApplicationStepCount

public static int getApplicationStepCount()

Returns:

the number of application step

getApplicationStepAt

public static ApplicationStep getApplicationStepAt(int index)

Returns:

the following application, the index starts from 0