Log4j 1.3alpha0

org.apache.log4j
Class HTMLLayout

java.lang.Object
  |
  +--org.apache.log4j.Layout
        |
        +--org.apache.log4j.HTMLLayout
All Implemented Interfaces:
OptionHandler

Deprecated. HTMLLayout is replaced by the much more flexible org.apache.log4j.html.HTMLLayout.

public class HTMLLayout
extends Layout

This layout outputs events in a HTML table.

Author:
Ceki Gülcü

Field Summary
protected static int BUF_SIZE
          Deprecated.  
static java.lang.String LOCATION_INFO_OPTION
          Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
protected static int MAX_CAPACITY
          Deprecated.  
static java.lang.String TITLE_OPTION
          Deprecated. A string constant used in naming the option for setting the the HTML document title.
 
Fields inherited from class org.apache.log4j.Layout
charArrayWriter, ignoresThrowable, LINE_SEP, LINE_SEP_LEN
 
Constructor Summary
HTMLLayout()
          Deprecated. Default constructor.
 
Method Summary
 void activateOptions()
          Deprecated. No options to activate.
 void format(java.io.Writer output, LoggingEvent event)
          Deprecated.  
 java.lang.String getContentType()
          Deprecated. Returns the content type output by this layout, i.e "text/html".
 java.lang.String getFooter()
          Deprecated. Returns the appropriate HTML footers.
 java.lang.String getHeader()
          Deprecated. Returns appropriate HTML headers.
 boolean getLocationInfo()
          Deprecated. Returns the current value of the LocationInfo option.
 java.lang.String getTitle()
          Deprecated. Returns the current value of the Title option.
 void setLocationInfo(boolean flag)
          Deprecated. The LocationInfo option takes a boolean value.
 void setTitle(java.lang.String title)
          Deprecated. The Title option takes a String value.
 
Methods inherited from class org.apache.log4j.Layout
format, ignoresThrowable, setFooter, setHeader, setIgnoresThrowable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOCATION_INFO_OPTION

public static final java.lang.String LOCATION_INFO_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.

A string constant used in naming the option for setting the the location information flag. Current value of this string constant is LocationInfo .

Note that all option keys are case sensitive.

See Also:
Constant Field Values

TITLE_OPTION

public static final java.lang.String TITLE_OPTION
Deprecated. 
A string constant used in naming the option for setting the the HTML document title. Current value of this string constant is Title .

See Also:
Constant Field Values

BUF_SIZE

protected static final int BUF_SIZE
Deprecated. 
See Also:
Constant Field Values

MAX_CAPACITY

protected static final int MAX_CAPACITY
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

HTMLLayout

public HTMLLayout()
Deprecated. 
Default constructor.

Since:
1.3
Method Detail

setLocationInfo

public void setLocationInfo(boolean flag)
Deprecated. 
The LocationInfo option takes a boolean value. By default, it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.

If you are embedding this layout within an SMTPAppender then make sure to set the LocationInfo option of that appender as well.


getLocationInfo

public boolean getLocationInfo()
Deprecated. 
Returns the current value of the LocationInfo option.


setTitle

public void setTitle(java.lang.String title)
Deprecated. 
The Title option takes a String value. This option sets the document title of the generated HTML document.

Defaults to 'Log4J Log Messages'.


getTitle

public java.lang.String getTitle()
Deprecated. 
Returns the current value of the Title option.


getContentType

public java.lang.String getContentType()
Deprecated. 
Returns the content type output by this layout, i.e "text/html".

Overrides:
getContentType in class Layout

activateOptions

public void activateOptions()
Deprecated. 
No options to activate.


format

public void format(java.io.Writer output,
                   LoggingEvent event)
            throws java.io.IOException
Deprecated. 
Specified by:
format in class Layout
java.io.IOException

getHeader

public java.lang.String getHeader()
Deprecated. 
Returns appropriate HTML headers.

Overrides:
getHeader in class Layout

getFooter

public java.lang.String getFooter()
Deprecated. 
Returns the appropriate HTML footers.

Overrides:
getFooter in class Layout

Log4j 1.3alpha0

Copyright 2000-2003 Apache Software Foundation.