TableRenderContext (Technia Value Components (2016.1.0) API Documentation

All Superinterfaces:

com.technia.tvc.core.util.i18n.LocaleProvider

All Known Subinterfaces:

AboveTableRendererContext, CalculationResultRenderContext, MassUpdateRenderContext, MassUpdateResourceContext, PageHeaderRenderContext, PopupCellValueRenderContext, TableBodyRenderContext, TableBodyRowRenderContext, TableCalculationsRenderContext, TableCellHeaderRenderContext, TableCellRenderContext, TableCellResourceContext, TableFooterFrameRenderContext, TableFramesetRendererContext, TableHeaderRenderContext, TableInfoFrameRenderContext, TableParentFrameRenderContext, TableResourceContext, TableRowRenderContext, TableViewFrameRenderContext
```
public interface TableRenderContext
extends com.technia.tvc.core.util.i18n.LocaleProvider
```
A rendering context for the table being rendered. Provides helpful information to the rendering logic.

Since:

6.1.0

Method Summary

Methods
Modifier and Type	Method and Description
`javax.servlet.ServletContext`	`getApplication()` Returns the web application's servlet context.
`Disposition`	`getDisposition()` Returns the disposition.
`HtmlWriter`	`getHtmlWriter()` Returns the `HtmlWriter` to use.
`java.util.Locale`	`getLocale()` Returns the current locale.
`QueryManager`	`getQueryManager()`
`javax.servlet.http.HttpServletRequest`	`getRequest()` Returns the current HTTP request.
`javax.servlet.http.HttpSession`	`getSession()` Returns the current HTTP session.
`TableBean<? extends TableData>`	`getTableBean()` Returns the table being rendered.
`java.lang.String`	`getTableBeanName()` Returns the name of the table (the name to which the table is bound in the user's HTTP session).
`TableLayout`	`getTableLayout()` Returns the layout of the table (standard or optimized).
`int`	`getTableMode()` Returns the current table mode
`TableRenderToolkit`	`getToolkit()` Returns the toolkit.
`UserAgentDetector`	`getUserAgentDetector()` Returns a user agent detector.
`boolean`	`isBuildStructureSource()` Check if the table is the source in build structure.
`boolean`	`isBuildStructureTarget()` Check if the table is the target in build structure.
`boolean`	`isDialogMode()`
`boolean`	`isDragEnabled()`
`boolean`	`isDropEnabled()`
`boolean`	`isEdit()` Check if the table is rendered in edit mode.
`boolean`	`isFinder()`
`boolean`	`isFinderAnyField()`
`boolean`	`isFinderOpenOnLoad()`
`boolean`	`isGroupPageResult()` Checks if the table currently being rendered is a group result page.
`boolean`	`isInlineSearch()`
`boolean`	`isPortalMode()` Checks if the table is rendered in a channel on a portal page (aka power view).
`boolean`	`isPrinterFriendly()` Check if the rendering is printer friendly.
`boolean`	`isRearrangeMode()`
`boolean`	`isSearchInStructureResult()` Check if the table is the result of a search in structure.
`boolean`	`isSearchResult()` Check if the table is a search result.
`boolean`	`isSidePanel()`

- Method Detail
  - getApplication
```
javax.servlet.ServletContext getApplication()
```
    Returns the web application's servlet context.
    
    Returns:
    Returns the web application's servlet context.
    Since:
    
    6.1.0
  - getDisposition
```
Disposition getDisposition()
```
    Returns the disposition. This is useful when the rendering is taking place in one of the view frames. Some of the view frames might only render the left side of the table, while others will render the right side of the table. Sometimes a single frame will render both the left and the right side of the table.
    
    Returns:
    Returns the disposition.
    Since:
    
    6.1.0
  - getHtmlWriter
```
HtmlWriter getHtmlWriter()
```
    Returns the HtmlWriter to use.
    
    Returns:
    Returns the HtmlWriter to which we will render HTML.
    Since:
    
    6.1.0
  - getLocale
```
java.util.Locale getLocale()
```
    Returns the current locale.
    
    Specified by:
    
    getLocale in interface com.technia.tvc.core.util.i18n.LocaleProvider
    
    Returns:
    Returns the current locale.
    Since:
    
    6.1.0
  - getQueryManager
```
QueryManager getQueryManager()
```
  - getRequest
```
javax.servlet.http.HttpServletRequest getRequest()
```
    Returns the current HTTP request.
    
    Returns:
    Returns the current HTTP request.
    Since:
    
    6.1.0
  - getSession
```
javax.servlet.http.HttpSession getSession()
```
    Returns the current HTTP session.
    
    Returns:
    Returns the current HTTP session.
    Since:
    
    6.1.0
  - getTableBean
```
TableBean<? extends TableData> getTableBean()
```
    Returns the table being rendered.
    
    Returns:
    Returns the table being rendered.
    Since:
    
    6.1.0
  - getTableBeanName
```
java.lang.String getTableBeanName()
```
    Returns the name of the table (the name to which the table is bound in the user's HTTP session).
    
    Returns:
    Returns the name of the table (the name to which the table is bound in the user's HTTP session).
    Since:
    
    6.1.0
  - getTableLayout
```
TableLayout getTableLayout()
```
    Returns the layout of the table (standard or optimized).
    
    Returns:
    The layout of the table.
    Since:
    
    6.1.0
  - getTableMode
```
int getTableMode()
```
    Returns the current table mode
    
    Returns:
    The mode
    Since:
    
    2009.1
    
    See Also:
    ModeUtils
  - getToolkit
```
TableRenderToolkit getToolkit()
```
    Returns the toolkit. The toolkit provides helpful methods for rendering certain parts of the table.
    
    Returns:
    Returns the toolkit.
    Since:
    
    6.1.0
  - getUserAgentDetector
```
UserAgentDetector getUserAgentDetector()
```
    Returns a user agent detector. Can be used to query the browser type.
    
    Returns:
    Returns a user agent detector.
    Since:
    
    6.1.0
  - isBuildStructureSource
```
boolean isBuildStructureSource()
```
    Check if the table is the source in build structure.
    
    Returns:
    Returns true if the table being rendered is the source table in build structure.
    Since:
    
    6.1.0
  - isBuildStructureTarget
```
boolean isBuildStructureTarget()
```
    Check if the table is the target in build structure.
    
    Returns:
    Returns true if the table being rendered is the target table in build structure.
    Since:
    
    6.1.1
  - isInlineSearch
```
boolean isInlineSearch()
```
    Returns:
    True if the table shown is using the "inline search" feature.
    Since:
    
    2010.2.0
  - isEdit
```
boolean isEdit()
```
    Check if the table is rendered in edit mode.
    
    Returns:
    Returns true if the table is rendered in edit mode.
    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
  - isPortalMode
```
boolean isPortalMode()
```
    Checks if the table is rendered in a channel on a portal page (aka power view).
    
    Returns:
    Returns true if the table is rendered in a channel on a portal page (aka power view).
    Since:
    
    6.1.4
  - isPrinterFriendly
```
boolean isPrinterFriendly()
```
    Check if the rendering is printer friendly.
    
    Returns:
    Returns true if the table is rendered in printer friendly mode.
    Since:
    
    6.1.0
  - isSearchInStructureResult
```
boolean isSearchInStructureResult()
```
    Check if the table is the result of a search in structure.
    
    Returns:
    Returns true if the table being rendered is the result of a search in structure operation.
    Since:
    
    6.1.0
  - isSearchResult
```
boolean isSearchResult()
```
    Check if the table is a search result.
    
    Returns:
    Returns true if the table is a search result.
    Since:
    
    6.1.0
  - isSidePanel
```
boolean isSidePanel()
```
    Returns:
    True if the table is rendered within the side panel
    Since:
    
    6.1.0
  - isDialogMode
```
boolean isDialogMode()
```
    Returns:
    True if the table is rendered in a dialog (popup dialog).
    Since:
    
    2011.1.0
  - isRearrangeMode
```
boolean isRearrangeMode()
```
    Returns:
    True if the table is in rearrange mode
    Since:
    
    2011.2.0
  - isDragEnabled
```
boolean isDragEnabled()
```
    Returns:
    True if drag is enabled
    Since:
    
    2011.2.0
  - isDropEnabled
```
boolean isDropEnabled()
```
    Returns:
    True if drop is enabled
    Since:
    
    2011.2.0
  - isFinder
```
boolean isFinder()
```
    Returns:
    True if finder feature is enabled
    Since:
    
    2013.3.0
  - isFinderOpenOnLoad
```
boolean isFinderOpenOnLoad()
```
    Returns:
    True if finder feature is opened when loading the page
    Since:
    
    2013.3.0
  - isFinderAnyField
```
boolean isFinderAnyField()
```
    Returns:
    True if finder feature uses any field search criteria
    Since:
    
    2013.3.0

Interface TableRenderContext

Method Summary

Method Detail

getApplication

getDisposition

getHtmlWriter

getLocale

getQueryManager

getRequest

getSession

getTableBean

getTableBeanName

getTableLayout

getTableMode

getToolkit

getUserAgentDetector

isBuildStructureSource

isBuildStructureTarget

isInlineSearch

isEdit

isGroupPageResult

isPortalMode

isPrinterFriendly

isSearchInStructureResult

isSearchResult

isSidePanel

isDialogMode

isRearrangeMode

isDragEnabled

isDropEnabled

isFinder

isFinderOpenOnLoad

isFinderAnyField