com.technia.tvc.structurebrowser.render

Interface ExportContext

All Known Subinterfaces:

HTMLExportCellContext, HTMLExportCellHeaderContext, HTMLExportContext, HTMLExportRowContext, PDFExportCellContext, PDFExportCellHeaderContext, PDFExportContext, PDFExportRowContext, SpreadsheetExportCellContext, SpreadsheetExportCellHeaderContext, SpreadsheetExportContext, SpreadsheetExportRowContext, TextExportCellContext, TextExportCellHeaderContext, TextExportContext, TextExportRowContext, XMLExportCellContext, XMLExportCellHeaderContext, XMLExportContext, XMLExportRowContext

public interface ExportContext

Since:

6.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExportContext.IndentMode Indent mode

Field Summary

Fields

Modifier and Type	Field and Description
static ExportContext.IndentMode	INDENT_MODE_LEVEL
static ExportContext.IndentMode	INDENT_MODE_NONE
static ExportContext.IndentMode	INDENT_MODE_STRUCTURE

Method Summary

Modifier and Type	Method and Description
javax.servlet.ServletContext	getApplication() Returns the web application's servlet context.
ExportContext.IndentMode	getIndentMode()
java.util.Locale	getLocale()
javax.servlet.http.HttpServletRequest	getRequest() Returns the current HTTP request.
TableBean<?>	getTableBean()
ExportToolkit	getToolkit()
boolean	isGroupPageResult() Checks if the table currently being rendered is a group result page.
boolean	isStructure()
void	release() Releases the export context.
void	reset()

Field Detail

INDENT_MODE_NONE

static final ExportContext.IndentMode INDENT_MODE_NONE

INDENT_MODE_STRUCTURE

static final ExportContext.IndentMode INDENT_MODE_STRUCTURE

INDENT_MODE_LEVEL

static final ExportContext.IndentMode INDENT_MODE_LEVEL

Method Detail

getApplication

javax.servlet.ServletContext getApplication()

Returns the web application's servlet context.

Returns:

The web application's servlet context, or null, if the export is made from a place, where the ServletContext is not available.

Since:

6.2.1

getIndentMode

ExportContext.IndentMode getIndentMode()

Returns:

True, if to indicate the level in the export

Since:

6.1.0

getLocale

java.util.Locale getLocale()

Returns:

Returns the user's locale

Since:

6.1.0

getRequest

javax.servlet.http.HttpServletRequest getRequest()

Returns the current HTTP request.

Returns:

The current HTTP request, or null, if the export is made from a place, where the HttpServletRequest is not available.

Since:

6.2.0

getTableBean

TableBean<?> getTableBean()

Returns:

The table

Since:

6.1.0

getToolkit

ExportToolkit getToolkit()

Returns:

The tookit which contains utility methods for performing default stuff.

Since:

6.1.0

isGroupPageResult

boolean isGroupPageResult()

Checks if the table currently being rendered is a group result page.

Returns:

True if so.

Since:

6.3.0

isStructure

boolean isStructure()

Returns:

True if the table is a structure

Since:

6.1.0

release

void release()
      throws java.io.IOException

Releases the export context. For example flushing data to the stream or doing some other tidying.

NOTE: Do not call this method unless you know what you're doing!

Throws:

java.io.IOException

Since:

2009.1.1

reset

void reset()