Package 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 and Save INI Settings from property file Initiated in Adempiere.startup Settings activated in ALogin.getIni- Version:
- $Id$
- Author:
- Jorg Janke, Teo Sarca, www.arhipac.ro
- FR [ 1658127 ] Select charset encoding on import
- FR [ 2406123 ] Ini.saveProperties fails if target directory does not exist
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_LOAD_TAB_META_DATA_BGstatic booleanDEFAULT_OPEN_WINDOW_MAXIMIZEDstatic booleanDEFAULT_SINGLE_INSTANCE_PER_WINDOWstatic StringENV_PREFIXSystem environment prefixstatic StringIDEMPIERE_HOMESystem Property Value of IDEMPIERE_HOMEstatic StringIDEMPIERE_PROPERTY_FILEProperty file namestatic StringP_A_COMMITAuto Savestatic StringP_A_LOGINAuto Loginstatic StringP_A_NEWAuto New Recordstatic StringP_ADEMPIERESYSDictionary Maintenancestatic StringP_CACHE_WINDOWCache Windowsstatic StringP_CHARSETCharsetstatic StringP_CLIENTClient Namestatic StringP_CONNECTIONConnection Detailsstatic StringP_CONTEXTData Sourcestatic StringP_INIIni File Namestatic StringP_LANGUAGELanguagestatic StringP_LOAD_TAB_META_DATA_BGLoad tab fields meta data using background threadstatic StringP_LOGMIGRATIONSCRIPTLog Migration Scriptstatic StringP_OPEN_WINDOW_MAXIMIZEDOpen new windows as maximizedstatic StringP_ORGOrg Namestatic StringP_PRINTERPrinter Namestatic StringP_PRINTPREVIEWPrint Previewstatic StringP_PWDApps Passwordstatic StringP_ROLERolestatic StringP_SHOW_ACCTShow Acct Tabsstatic StringP_SHOW_TRLShow Translation Tabsstatic StringP_SINGLE_INSTANCE_PER_WINDOWSingle instance per window idstatic StringP_STORE_PWDStore Passwordstatic StringP_TEMP_DIRTemp Directorystatic StringP_TODAYCurrent Datestatic StringP_TRACEFILETrace to Filestatic StringP_TRACELEVELTrace Levelstatic StringP_UI_LOOKLook and Feelstatic StringP_UI_THEMEUI Themestatic StringP_UIDApps User IDstatic StringP_VALIDATE_CONNECTION_ON_STARTUPValidate connection on startupstatic StringP_WAREHOUSEWarehouse Name
-
Constructor Summary
Constructors Constructor Description Ini()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static voiddeletePropertyFile()Delete Property filestatic StringfindAdempiereHome()Find Idempiere Homestatic StringgetAdempiereHome()Get Idempiere Home from Environmentstatic StringgetAsString()toStringstatic Charset[]getAvailableCharsets()Get Available Encoding Charsetsstatic CharsetgetCharset()Get current charsetstatic intgetDividerLocation()Get Divider Locationstatic StringgetFileName(boolean tryUserHome)Return File Name of INI filestatic PropertiesgetProperties()Get Propertiesstatic StringgetProperty(String key)Get Propertystatic StringgetPropertyFileName()static StringgetVar(String secretVar)static DimensiongetWindowDimension(int AD_Window_ID)Get Window Dimensionstatic PointgetWindowLocation(int AD_Window_ID)Get Window Locationstatic booleanisCacheWindow()Cache Windowsstatic booleanisClient()Are we in Client Mode ?static booleanisLoaded()Are the properties loaded?static booleanisPropertyBool(String key)Get Property as Booleanstatic booleanisShowLicenseDialog()Is show license dialog for new setupstatic voidloadProperties(boolean reload)Load INI parameters from diskstatic booleanloadProperties(String filename)Load INI parameters from filename.static StringrunCommand(String[] command)static voidsaveProperties(boolean tryUserHome)Save INI parameters to diskstatic voidsetAdempiereHome(String idempiereHome)Set Idempiere Homestatic voidsetClient(boolean client)Set Client Modestatic voidsetDividerLocation(int dividerLocation)Set Divider Locationstatic voidsetProperty(String key, boolean value)Set Propertystatic voidsetProperty(String key, int value)Set Propertystatic voidsetProperty(String key, String value)Set Propertystatic voidsetShowLicenseDialog(boolean b)Set show license dialog for new setupstatic voidsetVar(String secretVar, String secretValue)static voidsetWindowDimension(int AD_Window_ID, Dimension windowDimension)Set Window Dimensionstatic voidsetWindowLocation(int AD_Window_ID, Point windowLocation)Set Window Location
-
-
-
Field Detail
-
IDEMPIERE_PROPERTY_FILE
public static final String IDEMPIERE_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 and Feel- See Also:
- Constant Field Values
-
P_UI_THEME
public static final String P_UI_THEME
UI Theme- See Also:
- Constant Field Values
-
P_A_COMMIT
public static final String P_A_COMMIT
Auto Save- 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_ADEMPIERESYS
public static final String P_ADEMPIERESYS
Dictionary Maintenance- See Also:
- Constant Field Values
-
P_LOGMIGRATIONSCRIPT
public static final String P_LOGMIGRATIONSCRIPT
Log Migration Script- See Also:
- Constant Field Values
-
P_SHOW_ACCT
public static final String P_SHOW_ACCT
Show Acct Tabs- See Also:
- Constant Field Values
-
P_SHOW_TRL
public static final String P_SHOW_TRL
Show Translation Tabs- 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_PRINTER
public static final String P_PRINTER
Printer 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_VALIDATE_CONNECTION_ON_STARTUP
public static final String P_VALIDATE_CONNECTION_ON_STARTUP
Validate connection on startup- See Also:
- Constant Field Values
-
P_SINGLE_INSTANCE_PER_WINDOW
public static final String P_SINGLE_INSTANCE_PER_WINDOW
Single instance per window id- See Also:
- Constant Field Values
-
DEFAULT_SINGLE_INSTANCE_PER_WINDOW
public static final boolean DEFAULT_SINGLE_INSTANCE_PER_WINDOW
- See Also:
- Constant Field Values
-
P_OPEN_WINDOW_MAXIMIZED
public static final String P_OPEN_WINDOW_MAXIMIZED
Open new windows as maximized- See Also:
- Constant Field Values
-
DEFAULT_OPEN_WINDOW_MAXIMIZED
public static final boolean DEFAULT_OPEN_WINDOW_MAXIMIZED
- See Also:
- Constant Field Values
-
P_CHARSET
public static final String P_CHARSET
Charset- See Also:
- Constant Field Values
-
P_LOAD_TAB_META_DATA_BG
public static final String P_LOAD_TAB_META_DATA_BG
Load tab fields meta data using background thread- See Also:
- Constant Field Values
-
DEFAULT_LOAD_TAB_META_DATA_BG
public static final String DEFAULT_LOAD_TAB_META_DATA_BG
- See Also:
- Constant Field Values
-
ENV_PREFIX
public static final String ENV_PREFIX
System environment prefix- See Also:
- Constant Field Values
-
IDEMPIERE_HOME
public static final String IDEMPIERE_HOME
System Property Value of IDEMPIERE_HOME- See Also:
- Constant Field Values
-
-
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
-
getFileName
public static String getFileName(boolean tryUserHome)
Return File Name of INI fileExamples: C:\WinNT\Profiles\jjanke\idempiere.properties D:\idempiere\idempiere.properties idempiere.propertiesCan be overwritten by -DPropertyFile=myFile allowing multiple configurations / property files.- Parameters:
tryUserHome- get user home first- Returns:
- file name
-
setProperty
public static void setProperty(String key, String value)
Set Property- Parameters:
key- Keyvalue- Value
-
setProperty
public static void setProperty(String key, boolean value)
Set Property- Parameters:
key- Keyvalue- Value
-
setProperty
public static void setProperty(String key, int value)
Set Property- Parameters:
key- Keyvalue- Value
-
getProperty
public static String getProperty(String key)
Get Property- Parameters:
key- Key- Returns:
- Value
-
isPropertyBool
public static boolean isPropertyBool(String key)
Get Property 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
-
setShowLicenseDialog
public static void setShowLicenseDialog(boolean b)
Set show license dialog for new setup- Parameters:
b-
-
isShowLicenseDialog
public static boolean isShowLicenseDialog()
Is show license dialog for new setup- Returns:
- boolean
-
isLoaded
public static boolean isLoaded()
Are the properties loaded?- Returns:
- true if properties loaded.
-
getAdempiereHome
public static String getAdempiereHome()
Get Idempiere Home from Environment- Returns:
- idempiereHome or null
-
setAdempiereHome
public static void setAdempiereHome(String idempiereHome)
Set Idempiere Home- Parameters:
idempiereHome- IDEMPIERE_HOME
-
findAdempiereHome
public static String findAdempiereHome()
Find Idempiere Home- Returns:
- idempiere 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- windowwindowDimension- 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- windowwindowLocation- 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
-
getAvailableCharsets
public static Charset[] getAvailableCharsets()
Get Available Encoding Charsets- Returns:
- array of available encoding charsets
- Since:
- 3.1.4
-
getCharset
public static Charset getCharset()
Get current charset- Returns:
- current charset
- Since:
- 3.1.4
-
getPropertyFileName
public static String getPropertyFileName()
-
-