org.pentaho.reporting.engine.classic.core.modules.output.table.html
Class HtmlTableModule

java.lang.Object
  extended by org.pentaho.reporting.libraries.base.boot.DefaultModuleInfo
      extended by org.pentaho.reporting.libraries.base.boot.AbstractModule
          extended by org.pentaho.reporting.engine.classic.core.modules.output.table.html.HtmlTableModule
All Implemented Interfaces:
org.pentaho.reporting.libraries.base.boot.Module, org.pentaho.reporting.libraries.base.boot.ModuleInfo

public class HtmlTableModule
extends org.pentaho.reporting.libraries.base.boot.AbstractModule

The module definition for the Html table export module.

Author:
Thomas Morgner

Field Summary
static String ALLOW_RAW_LINK_TARGETS
          Key for allowing raw link targets (must contain the value "true" to be considered true
static String AUTHOR
          Key for specifying the Author in the HTML header
static String BODY_FRAGMENT
          The property key to define whether to build a html body fragment.
static String COPY_EXTERNAL_IMAGES
          Key for forcing a copy of external images (must contain the value "true" to be considered true
static String EMPTY_CELLS_USE_CSS
          Key for allowing raw link targets (must contain the value "true" to be considered true
static String ENCODING
          the fileencoding for the main html file.
static String ENCODING_DEFAULT
          a default value for the fileencoding of the main html file.
static String EXTERNALIZE_STYLE
          Key for specifying that style information should be externalized instead of inline (must contain the value "true" to be considered true
static String FORCE_BUFFER_WRITING
          Key for forcing buffer writing (must contain the value "true" to be considered true
static String INLINE_STYLE
          Key for specifying that style information should be inlined instead of externalized (must contain the value "true" to be considered true
static String KEYWORDS
          Key for specifying the Keywords in the HTML header
static String PROPORTIONAL_COLUMN_WIDTHS
          Key for specifying whether columns widths should be given in percentages instead of absolute widths.
static String SUBJECT
          Key for specifying the Subject in the HTML header
static String TABLE_HTML_FLOW_EXPORT_TYPE
           
static String TABLE_HTML_PAGE_EXPORT_TYPE
           
static String TABLE_HTML_STREAM_EXPORT_TYPE
           
static String TABLE_ROW_BORDER_DEFINITION
          Key for specifying whether common borders of all cells are replicated on the table-row elements.
static String TITLE
          Key for specifying the HTML TITLE
static String USE_TABLE_LAYOUT_FIXED
           
static String ZIP_HTML_EXPORT_TYPE
           
 
Constructor Summary
HtmlTableModule()
          DefaultConstructor.
 
Method Summary
 void initialize(org.pentaho.reporting.libraries.base.boot.SubSystem subSystem)
          Initializes the module.
 
Methods inherited from class org.pentaho.reporting.libraries.base.boot.AbstractModule
configure, getDescription, getName, getOptionalModules, getProducer, getRequiredModules, getSubSystem, setOptionalModules, toString
 
Methods inherited from class org.pentaho.reporting.libraries.base.boot.DefaultModuleInfo
equals, getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel, hashCode, setMajorVersion, setMinorVersion, setModuleClass, setPatchLevel
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.pentaho.reporting.libraries.base.boot.ModuleInfo
getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel
 

Field Detail

USE_TABLE_LAYOUT_FIXED

public static final String USE_TABLE_LAYOUT_FIXED
See Also:
Constant Field Values

ENCODING

public static final String ENCODING
the fileencoding for the main html file.

See Also:
Constant Field Values

ENCODING_DEFAULT

public static final String ENCODING_DEFAULT
a default value for the fileencoding of the main html file.

See Also:
Constant Field Values

BODY_FRAGMENT

public static final String BODY_FRAGMENT
The property key to define whether to build a html body fragment.

See Also:
Constant Field Values

EMPTY_CELLS_USE_CSS

public static final String EMPTY_CELLS_USE_CSS
Key for allowing raw link targets (must contain the value "true" to be considered true

See Also:
Constant Field Values

TABLE_ROW_BORDER_DEFINITION

public static final String TABLE_ROW_BORDER_DEFINITION
Key for specifying whether common borders of all cells are replicated on the table-row elements. This prevents some layouting errors in Mozilla.

See Also:
Constant Field Values

PROPORTIONAL_COLUMN_WIDTHS

public static final String PROPORTIONAL_COLUMN_WIDTHS
Key for specifying whether columns widths should be given in percentages instead of absolute widths. This way, the generated HTML page will consume all space that is available.

See Also:
Constant Field Values

COPY_EXTERNAL_IMAGES

public static final String COPY_EXTERNAL_IMAGES
Key for forcing a copy of external images (must contain the value "true" to be considered true

See Also:
Constant Field Values

INLINE_STYLE

public static final String INLINE_STYLE
Key for specifying that style information should be inlined instead of externalized (must contain the value "true" to be considered true

See Also:
Constant Field Values

EXTERNALIZE_STYLE

public static final String EXTERNALIZE_STYLE
Key for specifying that style information should be externalized instead of inline (must contain the value "true" to be considered true

See Also:
Constant Field Values

FORCE_BUFFER_WRITING

public static final String FORCE_BUFFER_WRITING
Key for forcing buffer writing (must contain the value "true" to be considered true

See Also:
Constant Field Values

ALLOW_RAW_LINK_TARGETS

public static final String ALLOW_RAW_LINK_TARGETS
Key for allowing raw link targets (must contain the value "true" to be considered true

See Also:
Constant Field Values

TITLE

public static final String TITLE
Key for specifying the HTML TITLE

See Also:
Constant Field Values

SUBJECT

public static final String SUBJECT
Key for specifying the Subject in the HTML header

See Also:
Constant Field Values

AUTHOR

public static final String AUTHOR
Key for specifying the Author in the HTML header

See Also:
Constant Field Values

KEYWORDS

public static final String KEYWORDS
Key for specifying the Keywords in the HTML header

See Also:
Constant Field Values

TABLE_HTML_STREAM_EXPORT_TYPE

public static final String TABLE_HTML_STREAM_EXPORT_TYPE
See Also:
Constant Field Values

TABLE_HTML_FLOW_EXPORT_TYPE

public static final String TABLE_HTML_FLOW_EXPORT_TYPE
See Also:
Constant Field Values

TABLE_HTML_PAGE_EXPORT_TYPE

public static final String TABLE_HTML_PAGE_EXPORT_TYPE
See Also:
Constant Field Values

ZIP_HTML_EXPORT_TYPE

public static final String ZIP_HTML_EXPORT_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlTableModule

public HtmlTableModule()
                throws org.pentaho.reporting.libraries.base.boot.ModuleInitializeException
DefaultConstructor. Loads the module specification.

Throws:
org.pentaho.reporting.libraries.base.boot.ModuleInitializeException - if an error occured.
Method Detail

initialize

public void initialize(org.pentaho.reporting.libraries.base.boot.SubSystem subSystem)
                throws org.pentaho.reporting.libraries.base.boot.ModuleInitializeException
Initializes the module. Use this method to perform all initial setup operations. This method is called only once in a modules lifetime. If the initializing cannot be completed, throw a ModuleInitializeException to indicate the error,. The module will not be available to the system.

Parameters:
subSystem - the subSystem.
Throws:
org.pentaho.reporting.libraries.base.boot.ModuleInitializeException - if an error ocurred while initializing the module.