log4javascript 1.4 Lite manual
Contents
- Introduction
- log4javascript static properties/methods
- Levels
- Loggers
- Enabling / disabling log4javascript Lite
Introduction
log4javascript Lite is designed to be a basic, lightweight, cross-browser logging tool. It provides functions to log messages of different severity to a pop-up window using the exactly the same syntax as log4javascript. It is designed for situations when the key requirement is just to display logging messages without needing all the features of the standard version of log4javascript.
Below is the complete list of functions and properties available in log4javascript Lite. They make up a small subset of those provided by the standard version of log4javascript. Each function is named and called identically to the equivalent function in log4javascript. Please refer to the log4javascript manual for a detailed explanation of all the concepts alluded to in this document.
log4javascript static properties/methods
Properties
- 
							versionThe version number of your copy of log4javascript.
- 
							editionThe edition of your copy of log4javascript ("log4javascript_lite" in this case").
Methods
- 
							getDefaultLoggerLogger getDefaultLogger()Returns the default and only logger (apart from the null logger). The default logger logs to a simple pop-up window.
- 
							getNullLoggerLogger getNullLogger()Returns an empty logger. Useful for disabling all logging.
- 
							setEnabledvoid setEnabled(Boolean enabled)Parameters:- 
									enabled
 Enables or disables all logging, depending onenabled.
- 
									
- 
							isEnabledBoolean isEnabled()Returns true or false depending on whether logging is enabled.
- 
							setShowStackTracesvoid setShowStackTraces(Boolean show)Parameters:- 
									show
 Enables or disables displaying of error stack traces, depending onshow. By default, stack traces are not displayed. (Only works in Firefox)
- 
									
Levels
						Levels are available as static properties of the log4javascript.Level
						object. In ascending order of severity:
					
- log4javascript.Level.ALL
- log4javascript.Level.TRACE
- log4javascript.Level.DEBUG
- log4javascript.Level.INFO
- log4javascript.Level.WARN
- log4javascript.Level.ERROR
- log4javascript.Level.FATAL
- log4javascript.Level.NONE
Loggers
						There are only two loggers in log4javascript Lite: the default logger obtained
						by calling log4javascript.getDefaultLogger() and the empty logger
						returned by log4javascript.getNullLogger().
					
Logger methods
- 
							setLevelvoid setLevel(Level level)Parameters:- 
									level
 Sets the level. Log messages of a lower level thanlevelwill not be logged. Default value isALL(unlike in log4javascript, where the default level isDEBUG).
- 
									
- 
							getLevelLevel getLevel()Returns the level for this logger.
- 
							tracevoid trace(Object message1[, Object message2, ... ][, Error exception])Parameters:- 
									message1[, message2...]
- 
									exception[optional]
 Logs one or more messages and optionally an error at levelTRACE.
- 
									
- 
							debugvoid debug(Object message1[, Object message2, ... ][, Error exception])Parameters:- 
									message1[, message2...]
- 
									exception[optional]
 Logs one or more messages and optionally an error at levelDEBUG.
- 
									
- 
							infovoid info(Object message1[, Object message2, ... ][, Error exception])Parameters:- 
									message1[, message2...]
- 
									exception[optional]
 Logs one or more messages and optionally an error at levelINFO.
- 
									
- 
							warnvoid warn(Object message1[, Object message2, ... ][, Error exception])Parameters:- 
									message1[, message2...]
- 
									exception[optional]
 Logs one or more messages and optionally an error at levelWARN.
- 
									
- 
							errorvoid error(Object message1[, Object message2, ... ][, Error exception])Parameters:- 
									message1[, message2...]
- 
									exception[optional]
 Logs one or more messages and optionally an error at levelERROR.
- 
									
- 
							fatalvoid fatal(Object message1[, Object message2, ... ][, Error exception])Parameters:- 
									message1[, message2...]
- 
									exception[optional]
 Logs one or more messages and optionally an error at levelFATAL.
- 
									
- 
							isEnabledForBoolean isEnabledFor(Level level, Error exception)Parameters:- 
									level
 Returns whether the logger is enabled for the specified level.
- 
									
- 
							isTraceEnabledBoolean isTraceEnabled()Returns whether the logger is enabled forTRACEmessages.
- 
							isDebugEnabledBoolean isDebugEnabled()Returns whether the logger is enabled forDEBUGmessages.
- 
							isInfoEnabledBoolean isInfoEnabled()Returns whether the logger is enabled forINFOmessages.
- 
							isWarnEnabledBoolean isWarnEnabled()Returns whether the logger is enabled forWARNmessages.
- 
							isErrorEnabledBoolean isErrorEnabled()Returns whether the logger is enabled forERRORmessages.
- 
							isFatalEnabledBoolean isFatalEnabled()Returns whether the logger is enabled forFATALmessages.
Enabling / disabling log4javascript Lite
All logging can be enabled or disabled in log4javascript Lite in a number of ways:
- 
							At any time, you can call
							log4javascript.setEnabled(enabled). This will enable or disable all logging, depending on whetherenabledis set totrueorfalse.
- 
							Assign your logger object a value of log4javascript.getNullLogger().
- Replace your copy of log4javascript_lite.js with stubs/log4javascript_lite.js, provided in the distribution. This file has a stub version of each of the functions and methods in the log4javascript Lite API and can simply be dropped in in place of the main file.