com.technia.tvc.structurebrowser.render

Interface TableRenderToolkit

public interface TableRenderToolkit

The toolkit contains method that can be used to render various parts of the table page.

Since:

6.1.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCalculationCellId(Column column, TableCalculation calculation, boolean currentPage) Returns the id of the HTML table cell that holds the result of the calculation.
java.lang.String	getCommonResourceURL(TableRenderContext rc, java.lang.String resource) Returns a URL to the resource specified by the resource parameter.
java.lang.String	getIconURLForCell(TableCellRenderContext rc, CellValue value) Returns the URL to the configured icon for the specified cell value.
java.lang.String	getInputId(long dataId, int col, int value) Returns the id of the HTML input element for a cell value in edit mode.
java.lang.String	getInputId(TableBean<?> table, TableData data, CellValue value) Returns the id of the HTML input element for a cell value in edit mode.
com.technia.tvc.core.gui.common.InputType	getInputType(CellValue cv) Returns the input type for the cell value
java.lang.String	getObjectImageURL(TableRenderContext rc, java.lang.String oid) Returns the URL to the object image.
java.lang.String	getPopupURLForCell(TableCellRenderContext rc, CellValue value) Returns the URL that will show the entire cell value in a popup when the original value was truncated in the page.
java.lang.String	getResourceURL(TableRenderContext rc, java.lang.String resource) Returns a URL to the resource specified by the resource parameter.
java.lang.String	getStyleForCell(TableCellRenderContext rc) Returns the style for the specified cell
java.lang.String	getTVCActionURL(TableRenderContext rc, java.lang.String action) Returns the URL a the specified TVC action.
java.lang.String	getTypeIconURL(TableRenderContext rc, java.lang.String type) Returns the URL to the type icon for the specified type.
java.lang.String	getURLForCell(TableCellRenderContext rc, CellValue value) Returns the URL for the specified cell.
void	renderCalculationResultDefault(CalculationResultRenderContext ctx) Returns a result from a calculation.
void	renderCellDefault(TableCellRenderContext rc) Render a cell as it would be rendered by the default cell renderer.
boolean	renderCellInEditMode(TableCellRenderContext rc) Renders the cell in edit mode.
void	renderComboBox(MassUpdateRenderContext rc, InputFieldStyle styles) Render a multi-cell editing enabled combo box.
void	renderComboBox(MassUpdateRenderContext rc, RangeValue[] ranges, InputFieldStyle styles) Render a multi-cell editing enabled combo box.
void	renderComboBox(TableCellRenderContext rc, CellValue val, InputFieldStyle styles) Render a in-cell editing enabled combo box.
void	renderComboBox(TableCellRenderContext rc, CellValue val, RangeValue[] ranges, InputFieldStyle styles) Render a in-cell editing enabled combo box.
void	renderDatePicker(MassUpdateRenderContext rc, InputFieldStyle styles) Render a multi-cell editing enabled date picker (e.g., calendar drop down).
void	renderDatePicker(TableCellRenderContext rc, CellValue val, InputFieldStyle styles) Render a in-cell editing enabled date picker (e.g., calendar drop down).
void	renderFontIcon(TableCellRenderContext rc, java.lang.String iconClass, java.lang.String text, java.lang.String tooltip, java.lang.String onClick) Renders a font icon and/or a text.
void	renderGroupPageLegend(TableRenderContext ctx) Renders the legend related to table grouping above the table.
void	renderGroupRow(TableBodyRowRenderContext ctx)
void	renderHeader(TableCellHeaderRenderContext rc, java.lang.String headerText) Renders a header in the same way as the default renderer would, except that this method allows you to specify a custom header text.
void	renderHeader(TableCellHeaderRenderContext rc, java.lang.String headerText, HeaderSpec spec) Renders a header in the same way as the default renderer would, except that this method allows you to specify a custom header text.
void	renderHeaderDefault(TableCellHeaderRenderContext rc) Render a header as it would be rendered by the default cell renderer.
void	renderHeaderHTML(TableCellHeaderRenderContext rc, java.lang.String headerInnerHTML) Renders a header with custom HTML instead of a label (or image).
void	renderHeaderHTML(TableCellHeaderRenderContext rc, java.lang.String headerInnerHTML, HeaderSpec spec) Renders a header with custom HTML instead of a label (or image).
void	renderHeaderImage(TableCellHeaderRenderContext rc, java.lang.String headerImageSrc) Renders a header with an image.
void	renderHeaderImage(TableCellHeaderRenderContext rc, java.lang.String headerImageSrc, HeaderSpec spec) Renders a header with an image.
void	renderIcon(TableCellRenderContext rc, java.lang.String iconId, java.lang.String tooltip, java.lang.String onClick, java.lang.String cssClass) Renders an icon specified in the theme.
void	renderMassUpdateFieldDefault(MassUpdateRenderContext rc) Render a mass update field as it would be rendered by the default cell renderer.
void	renderPopupCellValueDefault(PopupCellValueRenderContext rc) Render a cell when the [More] link has been clicked.
void	renderPopupLink(TableCellRenderContext rc, CellValue cv) Renders the default popup link for a cell value.
void	renderQueryParameters(AboveTableRendererContext ctx) Returns the query parameters above the table.
void	renderRowAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx, com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec spec) Renders a row action.
void	renderStyleCell(TableCellRenderContext rc)
void	renderTableRowGroup(TableBodyRowRenderContext ctx)
void	renderTextArea(MassUpdateRenderContext rc, InputFieldStyle styles) Render a multi-cell editing enabled text area.
void	renderTextArea(TableCellRenderContext rc, CellValue val, InputFieldStyle styles) Render a in-cell editing enabled text area for the specified cell value.
void	renderTextField(MassUpdateRenderContext rc, InputFieldStyle styles) Render a multi-cell editing enabled text field.
void	renderTextField(MassUpdateRenderContext rc, InputFieldType dataType, InputFieldStyle styles) Render a multi-cell editing enabled text field.
void	renderTextField(TableCellRenderContext rc, CellValue val, InputFieldStyle styles) Render a in-cell editing enabled text field for the specified cell value.
void	renderTextField(TableCellRenderContext rc, CellValue val, InputFieldType dataType, InputFieldStyle styles) Render a in-cell editing enabled text field for the specified cell value.

Method Detail

getCalculationCellId

java.lang.String getCalculationCellId(Column column,
                                      TableCalculation calculation,
                                      boolean currentPage)

Returns the id of the HTML table cell that holds the result of the calculation.

Parameters:

column - A column.

calculation - A calculation.

currentPage - Whether the result is for the current page only. If false the result is for all rows.

Returns:

Returns an HTML id.

Since:

6.3.3

getCommonResourceURL

java.lang.String getCommonResourceURL(TableRenderContext rc,
                                      java.lang.String resource)

Returns a URL to the resource specified by the resource parameter.

Parameters:

rc - The rendering context.

resource - The path to the resource (relative from the AEF's common directory within the web application).

Returns:

A URL to the resource.

Since:

6.1.0

getIconURLForCell

java.lang.String getIconURLForCell(TableCellRenderContext rc,
                                   CellValue value)

Returns the URL to the configured icon for the specified cell value. This method currently checks the Show Type Icon, Show Alternate Icon and Show Object Image settings on the column. If none of these settings have been enabled this method returns null, i.e., not icon should be displayed.

Parameters:

rc - The rendering context.

value - The current cell value, which icon URL should be returned.

Returns:

Returns the URL to the configured icon, if any.

Since:

6.1.0

getInputId

java.lang.String getInputId(long dataId,
                            int col,
                            int value)

Returns the id of the HTML input element for a cell value in edit mode.

Parameters:

dataId - The id of the TableData.

col - The column index.

value - The cell value index.

Returns:

Returns the id of the HTML input element for a cell value.

Since:

6.2.0

getInputId

java.lang.String getInputId(TableBean<?> table,
                            TableData data,
                            CellValue value)

Returns the id of the HTML input element for a cell value in edit mode.

Parameters:

table - The table being rendered.

data - The row.

value - The cell value.

Returns:

Returns the id of the HTML input element for a cell value.

Since:

6.2.0

getObjectImageURL

java.lang.String getObjectImageURL(TableRenderContext rc,
                                   java.lang.String oid)

Returns the URL to the object image.

Parameters:

rc - The rendering context.

oid - The OID of the object which image the URL should point to.

Returns:

The URL to the object image.

Since:

6.1.0

getPopupURLForCell

java.lang.String getPopupURLForCell(TableCellRenderContext rc,
                                    CellValue value)

Returns the URL that will show the entire cell value in a popup when the original value was truncated in the page.

Parameters:

rc - The rendering context.

value - The current cell value.

Returns:

Returns the [more...] URL.

Since:

6.1.0

getResourceURL

java.lang.String getResourceURL(TableRenderContext rc,
                                java.lang.String resource)

Returns a URL to the resource specified by the resource parameter.

Parameters:

rc - The rendering context.

resource - The path to the resource (relative from the root of the web application).

Returns:

A URL to the resource.

Since:

6.1.0

getTVCActionURL

java.lang.String getTVCActionURL(TableRenderContext rc,
                                 java.lang.String action)

Returns the URL a the specified TVC action.

Parameters:

rc - The rendering context.

action - The name of a TVC action.

Returns:

The URL to the object image.

Since:

6.1.0

getStyleForCell

java.lang.String getStyleForCell(TableCellRenderContext rc)

Returns the style for the specified cell

Returns:

The string representing the style for the cell

Since:

2013.2.0

getTypeIconURL

java.lang.String getTypeIconURL(TableRenderContext rc,
                                java.lang.String type)

Returns the URL to the type icon for the specified type.

Parameters:

rc - The rendering context.

type - The name of a type.

Returns:

Returns the URL to the type icon. If unable to get the type icon URL for the specified type this method will return null.

Since:

6.1.0

getURLForCell

java.lang.String getURLForCell(TableCellRenderContext rc,
                               CellValue value)

Returns the URL for the specified cell. I.e., if the href property has been specified on the column this method will return a URL.

Parameters:

rc - The rendering context.

value - The current cell value, which URL should be returned.

Returns:

Returns the URL for this cell.

Since:

6.1.0

renderCalculationResultDefault

void renderCalculationResultDefault(CalculationResultRenderContext ctx)

Returns a result from a calculation.

Parameters:

ctx - The render context.

Since:

6.3.3

renderCellDefault

void renderCellDefault(TableCellRenderContext rc)

Render a cell as it would be rendered by the default cell renderer.

Parameters:

rc - The current render context.

Since:

6.1.0

renderComboBox

void renderComboBox(MassUpdateRenderContext rc,
                    InputFieldStyle styles)

Render a multi-cell editing enabled combo box. A combo box is an input field where users select a value from a drop down list.

Parameters:

rc - The rendering context.

styles - The visual styles of the combo box.

Since:

6.1.0

renderComboBox

void renderComboBox(MassUpdateRenderContext rc,
                    RangeValue[] ranges,
                    InputFieldStyle styles)

Render a multi-cell editing enabled combo box. A combo box is an input field where users select a value from a drop down list.

Parameters:

rc - The rendering context.

ranges - The accepted range values.

styles - The visual styles of the combo box.

Since:

6.1.7

renderComboBox

void renderComboBox(TableCellRenderContext rc,
                    CellValue val,
                    InputFieldStyle styles)

Render a in-cell editing enabled combo box. A combo box is an input field where users select a value from a drop down list.

Parameters:

rc - The rendering context.

val - The cell value.

styles - The visual styles of the combo box.

Since:

6.1.0

renderComboBox

void renderComboBox(TableCellRenderContext rc,
                    CellValue val,
                    RangeValue[] ranges,
                    InputFieldStyle styles)

Render a in-cell editing enabled combo box. A combo box is an input field where users select a value from a drop down list.

Parameters:

rc - The rendering context.

val - The cell value.

ranges - The accepted range values.

styles - The visual styles of the combo box.

Since:

6.1.7

renderDatePicker

void renderDatePicker(MassUpdateRenderContext rc,
                      InputFieldStyle styles)

Render a multi-cell editing enabled date picker (e.g., calendar drop down).

Parameters:

rc - The rendering context.

styles - The visual styles of the field.

Since:

6.1.0

renderDatePicker

void renderDatePicker(TableCellRenderContext rc,
                      CellValue val,
                      InputFieldStyle styles)

Render a in-cell editing enabled date picker (e.g., calendar drop down).

Parameters:

rc - The rendering context.

val - The cell value.

styles - The visual styles of the field.

Since:

6.1.0

renderGroupPageLegend

void renderGroupPageLegend(TableRenderContext ctx)

Renders the legend related to table grouping above the table.

Parameters:

ctx - The table renderer context.

Since:

6.3.0

renderHeader

void renderHeader(TableCellHeaderRenderContext rc,
                  java.lang.String headerText)

Renders a header in the same way as the default renderer would, except that this method allows you to specify a custom header text.

Parameters:

rc - The rendering context.

headerText - The custom header text. If null the default column label will be rendered.

Since:

6.1.0

renderHeader

void renderHeader(TableCellHeaderRenderContext rc,
                  java.lang.String headerText,
                  HeaderSpec spec)

Renders a header in the same way as the default renderer would, except that this method allows you to specify a custom header text.

Parameters:

rc - The rendering context.

headerText - The custom header text. If null the default column label will be rendered.

spec - Header properties to override default behavior.

Since:

6.1.0

renderHeaderDefault

void renderHeaderDefault(TableCellHeaderRenderContext rc)

Render a header as it would be rendered by the default cell renderer.

Parameters:

rc - The current render context.

Since:

6.1.0

renderHeaderHTML

void renderHeaderHTML(TableCellHeaderRenderContext rc,
                      java.lang.String headerInnerHTML)

Renders a header with custom HTML instead of a label (or image).

Parameters:

rc - The rendering context.

headerInnerHTML - The custom HTML.

Since:

6.1.0

renderHeaderHTML

void renderHeaderHTML(TableCellHeaderRenderContext rc,
                      java.lang.String headerInnerHTML,
                      HeaderSpec spec)

Renders a header with custom HTML instead of a label (or image).

Parameters:

rc - The rendering context.

headerInnerHTML - The custom HTML.

spec - Header properties to override default behavior.

Since:

6.1.0

renderHeaderImage

void renderHeaderImage(TableCellHeaderRenderContext rc,
                       java.lang.String headerImageSrc)

Renders a header with an image.

Parameters:

rc - The rendering context.

headerImageSrc - The image path.

Since:

6.1.0

renderHeaderImage

void renderHeaderImage(TableCellHeaderRenderContext rc,
                       java.lang.String headerImageSrc,
                       HeaderSpec spec)

Renders a header with an image.

Parameters:

rc - The rendering context.

headerImageSrc - The image path.

spec - Header properties to override default behavior.

Since:

6.1.0

renderMassUpdateFieldDefault

void renderMassUpdateFieldDefault(MassUpdateRenderContext rc)

Render a mass update field as it would be rendered by the default cell renderer.

Parameters:

rc - The current render context.

Since:

6.1.0

renderPopupCellValueDefault

void renderPopupCellValueDefault(PopupCellValueRenderContext rc)

Render a cell when the [More] link has been clicked.

Parameters:

rc - The current render context.

Since:

6.1.0

renderPopupLink

void renderPopupLink(TableCellRenderContext rc,
                     CellValue cv)

Renders the default popup link for a cell value.

Parameters:

rc - The rendering context.

cv - The cell value.

Since:

6.1.0

renderQueryParameters

void renderQueryParameters(AboveTableRendererContext ctx)

Returns the query parameters above the table.

Parameters:

ctx - The rendering context.

Since:

2009.1

renderRowAction

void renderRowAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx,
                     com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec spec)

Renders a row action. An example of a row action is "Add to clipboard" or "Go-there/Navigate from...".

Parameters:

ctx - The rendering context.

spec - The specification of the row action.

Since:

6.1.0

renderTableRowGroup

void renderTableRowGroup(TableBodyRowRenderContext ctx)

renderGroupRow

void renderGroupRow(TableBodyRowRenderContext ctx)

renderTextArea

void renderTextArea(MassUpdateRenderContext rc,
                    InputFieldStyle styles)

Render a multi-cell editing enabled text area.

Parameters:

rc - The current render context.

styles - The visual styles of the text field.

Since:

6.1.0

renderTextArea

void renderTextArea(TableCellRenderContext rc,
                    CellValue val,
                    InputFieldStyle styles)

Render a in-cell editing enabled text area for the specified cell value.

Parameters:

rc - The current cell render context.

val - The cell value for which the text area is rendered.

styles - The visual styles of the text area.

Since:

6.1.0

renderTextField

void renderTextField(MassUpdateRenderContext rc,
                     InputFieldStyle styles)

Render a multi-cell editing enabled text field.

Parameters:

rc - The current render context.

styles - The visual styles of the text field.

Since:

6.1.0

renderTextField

void renderTextField(MassUpdateRenderContext rc,
                     InputFieldType dataType,
                     InputFieldStyle styles)

Render a multi-cell editing enabled text field.

Parameters:

rc - The current render context.

dataType - The input data type.

styles - The visual styles of the text field.

Since:

6.1.0

renderTextField

void renderTextField(TableCellRenderContext rc,
                     CellValue val,
                     InputFieldStyle styles)

Render a in-cell editing enabled text field for the specified cell value.

Parameters:

rc - The current render context.

val - The cell value for which the text field is rendered.

styles - The visual styles of the text field.

Since:

6.1.0

renderTextField

void renderTextField(TableCellRenderContext rc,
                     CellValue val,
                     InputFieldType dataType,
                     InputFieldStyle styles)

Render a in-cell editing enabled text field for the specified cell value.

Parameters:

rc - The current render context.

val - The cell value for which the text field is rendered.

dataType - The input data type.

styles - The visual styles of the text field.

Since:

6.1.0

getInputType

com.technia.tvc.core.gui.common.InputType getInputType(CellValue cv)

Returns the input type for the cell value

Parameters:

cv - The cell value

Returns:

The input type.

Since:

2011.3.0

renderCellInEditMode

boolean renderCellInEditMode(TableCellRenderContext rc)

Renders the cell in edit mode.

Parameters:

rc - The current render context.

Returns:

true if the field were rendered in edit mode; otherwise false is returned.

Since:

2011.3.0

renderStyleCell

void renderStyleCell(TableCellRenderContext rc)

Parameters:

rc -

Since:

2013.1.0

renderIcon

void renderIcon(TableCellRenderContext rc,
                java.lang.String iconId,
                java.lang.String tooltip,
                java.lang.String onClick,
                java.lang.String cssClass)

Renders an icon specified in the theme. It can either be an image or a font icon.

Parameters:

rc - The current render context

iconId - Id of icon to render

tooltip - Tooltip for icon

onClick - Behavior when icon is clicked

cssClass - CSS class(es) applied on icon

Since:

2016.1.0

renderFontIcon

void renderFontIcon(TableCellRenderContext rc,
                    java.lang.String iconClass,
                    java.lang.String text,
                    java.lang.String tooltip,
                    java.lang.String onClick)

Renders a font icon and/or a text.

Parameters:

rc - The current render context

iconClass - CSS class(es) specifying icon to use

text - Text

tooltip - Tooltip for icon

onClick - OnClick behaviour

Since:

2016.1.0