org.compiere.util
Class Ini

java.lang.Object
  org.compiere.util.Ini

All Implemented Interfaces:

Serializable

public final class Ini
extends Object
implements Serializable

Load & Save INI Settings from property file Initiated in Compiere.startup Settings activated in ALogin.getIni

Version:

$Id$

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

static String	COMPIERE_HOME System Property Value of COMPIERE_HOME
static String	COMPIERE_PROPERTY_FILE Property file name
static String	ENV_PREFIX System environment prefix
static String	P_A_LOGIN Auto Login
static String	P_A_NEW Auto New Record
static String	P_CACHE_WINDOW Cache Windows
static String	P_CLIENT Client Name
static String	P_COMPIERESYS Dictonary Maintennace
static String	P_CONNECTION Connection Details
static String	P_CONTEXT Data Source
static String	P_INI Ini File Name
static String	P_LANGUAGE Language
static String	P_ORG Org Name
static String	P_PRINTPREVIEW Print Preview
static String	P_PWD Apps Password
static String	P_ROLE Role
static String	P_STORE_PWD Store Password
static String	P_TEMP_DIR Temp Directory
static String	P_TODAY Current Date
static String	P_TRACEFILE Trace to File
static String	P_TRACELEVEL Trace Level
static String	P_UI_FLAT Flat Color UI
static String	P_UI_LOOK Look & Feel
static String	P_UI_THEME UI Theme
static String	P_UID Apps User ID
static String	P_WAREHOUSE Warehouse Name
static String	P_WEB_SESSION_EXPIRATION Web Session exp

Constructor Summary

Ini()

Method Summary

static void	deletePropertyFile() Delete Property file
static String	findCompiereHome() Find Compiere Home
static String	getAsString() toString
static String	getCompiereHome() Get Compiere Home from Environment
static int	getDividerLocation() Get Divider Location
static Properties	getProperties() Get Properties
static String	getProperty(String key) Get Propery
static Dimension	getWindowDimension(int AD_Window_ID) Get Window Dimension
static Point	getWindowLocation(int AD_Window_ID) Get Window Location
static boolean	isCacheWindow() Cache Windows
static boolean	isClient() Are we in Client Mode ?
static boolean	isLoaded() Are the properties loaded?
static boolean	isPropertyBool(String key) Get Propery as Boolean
static void	loadProperties(boolean reload) Load INI parameters from disk
static boolean	loadProperties(String filename) Load INI parameters from filename.
static void	saveProperties(boolean tryUserHome) Save INI parameters to disk
static void	setClient(boolean client) Set Client Mode
static void	setCompiereHome(String CompiereHome) Set Compiere Home
static void	setDividerLocation(int dividerLocation) Set Divider Location
static void	setProperty(String key, boolean value) Set Property
static void	setProperty(String key, int value) Set Property
static void	setProperty(String key, String value) Set Property
static void	setWindowDimension(int AD_Window_ID, Dimension windowDimension) Set Window Dimension
static void	setWindowLocation(int AD_Window_ID, Point windowLocation) Set Window Location

Methods inherited from class java.lang.Object

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

Field Detail

COMPIERE_PROPERTY_FILE

public static final String COMPIERE_PROPERTY_FILE

Property file name

See Also:

Constant Field Values

P_UID

public static final String P_UID

Apps User ID

See Also:

Constant Field Values

P_PWD

public static final String P_PWD

Apps Password

See Also:

Constant Field Values

P_STORE_PWD

public static final String P_STORE_PWD

Store Password

See Also:

Constant Field Values

P_TRACELEVEL

public static final String P_TRACELEVEL

Trace Level

See Also:

Constant Field Values

P_TRACEFILE

public static final String P_TRACEFILE

Trace to File

See Also:

Constant Field Values

P_LANGUAGE

public static final String P_LANGUAGE

Language

See Also:

Constant Field Values

P_INI

public static final String P_INI

Ini File Name

See Also:

Constant Field Values

P_CONNECTION

public static final String P_CONNECTION

Connection Details

See Also:

Constant Field Values

P_CONTEXT

public static final String P_CONTEXT

Data Source

See Also:

Constant Field Values

P_UI_LOOK

public static final String P_UI_LOOK

Look & Feel

See Also:

Constant Field Values

P_UI_THEME

public static final String P_UI_THEME

UI Theme

See Also:

Constant Field Values

P_UI_FLAT

public static final String P_UI_FLAT

Flat Color UI

See Also:

Constant Field Values

P_A_LOGIN

public static final String P_A_LOGIN

Auto Login

See Also:

Constant Field Values

P_A_NEW

public static final String P_A_NEW

Auto New Record

See Also:

Constant Field Values

P_COMPIERESYS

public static final String P_COMPIERESYS

Dictonary Maintennace

See Also:

Constant Field Values

P_CACHE_WINDOW

public static final String P_CACHE_WINDOW

Cache Windows

See Also:

Constant Field Values

P_TEMP_DIR

public static final String P_TEMP_DIR

Temp Directory

See Also:

Constant Field Values

P_ROLE

public static final String P_ROLE

Role

See Also:

Constant Field Values

P_CLIENT

public static final String P_CLIENT

Client Name

See Also:

Constant Field Values

P_ORG

public static final String P_ORG

Org Name

See Also:

Constant Field Values

P_WAREHOUSE

public static final String P_WAREHOUSE

Warehouse Name

See Also:

Constant Field Values

P_TODAY

public static final String P_TODAY

Current Date

See Also:

Constant Field Values

P_PRINTPREVIEW

public static final String P_PRINTPREVIEW

Print Preview

See Also:

Constant Field Values

P_WEB_SESSION_EXPIRATION

public static final String P_WEB_SESSION_EXPIRATION

Web Session exp

See Also:

Constant Field Values

ENV_PREFIX

public static final String ENV_PREFIX

System environment prefix

See Also:

Constant Field Values

COMPIERE_HOME

public static final String COMPIERE_HOME

System Property Value of COMPIERE_HOME

See Also:

Constant Field Values

Constructor Detail

Ini

public Ini()

Method Detail

saveProperties

public static void saveProperties(boolean tryUserHome)

Save INI parameters to disk

Parameters:

tryUserHome - get user home first

loadProperties

public static void loadProperties(boolean reload)

Load INI parameters from disk

Parameters:

reload - reload

loadProperties

public static boolean loadProperties(String filename)

Load INI parameters from filename. Logger is on default level (INFO)

Parameters:

filename - to load

Returns:

true if first time

deletePropertyFile

public static void deletePropertyFile()

Delete Property file

setProperty

public static void setProperty(String key,
                               String value)

Set Property

Parameters:

key - Key

value - Value

setProperty

public static void setProperty(String key,
                               boolean value)

Set Property

Parameters:

key - Key

value - Value

setProperty

public static void setProperty(String key,
                               int value)

Set Property

Parameters:

key - Key

value - Value

getProperty

public static String getProperty(String key)

Get Propery

Parameters:

key - Key

Returns:

Value

isPropertyBool

public static boolean isPropertyBool(String key)

Get Propery as Boolean

Parameters:

key - Key

Returns:

Value

isCacheWindow

public static boolean isCacheWindow()

Cache Windows

Returns:

true if windows are cached

getProperties

public static Properties getProperties()

Get Properties

Returns:

Ini properties

getAsString

public static String getAsString()

toString

Returns:

String representation

isClient

public static boolean isClient()

Are we in Client Mode ?

Returns:

true if client

setClient

public static void setClient(boolean client)

Set Client Mode

Parameters:

client - client

isLoaded

public static boolean isLoaded()

Are the properties loaded?

Returns:

true if properties loaded.

getCompiereHome

public static String getCompiereHome()

Get Compiere Home from Environment

Returns:

CompiereHome or null

setCompiereHome

public static void setCompiereHome(String CompiereHome)

Set Compiere Home

Parameters:

CompiereHome - COMPIERE_HOME

findCompiereHome

public static String findCompiereHome()

Find Compiere Home

Returns:

compiere home or null

getWindowDimension

public static Dimension getWindowDimension(int AD_Window_ID)

Get Window Dimension

Parameters:

AD_Window_ID - window no

Returns:

dimension or null

setWindowDimension

public static void setWindowDimension(int AD_Window_ID,
                                      Dimension windowDimension)

Set Window Dimension

Parameters:

AD_Window_ID - window

windowDimension - dimension - null to remove

getWindowLocation

public static Point getWindowLocation(int AD_Window_ID)

Get Window Location

Parameters:

AD_Window_ID - window id

Returns:

location or null

setWindowLocation

public static void setWindowLocation(int AD_Window_ID,
                                     Point windowLocation)

Set Window Location

Parameters:

AD_Window_ID - window

windowLocation - location - null to remove

getDividerLocation

public static int getDividerLocation()

Get Divider Location

Returns:

location

setDividerLocation

public static void setDividerLocation(int dividerLocation)

Set Divider Location

Parameters:

dividerLocation - location