com.technia.tvc.structurebrowser.render

Class TableRenderer

java.lang.Object

com.technia.tvc.structurebrowser.render.TableRenderer

Direct Known Subclasses:

CustomTableRenderer, SVGTableRenderer

public class TableRenderer
extends java.lang.Object

This class is responsible for rendering a TableBean. This class renders everything on a tablepage, for example: the toolbar, page-headers, pagination control, buttons above the table, the table headers and body, anything between the buttons and the table header, and all frames etc.

Note that the actual column headers and cell values are rendered by the TableCellRenderers. If you need to change the look and feel of the Structure Browser you should make a subclass of this class and tell Structure Browser to use your subclass instead of the default renderer. In your subclass of this class you can override the methods whose behaviour you wish to change.

IMPLEMENTATION NOTE: This class is very big, but there is a good reason for that. The purpose of having all or most of the rendering logic inside just one class is that it should be easy to subclass this class and just override the methods that you need to change.

The rendering of normal cells within the table will however be redirected to TableCellRenderers. The by far most common thing that is configured in a Structure Browser table is how the cells are rendered, hence why that has been put in a separate interface.

However, complex rendering code has been put inside a toolkit class, such as rendering cells in edit mode (since that is a quite complicated task requiring a lot of code). The rendering of the structure column is also quite complex and difficult to change, by default the rendering of the structure column will be delegated to a class implementing the StructureRenderer interface.

Since:

6.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NBSP Non-breaking space.

Constructor Summary

Constructors

Constructor and Description
TableRenderer()

Method Summary

Modifier and Type	Method and Description
com.technia.tvc.core.gui.toolbar.ToolbarItem	addAddToClipboardButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addAddToCollectionButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addAdvancedSortButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addBuildStructureConnectButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addBuildStructureMoveButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addBuildStructureRelationshipChooser(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addBuildStructureRelationshipDirection(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addBuildStructureReplaceButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addChartButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addCompareButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addDataGroupButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addDemoteButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addDisconnectButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addExportButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addFilterChooser(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addFinderButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addFlattenStructureButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
protected void	addFramesetFrame(TableFramesetRendererContext ctx, java.lang.String divClass, java.lang.String frameName, java.lang.String frameURL)
protected void	addFramesetFrame(TableFramesetRendererContext ctx, java.lang.String divClass, java.lang.String frameName, java.lang.String frameURL, java.lang.String divId)
protected void	addFramesetHiddenFrames(TableFramesetRendererContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addFullExpandButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addGoBackButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addHelpButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addInlineCompareButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext context)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addLaunchFromPortalButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addManageCollectionsButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addMaximizeButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx) Adds the maximize button.
protected static void	addMsgAsJS(HtmlWriter out, java.util.Locale l, java.lang.String variable, java.lang.String resourceKey) Adds a Java Script variable holding a translated text.
com.technia.tvc.core.gui.toolbar.ToolbarItem	addOpenClipboardButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addPreferencesButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addPrinterFriendlyButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addPromoteButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addReloadButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
protected void	addResourcesFromTableCellRenderers(TableResourceContext ctx, java.util.Collection<Resource> resources)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addSearchButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addSeparator(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addTableChooser(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addTableConfiguratorButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addToggleToEditButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx) Adds the toggle to edit button.
com.technia.tvc.core.gui.toolbar.ToolbarItem	addToggleToReadButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx) Adds the toggle to read button.
protected void	addToolbarContainer(TableRenderContext ctx, com.technia.tvc.core.gui.toolbar.Toolbar toolbar)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addToolbarMenu(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addTooolbarItem(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx, java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributes)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addTriggerValidationButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addUnwrapButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addViewChooser(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
com.technia.tvc.core.gui.toolbar.ToolbarItem	addWrapButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
void	afterToolbarLayout(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
void	beforeToolbarLayout(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
protected ComponentFilter	createToolbarComponentFilter(TableRenderContext ctx)
protected ParameterProvider	createToolbarParameterProvider(TableRenderContext ctx)
void	exportTable(ExportContext ctx) Exports the table.
protected void	exportTable(HTMLExportContext ctx) Deprecated. The native excel export makes the use of this HTML format redundant.
protected void	exportTable(PDFExportContext ctx) Exports a table into PDF format
protected void	exportTable(SpreadsheetExportContext ctx) Export of a table into a spreadsheet format (typically Excel but in the future we might add support for Open Office).
protected void	exportTable(TextExportContext ctx) Exports a table into text (CSV or Text)
protected void	exportTable(XMLExportContext ctx) Exports a table into XML format
protected void	exportTableBody(HTMLExportContext ctx)
protected void	exportTableBody(SpreadsheetExportContext ctx)
protected void	exportTableBody(XMLExportContext ctx)
protected void	exportTableCalculations(SpreadsheetExportContext ctx)
protected void	exportTableColumn(PDFExportCellHeaderContext ctx)
protected void	exportTableHeader(HTMLExportContext ctx)
protected void	exportTableHeader(SpreadsheetExportCellHeaderContext ctx)
protected void	exportTableHeader(TextExportContext ctx)
protected void	exportTableHeader(XMLExportContext ctx)
protected void	exportTableHeaderBegin(HTMLExportContext ctx)
protected void	exportTableHeaderBegin(TextExportContext ctx)
protected void	exportTableHeaderBegin(XMLExportContext ctx)
protected void	exportTableHeaderCell(HTMLExportCellHeaderContext ctx)
protected void	exportTableHeaderCell(TextExportCellHeaderContext ctx)
protected void	exportTableHeaderCell(XMLExportCellHeaderContext ctx)
protected void	exportTableHeaderCells(HTMLExportContext ctx)
protected void	exportTableHeaderCells(PDFExportContext ctx)
protected void	exportTableHeaderCells(TextExportContext ctx)
protected void	exportTableHeaderCells(XMLExportContext ctx)
protected void	exportTableHeaderContent(HTMLExportContext ctx)
protected void	exportTableHeaderContent(PDFExportContext ctx)
protected void	exportTableHeaderContent(SpreadsheetExportContext ctx)
protected void	exportTableHeaderContent(TextExportContext ctx)
protected void	exportTableHeaderContent(XMLExportContext ctx)
protected void	exportTableHeaderEnd(HTMLExportContext ctx)
protected void	exportTableHeaderEnd(TextExportContext ctx)
protected void	exportTableHeaderEnd(XMLExportContext ctx)
protected void	exportTableHeaderGroup(HTMLExportContext ctx)
protected void	exportTableHeaderGroup(PDFExportContext ctx)
protected void	exportTableHeaderGroup(TextExportContext ctx)
protected void	exportTableHeaderGroup(XMLExportContext ctx)
protected void	exportTableHeaderGroupImpl(HTMLExportContext ctx)
protected void	exportTableHeaderGroupImpl(XMLExportContext ctx)
protected void	exportTableHeaderStructure(HTMLExportContext ctx)
protected void	exportTableHeaderStructure(TextExportContext ctx)
protected void	exportTableImpl(HTMLExportContext ctx)
protected void	exportTableRow(HTMLExportRowContext ctx)
protected void	exportTableRow(SpreadsheetExportRowContext ctx)
protected void	exportTableRow(TextExportRowContext ctx)
protected void	exportTableRow(XMLExportRowContext ctx)
protected void	exportTableRowBegin(HTMLExportRowContext ctx)
protected void	exportTableRowBegin(PDFExportRowContext ctx)
protected void	exportTableRowBegin(SpreadsheetExportRowContext ctx)
protected void	exportTableRowBegin(TextExportRowContext ctx)
protected void	exportTableRowBegin(XMLExportRowContext ctx)
protected void	exportTableRowCell(HTMLExportCellContext ctx)
protected void	exportTableRowCell(PDFExportCellContext ctx)
protected void	exportTableRowCell(SpreadsheetExportCellContext ctx)
protected void	exportTableRowCell(TextExportCellContext ctx)
protected void	exportTableRowCell(XMLExportCellContext ctx)
protected void	exportTableRowCells(HTMLExportRowContext ctx)
protected void	exportTableRowCells(PDFExportRowContext ctx)
protected void	exportTableRowCells(SpreadsheetExportRowContext ctx)
protected void	exportTableRowCells(TextExportRowContext ctx)
protected void	exportTableRowCells(XMLExportRowContext ctx)
protected void	exportTableRowContent(HTMLExportRowContext ctx)
protected void	exportTableRowContent(PDFExportRowContext ctx)
protected void	exportTableRowContent(SpreadsheetExportRowContext ctx)
protected void	exportTableRowContent(TextExportRowContext ctx)
protected void	exportTableRowContent(XMLExportRowContext ctx)
protected void	exportTableRowEnd(HTMLExportRowContext ctx)
protected void	exportTableRowEnd(PDFExportRowContext ctx)
protected void	exportTableRowEnd(SpreadsheetExportRowContext ctx)
protected void	exportTableRowEnd(TextExportRowContext ctx)
protected void	exportTableRowEnd(XMLExportRowContext ctx)
protected void	exportTableRowGroup(HTMLExportRowContext ctx)
protected void	exportTableRowGroup(PDFExportRowContext ctx)
protected void	exportTableRowGroup(TextExportRowContext ctx)
protected void	exportTableRowGroup(XMLExportRowContext ctx)
protected void	exportTableRows(PDFExportContext ctx)
protected void	exportTableRows(TextExportContext ctx)
protected void	exportTableRows(XMLExportContext ctx)
protected void	exportTableRowStructure(HTMLExportRowContext ctx)
protected void	exportTableRowStructure(TextExportRowContext ctx)
protected int	getAdditionalColumnCount(TableCalculationsRenderContext ctx)
protected boolean	getAddTidy(TableFramesetRendererContext ctx)
protected com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec	getAddToClipboardRowActionSpec(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)
protected BuildStructureConfiguration	getBuildStructureConfiguration(TableRenderContext ctx)
protected java.lang.String	getCalculationsHeader(TableCalculationResults results, boolean currentPage, java.util.Locale locale)
com.technia.tvc.structurebrowser.render.ContextFactory	getContextFactory()
protected TableCellRenderer	getDefaultTableCellRenderer() Returns the default TableCellRenderer.
static TableRenderer	getDefaultTableRenderer() Returns the default TableRenderer.
protected java.lang.String	getDroppableOnOverClass(TableResourceContext ctx)
protected java.lang.String	getEmptyTableMessage(TableRenderContext ctx) This method returns null by default in order to force writing the default message.
protected com.technia.tvc.core.gui.theme.Icon	getFrameGliderConnectIcon(TableRenderContext ctx)
protected com.technia.tvc.core.gui.theme.Icon	getFrameGliderImage(TableRenderContext ctx, java.lang.String param, java.lang.String defaultIcon)
protected com.technia.tvc.core.gui.theme.Icon	getFrameGliderRearrangeIcon(TableRenderContext ctx)
protected java.lang.String	getFrameURL(TableRenderContext ctx, java.lang.String actionName, java.lang.String path, java.lang.String targetForward, boolean searchResult)
protected com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec	getGoRearrangeRowActionSpec(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)
protected java.lang.String	getGoThereAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)
protected com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec	getGoThereRowActionSpec(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)
protected java.lang.String	getGoThereTooltipKey(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)
protected boolean	getHasRowActionColumn(TableBean<?> tableBean, int mode) Returns true if there are any columns that should be moved into the actions menu.
protected TableCellRenderContext	getInCellEditCellRenderContext(TableBodyRenderContext rc, long dataid, int columnIndex, boolean edit)
protected com.technia.tvc.structurebrowser.render.structure.StructureRenderer	getStructureRenderer(TableRenderContext ctx, com.technia.tvc.structurebrowser.render.structure.StructureTheme theme) Returns the StructureRenderer that should be used.
protected java.lang.String	getTableCellClass(TableCellRenderContext ctx)
protected TableCellRenderer	getTableCellRenderer(Column column) Returns the TableCellRenderer that should be used for the specified column.
protected java.lang.String	getTableGroupHeaderRowClass(TableHeaderRenderContext ctx)
protected java.lang.String	getTableHeaderClass(TableCellHeaderRenderContext ctx)
static TableRenderer	getTableRenderer(TableBean<?> table) Returns the renderer for a particular TableBean instance.
protected java.util.List<com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec>	getTableRowActionSpecs(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx) Returns a list of RowActionSpec that should be rendered.
protected java.lang.String	getTableRowClass(TableBodyRowRenderContext ctx)
protected java.lang.String	getTableRowId(TableBodyRowRenderContext ctx)
protected java.lang.String	getTableRowSelectionValue(TableBodyRowRenderContext ctx)
com.technia.tvc.structurebrowser.render.toolbar.ToolbarLayoutManager	getToolbarLayoutManager(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)
protected boolean	hasPageHeader(PageHeaderRenderContext ctx)
protected boolean	hasPageSubHeader(PageHeaderRenderContext ctx)
protected void	initExport(HTMLExportContext ctx)
protected boolean	isContextMenuCachingEnabled(TableRenderContext ctx)
protected boolean	isContextMenuDynamic(TableRenderContext ctx)
protected boolean	isPartialUpdateSupported(TableRenderContext ctx)
protected boolean	isRenderContextMenu(TableBodyRowRenderContext ctx)
protected boolean	isRenderedAsNavigationCell(TableRenderContext ctx, Column column)
boolean	isRenderedAsRowAction(TableBean<?> tableBean, Cell cell) Returns true if the cell is moved to the row-actions menu.
boolean	isRenderedAsRowAction(TableBean<?> tableBean, Column column) Returns true if the cells for this column is configured to be rendered within the row actions menu.
protected boolean	isRenderGroupHeader(TableHeaderRenderContext ctx)
boolean	isRenderTableRowActionsInSeparateColumns(TableBean<?> tableBean) Returns true if row actions are rendered in separate columns.
boolean	isTableRowActionsCombinedMouseOverEnabled(TableBean<?> tableBean) Returns true if mouseover should be enabled when row actions are rendered as aggregated into one common column.
void	renderAboveTable(AboveTableRendererContext ctx) This method is called to render content above the table but below the table buttons.
protected void	renderAboveTableMessages(TableResourceContext ctx)
protected void	renderAddToClipboardAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)
protected void	renderCollaborationContent(TableFramesetRendererContext ctx)
protected void	renderContextMenuResources(TableResourceContext ctx) Renders the resources needed for the context menu.
protected void	renderDimensionInfo(TableResourceContext ctx)
protected boolean	renderDragHandleBegin(TableBodyRowRenderContext ctx) The drag handle is rendered within the first column of a nested table inside the cell.
protected void	renderDragHandleEnd(TableBodyRowRenderContext ctx)
protected void	renderDragIcon(TableFramesetRendererContext ctx, java.lang.String id, com.technia.tvc.core.gui.theme.Icon icon)
protected void	renderDynamicParentResources(TableResourceContext ctx)
protected void	renderEmptyTableBody(TableBodyRenderContext ctx) Renders the table body in case the table is "empty"
protected void	renderEmptyTableHeaderColumn(TableRenderContext ctx)
protected void	renderErrors(TableRenderContext ctx)
protected void	renderFinder(AboveTableRendererContext ctx) Renders the finder feature above the table.
protected void	renderFrameGliderDraggingIcon(TableFramesetRendererContext ctx)
void	renderFrameset(TableFramesetRendererContext ctx) Renders the (top-level) frameset.
protected void	renderFramesetContent(TableFramesetRendererContext ctx)
protected void	renderFramesetPageContent(TableFramesetRendererContext ctx)
protected void	renderFramesetResources(TableFramesetRendererContext ctx)
protected void	renderGoRearrangeAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)
protected void	renderGoThereAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)
protected void	renderGroupPageLegend(AboveTableRendererContext ctx)
void	renderInCellEdit(TableBodyRenderContext rc, long dataid, int columnIndex, boolean edit)
protected void	renderInlineCompare(AboveTableRendererContext ctx)
protected void	renderInlineSearchForm(AboveTableRendererContext ctx)
void	renderMassUpdateField(MassUpdateRenderContext ctx)
void	renderMassUpdateResources(MassUpdateResourceContext ctx) Renders the resources required for the mass update function.
protected void	renderPageHeader(PageHeaderRenderContext ctx)
void	renderPageHeaders(PageHeaderRenderContext ctx)
protected void	renderPageHeadersImpl(PageHeaderRenderContext ctx)
protected void	renderPageHeadersPrinterFriendlyImpl(PageHeaderRenderContext ctx)
protected void	renderPageSubHeader(PageHeaderRenderContext ctx)
void	renderPageTitle(PageHeaderRenderContext ctx)
protected void	renderPaginationControls(TableFooterFrameRenderContext ctx) Renders the pagination controls within the footer frame
void	renderParentForm(TableRenderContext ctx) Renders the form inside the "parent" frame
void	renderParentFrame(TableParentFrameRenderContext ctx) Renders the parent frame.
void	renderParentResources(TableResourceContext ctx) This method renders the resources that the table requires in the parent frame.
void	renderPopupCellValue(PopupCellValueRenderContext ctx)
protected void	renderPrinterFriendlyFrameBody(TableViewFrameRenderContext ctx) Renders the body content of the printer friendly body frame
protected void	renderResources(TableRenderContext ctx, java.util.Collection<Resource> resources)
protected void	renderResources(TableRenderContext ctx, Resource... resources)
protected void	renderSearchInStructureResult(AboveTableRendererContext ctx)
protected void	renderSimpleTableFrame(TableRenderContext ctx)
protected void	renderSubmitCancelButtons(TableFooterFrameRenderContext ctx) Renders the submit + cancel buttons within the footer frame
void	renderTableBody(TableBodyRenderContext ctx)
void	renderTableCalculationResult(CalculationResultRenderContext ctx)
protected void	renderTableCalculations(TableCalculationsRenderContext ctx)
protected void	renderTableCalculationsHeader(TableCalculationsRenderContext ctx, boolean currentPage)
protected boolean	renderTableCalculationsLabelOrEmptyCell(HtmlWriter writer, java.lang.String labelText, boolean label, int span)
protected void	renderTableCalculationsResults(TableCalculationsRenderContext ctx, boolean currentPage)
void	renderTableFooterFrame(TableFooterFrameRenderContext ctx) Renders the footer frame
protected void	renderTableFooterFrameBody(TableFooterFrameRenderContext ctx)
protected void	renderTableFooterFrameResources(TableFooterFrameRenderContext ctx) Renders the resources needed for the table-footer frame.
void	renderTableFrames(TableRenderContext ctx) Renders the frames in which the table body and header is rendered.
protected void	renderTableGroupHeaderContent(TableHeaderRenderContext ctx, boolean fakeRow)
protected void	renderTableGroupHeaderRowBegin(TableHeaderRenderContext ctx, boolean fakeRow)
protected void	renderTableGroupHeaderRowEnd(TableHeaderRenderContext ctx, boolean fakeRow)
protected void	renderTableGroupHeaders(TableHeaderRenderContext ctx)
protected void	renderTableGroupHeaders(TableHeaderRenderContext ctx, boolean fakeRow)
void	renderTableHeader(TableHeaderRenderContext ctx)
protected void	renderTableHeaderActions(TableHeaderRenderContext ctx)
protected void	renderTableHeaderActionsImpl(com.technia.tvc.structurebrowser.render.rowactions.RowActionsHeaderRenderContext ctx)
protected void	renderTableHeaderBegin(TableHeaderRenderContext ctx)
protected void	renderTableHeaderCell(TableCellHeaderRenderContext ctx)
protected void	renderTableHeaderCells(TableHeaderRenderContext ctx)
protected void	renderTableHeaderContent(TableHeaderRenderContext ctx)
protected void	renderTableHeaderEnd(TableHeaderRenderContext ctx)
protected void	renderTableHeaderGroup(TableHeaderRenderContext ctx) Checks if the group info column should be rendered.
protected void	renderTableHeaderGroupImpl(TableHeaderRenderContext ctx) Will render the header of the group info column.
protected void	renderTableHeaderRowCounter(TableHeaderRenderContext ctx)
protected void	renderTableHeaderSelection(TableHeaderRenderContext ctx)
protected void	renderTableHeaderSelectionImpl(TableHeaderRenderContext ctx)
protected void	renderTableHeaderStructure(TableHeaderRenderContext ctx) Checks if the structure column should be rendered.
protected void	renderTableHeaderStructureImpl(com.technia.tvc.structurebrowser.render.structure.StructureHeaderRenderContext ctx) Will render the header of the structure column.
void	renderTableInfoFrame(TableInfoFrameRenderContext ctx) Will render the whole "table info" frame.
protected void	renderTableInfoFrameBody(TableInfoFrameRenderContext ctx) Renders the content within the <body> tags within the table info frame.
protected void	renderTableInfoFrameResources(TableInfoFrameRenderContext ctx) Renders the resources needed for the table-info frame.
void	renderTableRow(TableBodyRowRenderContext ctx)
protected void	renderTableRowAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx, com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec spec)
protected void	renderTableRowActions(TableBodyRowRenderContext ctx)
protected void	renderTableRowActionsColumn(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx) This method is called when the row-actions are rendered into one common column.
protected void	renderTableRowActionsImpl(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx) This method is called when the row-actions are rendered into separate columns
protected void	renderTableRowBegin(TableBodyRowRenderContext ctx)
protected void	renderTableRowCell(TableCellRenderContext ctx)
protected void	renderTableRowCells(TableBodyRowRenderContext ctx)
protected void	renderTableRowContent(TableBodyRowRenderContext ctx)
protected void	renderTableRowCounter(TableBodyRowRenderContext ctx)
protected void	renderTableRowCounterImpl(TableBodyRowRenderContext ctx)
protected void	renderTableRowEnd(TableBodyRowRenderContext ctx)
protected void	renderTableRowGroup(TableBodyRowRenderContext ctx)
protected void	renderTableRowGroupImpl(TableBodyRowRenderContext ctx)
protected void	renderTableRowSelection(TableBodyRowRenderContext ctx)
protected void	renderTableRowSelectionImpl(TableBodyRowRenderContext ctx)
protected void	renderTableRowStructure(TableBodyRowRenderContext ctx)
protected void	renderTableRowStructureImpl(com.technia.tvc.structurebrowser.render.structure.StructureCellRenderContext ctx)
void	renderTableViewFrame(TableViewFrameRenderContext ctx) Renders the table-view frame (the lowest frame on a table page).
protected void	renderTableViewFrameBody(TableViewFrameRenderContext ctx)
protected void	renderTableViewFrameHead(TableViewFrameRenderContext ctx)
void	renderViewResources(TableResourceContext ctx) This method renders the resources that the table requires in the view frames.
protected static void	writeJavaScriptArrayField(HtmlWriter out, java.lang.String field, java.lang.String[] values) Helper method that renders a javascript array field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NBSP

public static final java.lang.String NBSP

Non-breaking space.

See Also:

Constant Field Values

Constructor Detail

TableRenderer

public TableRenderer()

Method Detail

getDefaultTableRenderer

public static TableRenderer getDefaultTableRenderer()

Returns the default TableRenderer.

Returns:

Returns the default TableRenderer.

Since:

6.1.0

getTableRenderer

public static TableRenderer getTableRenderer(TableBean<?> table)

Returns the renderer for a particular TableBean instance. Each TableBean can have their own TableRenderer instance assigned to them. If no renderer has been set explicitly the default renderer will be returned.

Parameters:

table - The table whose renderer we should get.

Returns:

Returns the renderer for this table.

Since:

6.1.0

addFramesetFrame

protected void addFramesetFrame(TableFramesetRendererContext ctx,
                                java.lang.String divClass,
                                java.lang.String frameName,
                                java.lang.String frameURL)

addFramesetFrame

protected void addFramesetFrame(TableFramesetRendererContext ctx,
                                java.lang.String divClass,
                                java.lang.String frameName,
                                java.lang.String frameURL,
                                java.lang.String divId)

addFramesetHiddenFrames

protected void addFramesetHiddenFrames(TableFramesetRendererContext ctx)

addResourcesFromTableCellRenderers

protected void addResourcesFromTableCellRenderers(TableResourceContext ctx,
                                                  java.util.Collection<Resource> resources)

getAdditionalColumnCount

protected int getAdditionalColumnCount(TableCalculationsRenderContext ctx)

getHasRowActionColumn

protected boolean getHasRowActionColumn(TableBean<?> tableBean,
                                        int mode)

Returns true if there are any columns that should be moved into the actions menu.

Parameters:

tableBean - The current TableBean

mode - The current table mode

Returns:

True if so

Since:

2012.1.0

getAddTidy

protected boolean getAddTidy(TableFramesetRendererContext ctx)

getBuildStructureConfiguration

protected BuildStructureConfiguration getBuildStructureConfiguration(TableRenderContext ctx)

getCalculationsHeader

protected java.lang.String getCalculationsHeader(TableCalculationResults results,
                                                 boolean currentPage,
                                                 java.util.Locale locale)

getContextFactory

public com.technia.tvc.structurebrowser.render.ContextFactory getContextFactory()

getDefaultTableCellRenderer

protected TableCellRenderer getDefaultTableCellRenderer()

Returns the default TableCellRenderer.

Returns:

Returns the default TableCellRenderer.

Since:

6.1.0

getFrameURL

protected java.lang.String getFrameURL(TableRenderContext ctx,
                                       java.lang.String actionName,
                                       java.lang.String path,
                                       java.lang.String targetForward,
                                       boolean searchResult)

getStructureRenderer

protected com.technia.tvc.structurebrowser.render.structure.StructureRenderer getStructureRenderer(TableRenderContext ctx,
                                                                                                   com.technia.tvc.structurebrowser.render.structure.StructureTheme theme)

Returns the StructureRenderer that should be used.

Parameters:

ctx - The rendering context.

theme - The structure theme.

Returns:

Returns the StructureRenderer.

Since:

6.1.0

See Also:

StructureTheme.getRenderer(), QueryStructureRenderer

getTableCellClass

protected java.lang.String getTableCellClass(TableCellRenderContext ctx)

getTableCellRenderer

protected TableCellRenderer getTableCellRenderer(Column column)

Returns the TableCellRenderer that should be used for the specified column.

Parameters:

column - A column being rendered.

Returns:

Returns the TableCellRenderer that should be used for this column.

Since:

6.1.0

getTableGroupHeaderRowClass

protected java.lang.String getTableGroupHeaderRowClass(TableHeaderRenderContext ctx)

getTableHeaderClass

protected java.lang.String getTableHeaderClass(TableCellHeaderRenderContext ctx)

getTableRowClass

protected java.lang.String getTableRowClass(TableBodyRowRenderContext ctx)

getTableRowId

protected java.lang.String getTableRowId(TableBodyRowRenderContext ctx)

getTableRowSelectionValue

protected java.lang.String getTableRowSelectionValue(TableBodyRowRenderContext ctx)

hasPageHeader

protected boolean hasPageHeader(PageHeaderRenderContext ctx)

hasPageSubHeader

protected boolean hasPageSubHeader(PageHeaderRenderContext ctx)

initExport

protected void initExport(HTMLExportContext ctx)

isRenderContextMenu

protected boolean isRenderContextMenu(TableBodyRowRenderContext ctx)

isRenderGroupHeader

protected boolean isRenderGroupHeader(TableHeaderRenderContext ctx)

renderAboveTable

public void renderAboveTable(AboveTableRendererContext ctx)

This method is called to render content above the table but below the table buttons.

Parameters:

ctx - The rendering context.

Since:

6.1.0

renderFinder

protected void renderFinder(AboveTableRendererContext ctx)

Renders the finder feature above the table.

Parameters:

ctx -

Since:

2013.3.0

renderInlineCompare

protected void renderInlineCompare(AboveTableRendererContext ctx)

renderGroupPageLegend

protected void renderGroupPageLegend(AboveTableRendererContext ctx)

renderSearchInStructureResult

protected void renderSearchInStructureResult(AboveTableRendererContext ctx)

renderInlineSearchForm

protected void renderInlineSearchForm(AboveTableRendererContext ctx)

renderContextMenuResources

protected void renderContextMenuResources(TableResourceContext ctx)

Renders the resources needed for the context menu.

Parameters:

ctx - The context

renderErrors

protected void renderErrors(TableRenderContext ctx)

renderFrameset

public void renderFrameset(TableFramesetRendererContext ctx)

Renders the (top-level) frameset.

Parameters:

ctx -

Since:

2009.1.0

renderCollaborationContent

protected void renderCollaborationContent(TableFramesetRendererContext ctx)

renderFramesetPageContent

protected void renderFramesetPageContent(TableFramesetRendererContext ctx)

renderFramesetContent

protected void renderFramesetContent(TableFramesetRendererContext ctx)

renderFrameGliderDraggingIcon

protected void renderFrameGliderDraggingIcon(TableFramesetRendererContext ctx)

renderDragIcon

protected void renderDragIcon(TableFramesetRendererContext ctx,
                              java.lang.String id,
                              com.technia.tvc.core.gui.theme.Icon icon)

getFrameGliderImage

protected com.technia.tvc.core.gui.theme.Icon getFrameGliderImage(TableRenderContext ctx,
                                                                  java.lang.String param,
                                                                  java.lang.String defaultIcon)

getFrameGliderConnectIcon

protected com.technia.tvc.core.gui.theme.Icon getFrameGliderConnectIcon(TableRenderContext ctx)

getFrameGliderRearrangeIcon

protected com.technia.tvc.core.gui.theme.Icon getFrameGliderRearrangeIcon(TableRenderContext ctx)

renderFramesetResources

protected void renderFramesetResources(TableFramesetRendererContext ctx)

renderMassUpdateField

public void renderMassUpdateField(MassUpdateRenderContext ctx)

renderMassUpdateResources

public void renderMassUpdateResources(MassUpdateResourceContext ctx)

Renders the resources required for the mass update function.

Parameters:

ctx - The rendering context.

Since:

6.1.0

renderPageHeaders

public void renderPageHeaders(PageHeaderRenderContext ctx)

renderPageHeader

protected void renderPageHeader(PageHeaderRenderContext ctx)

renderPageHeadersImpl

protected void renderPageHeadersImpl(PageHeaderRenderContext ctx)

renderPageHeadersPrinterFriendlyImpl

protected void renderPageHeadersPrinterFriendlyImpl(PageHeaderRenderContext ctx)

renderPageSubHeader

protected void renderPageSubHeader(PageHeaderRenderContext ctx)

renderPageTitle

public void renderPageTitle(PageHeaderRenderContext ctx)

renderPaginationControls

protected void renderPaginationControls(TableFooterFrameRenderContext ctx)

Renders the pagination controls within the footer frame

Parameters:

ctx -

Since:

6.4.2

isContextMenuDynamic

protected boolean isContextMenuDynamic(TableRenderContext ctx)

Parameters:

ctx - The current context

Returns:

True if the context menu is dynamic (or should be).

Since:

2010.1.0

isContextMenuCachingEnabled

protected boolean isContextMenuCachingEnabled(TableRenderContext ctx)

Parameters:

ctx - The current context

Returns:

True if we will cache the information (at the client) about the visibility of the context menu components (per row).

Since:

2010.1.0

renderParentResources

public void renderParentResources(TableResourceContext ctx)

This method renders the resources that the table requires in the parent frame.

Parameters:

ctx - The rendering context.

Since:

6.1.0

renderDynamicParentResources

protected void renderDynamicParentResources(TableResourceContext ctx)

isPartialUpdateSupported

protected boolean isPartialUpdateSupported(TableRenderContext ctx)

Parameters:

ctx -

Returns:

If partial updates is supported.

Since:

2010.2.0

renderDimensionInfo

protected void renderDimensionInfo(TableResourceContext ctx)

renderAboveTableMessages

protected void renderAboveTableMessages(TableResourceContext ctx)

renderPopupCellValue

public void renderPopupCellValue(PopupCellValueRenderContext ctx)

renderResources

protected void renderResources(TableRenderContext ctx,
                               Resource... resources)

renderResources

protected void renderResources(TableRenderContext ctx,
                               java.util.Collection<Resource> resources)

renderSubmitCancelButtons

protected void renderSubmitCancelButtons(TableFooterFrameRenderContext ctx)

Renders the submit + cancel buttons within the footer frame

Parameters:

ctx -

Since:

6.4.2

renderParentForm

public void renderParentForm(TableRenderContext ctx)

Renders the form inside the "parent" frame

Parameters:

ctx - The context

Since:

2010.2.0

renderTableViewFrame

public void renderTableViewFrame(TableViewFrameRenderContext ctx)

Renders the table-view frame (the lowest frame on a table page). This will be invoked both for standard/simple layout as well as for a printer friendly page.

Parameters:

ctx - The context

Since:

2010.2.0

renderTableViewFrameHead

protected void renderTableViewFrameHead(TableViewFrameRenderContext ctx)

renderPrinterFriendlyFrameBody

protected void renderPrinterFriendlyFrameBody(TableViewFrameRenderContext ctx)

Renders the body content of the printer friendly body frame

Parameters:

ctx - The context

Since:

2010.2.0

renderTableViewFrameBody

protected void renderTableViewFrameBody(TableViewFrameRenderContext ctx)

renderTableBody

public void renderTableBody(TableBodyRenderContext ctx)

renderEmptyTableBody

protected void renderEmptyTableBody(TableBodyRenderContext ctx)

Renders the table body in case the table is "empty"

Parameters:

ctx - The context

Since:

2010.2.0

getEmptyTableMessage

protected java.lang.String getEmptyTableMessage(TableRenderContext ctx)

This method returns null by default in order to force writing the default message. Subclasses can return an arbitrary string, which will be used over the default message.

I forgot to mention, but this is the message that is shown when the table is empty...

Parameters:

ctx - The context

Since:

2010.2.0

renderTableCalculationResult

public void renderTableCalculationResult(CalculationResultRenderContext ctx)

renderTableCalculations

protected void renderTableCalculations(TableCalculationsRenderContext ctx)

renderTableCalculationsHeader

protected void renderTableCalculationsHeader(TableCalculationsRenderContext ctx,
                                             boolean currentPage)

renderTableCalculationsLabelOrEmptyCell

protected boolean renderTableCalculationsLabelOrEmptyCell(HtmlWriter writer,
                                                          java.lang.String labelText,
                                                          boolean label,
                                                          int span)

renderTableCalculationsResults

protected void renderTableCalculationsResults(TableCalculationsRenderContext ctx,
                                              boolean currentPage)

renderParentFrame

public void renderParentFrame(TableParentFrameRenderContext ctx)

Renders the parent frame.

Parameters:

ctx - The context

Since:

2011.2.0

getToolbarLayoutManager

public com.technia.tvc.structurebrowser.render.toolbar.ToolbarLayoutManager getToolbarLayoutManager(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addToolbarContainer

protected void addToolbarContainer(TableRenderContext ctx,
                                   com.technia.tvc.core.gui.toolbar.Toolbar toolbar)

renderTableFooterFrame

public void renderTableFooterFrame(TableFooterFrameRenderContext ctx)

Renders the footer frame

Parameters:

ctx -

Since:

6.4.1

renderTableFooterFrameBody

protected void renderTableFooterFrameBody(TableFooterFrameRenderContext ctx)

renderTableFooterFrameResources

protected void renderTableFooterFrameResources(TableFooterFrameRenderContext ctx)

Renders the resources needed for the table-footer frame.

Parameters:

ctx - The context

Since:

6.4.2

renderTableFrames

public void renderTableFrames(TableRenderContext ctx)

Renders the frames in which the table body and header is rendered. In optimized layout this method will render a single frame while in standard layout it will render four separate frames.

Parameters:

ctx - The current rendering context.

Since:

6.1.0

renderSimpleTableFrame

protected void renderSimpleTableFrame(TableRenderContext ctx)

renderTableGroupHeaderContent

protected void renderTableGroupHeaderContent(TableHeaderRenderContext ctx,
                                             boolean fakeRow)

renderTableGroupHeaderRowBegin

protected void renderTableGroupHeaderRowBegin(TableHeaderRenderContext ctx,
                                              boolean fakeRow)

renderTableGroupHeaderRowEnd

protected void renderTableGroupHeaderRowEnd(TableHeaderRenderContext ctx,
                                            boolean fakeRow)

renderTableGroupHeaders

protected void renderTableGroupHeaders(TableHeaderRenderContext ctx)

renderTableGroupHeaders

protected void renderTableGroupHeaders(TableHeaderRenderContext ctx,
                                       boolean fakeRow)

renderTableHeader

public void renderTableHeader(TableHeaderRenderContext ctx)

renderTableHeaderActions

protected void renderTableHeaderActions(TableHeaderRenderContext ctx)

renderTableHeaderActionsImpl

protected void renderTableHeaderActionsImpl(com.technia.tvc.structurebrowser.render.rowactions.RowActionsHeaderRenderContext ctx)

renderEmptyTableHeaderColumn

protected void renderEmptyTableHeaderColumn(TableRenderContext ctx)

renderTableHeaderBegin

protected void renderTableHeaderBegin(TableHeaderRenderContext ctx)

renderTableHeaderCell

protected void renderTableHeaderCell(TableCellHeaderRenderContext ctx)

isRenderedAsNavigationCell

protected boolean isRenderedAsNavigationCell(TableRenderContext ctx,
                                             Column column)

renderTableHeaderCells

protected void renderTableHeaderCells(TableHeaderRenderContext ctx)

renderTableHeaderContent

protected void renderTableHeaderContent(TableHeaderRenderContext ctx)

renderTableHeaderEnd

protected void renderTableHeaderEnd(TableHeaderRenderContext ctx)

renderTableHeaderGroup

protected void renderTableHeaderGroup(TableHeaderRenderContext ctx)

Checks if the group info column should be rendered. If yes, it will call renderTableHeaderGroupImpl(TableHeaderRenderContext) to do the rendering.

Parameters:

ctx - The rendering context.

Since:

6.1.0

renderTableHeaderGroupImpl

protected void renderTableHeaderGroupImpl(TableHeaderRenderContext ctx)

Will render the header of the group info column.

Parameters:

ctx - The rendering context.

Since:

6.3.0

renderTableHeaderRowCounter

protected void renderTableHeaderRowCounter(TableHeaderRenderContext ctx)

renderTableHeaderSelection

protected void renderTableHeaderSelection(TableHeaderRenderContext ctx)

renderTableHeaderSelectionImpl

protected void renderTableHeaderSelectionImpl(TableHeaderRenderContext ctx)

renderTableHeaderStructure

protected void renderTableHeaderStructure(TableHeaderRenderContext ctx)

Checks if the structure column should be rendered. If yes, it will call renderTableHeaderStructureImpl(StructureHeaderRenderContext) to do the rendering.

Parameters:

ctx - The rendering context.

Since:

6.1.0

renderTableHeaderStructureImpl

protected void renderTableHeaderStructureImpl(com.technia.tvc.structurebrowser.render.structure.StructureHeaderRenderContext ctx)

Will render the header of the structure column.

Parameters:

ctx - The rendering context.

Since:

6.1.0

See Also:

getStructureRenderer(TableRenderContext, StructureTheme)

renderTableInfoFrame

public void renderTableInfoFrame(TableInfoFrameRenderContext ctx)

Will render the whole "table info" frame. E.g. the top frame within the table frameset.

Parameters:

ctx - The context

Since:

6.4.2

renderTableInfoFrameBody

protected void renderTableInfoFrameBody(TableInfoFrameRenderContext ctx)

Renders the content within the <body> tags within the table info frame.

Parameters:

ctx - The context

Since:

6.4.2

renderTableInfoFrameResources

protected void renderTableInfoFrameResources(TableInfoFrameRenderContext ctx)

Renders the resources needed for the table-info frame.

Parameters:

ctx - The context

Since:

6.4.2

renderTableRow

public void renderTableRow(TableBodyRowRenderContext ctx)

renderTableRowActions

protected void renderTableRowActions(TableBodyRowRenderContext ctx)

renderTableRowActionsColumn

protected void renderTableRowActionsColumn(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

This method is called when the row-actions are rendered into one common column.

Parameters:

ctx - The current RowActionsBodyRenderContext

Since:

2012.1.0

getTableRowActionSpecs

protected java.util.List<com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec> getTableRowActionSpecs(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

Returns a list of RowActionSpec that should be rendered. This method is only queried if the method isRenderTableRowActionsInSeparateColumns(TableBean) returns false.

Parameters:

ctx - The current RowActionsBodyRenderContext

Returns:

A list of RowActionSpec instances.

Since:

2012.1.0

isRenderTableRowActionsInSeparateColumns

public boolean isRenderTableRowActionsInSeparateColumns(TableBean<?> tableBean)

Returns true if row actions are rendered in separate columns. False is returned in case they are aggregated into one common column.

Parameters:

tableBean - The current table

Returns:

True if so. False otherwise.

Since:

2012.1.0

See Also:

EnvironmentUtils.isRenderTableRowActionsInSeparateColumns(Environment)

isRenderedAsRowAction

public boolean isRenderedAsRowAction(TableBean<?> tableBean,
                                     Cell cell)

Returns true if the cell is moved to the row-actions menu.

This method will return false if isRenderTableRowActionsInSeparateColumns(TableBean) returns true or the column related to this cell doesn't have the setting applied.

Parameters:

tableBean - The current table

cell - The current Cell

Returns:

True if to render the the cell within the row-action area.

Since:

2012.1.0

isRenderedAsRowAction

public boolean isRenderedAsRowAction(TableBean<?> tableBean,
                                     Column column)

Returns true if the cells for this column is configured to be rendered within the row actions menu.

This method will return false if isRenderTableRowActionsInSeparateColumns(TableBean) returns true or the column doesn't have the setting applied.

Parameters:

tableBean - The current table

column - The current Column

Returns:

True if to render the the cells for the column argument within the row-action area.

Since:

2012.1.0

renderTableRowActionsImpl

protected void renderTableRowActionsImpl(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

This method is called when the row-actions are rendered into separate columns

Parameters:

ctx -

renderGoThereAction

protected void renderGoThereAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

getGoThereRowActionSpec

protected com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec getGoThereRowActionSpec(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

getGoThereAction

protected java.lang.String getGoThereAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

getGoThereTooltipKey

protected java.lang.String getGoThereTooltipKey(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

renderAddToClipboardAction

protected void renderAddToClipboardAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

getAddToClipboardRowActionSpec

protected com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec getAddToClipboardRowActionSpec(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

renderGoRearrangeAction

protected void renderGoRearrangeAction(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

Parameters:

ctx -

Since:

2011.2.0

getGoRearrangeRowActionSpec

protected com.technia.tvc.structurebrowser.render.rowactions.RowActionSpec getGoRearrangeRowActionSpec(com.technia.tvc.structurebrowser.render.rowactions.RowActionsBodyRenderContext ctx)

Parameters:

ctx -

Returns:

The go-rearrange row action specification

Since:

2011.2.0

renderTableRowAction

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

renderTableRowBegin

protected void renderTableRowBegin(TableBodyRowRenderContext ctx)

renderTableRowCell

protected void renderTableRowCell(TableCellRenderContext ctx)

renderTableRowCells

protected void renderTableRowCells(TableBodyRowRenderContext ctx)

renderTableRowContent

protected void renderTableRowContent(TableBodyRowRenderContext ctx)

renderTableRowCounter

protected void renderTableRowCounter(TableBodyRowRenderContext ctx)

renderTableRowCounterImpl

protected void renderTableRowCounterImpl(TableBodyRowRenderContext ctx)

renderDragHandleBegin

protected boolean renderDragHandleBegin(TableBodyRowRenderContext ctx)

The drag handle is rendered within the first column of a nested table inside the cell. The second cell is reserved for the content (either the row number indicator, or the checkbox/radio button).

Parameters:

ctx - The current context

Since:

2011.1.0

renderDragHandleEnd

protected void renderDragHandleEnd(TableBodyRowRenderContext ctx)

renderTableRowEnd

protected void renderTableRowEnd(TableBodyRowRenderContext ctx)

renderTableRowGroup

protected void renderTableRowGroup(TableBodyRowRenderContext ctx)

renderTableRowGroupImpl

protected void renderTableRowGroupImpl(TableBodyRowRenderContext ctx)

renderTableRowSelection

protected void renderTableRowSelection(TableBodyRowRenderContext ctx)

renderTableRowSelectionImpl

protected void renderTableRowSelectionImpl(TableBodyRowRenderContext ctx)

renderTableRowStructure

protected void renderTableRowStructure(TableBodyRowRenderContext ctx)

renderTableRowStructureImpl

protected void renderTableRowStructureImpl(com.technia.tvc.structurebrowser.render.structure.StructureCellRenderContext ctx)

renderViewResources

public void renderViewResources(TableResourceContext ctx)

This method renders the resources that the table requires in the view frames.

Parameters:

ctx - The rendering context.

Since:

6.1.0

getDroppableOnOverClass

protected java.lang.String getDroppableOnOverClass(TableResourceContext ctx)

writeJavaScriptArrayField

protected static void writeJavaScriptArrayField(HtmlWriter out,
                                                java.lang.String field,
                                                java.lang.String[] values)

Helper method that renders a javascript array field.

Parameters:

out - The HtmlWriter to write to.

field - The name of the field.

values - The array of values that the field should hold.

Since:

6.1.0

addMsgAsJS

protected static void addMsgAsJS(HtmlWriter out,
                                 java.util.Locale l,
                                 java.lang.String variable,
                                 java.lang.String resourceKey)

Adds a Java Script variable holding a translated text.

Parameters:

out - The HtmlWriter that we will write into

l - The users locale

variable - The name of the Java Script variable that will hold the translated text.

resourceKey - The resource-key, under which the tranlsated string is found

exportTable

public void exportTable(ExportContext ctx)

Exports the table. Depending on type of ExportContext, different method is invoked. This method is invoked when the user performed the table export.

Parameters:

ctx - The ExportContext.

See Also:

exportTable(TextExportContext), exportTable(XMLExportContext), exportTable(HTMLExportContext), exportTable(PDFExportContext), exportTable(SpreadsheetExportContext)

exportTable

@Deprecated
protected void exportTable(HTMLExportContext ctx)

Deprecated. The native excel export makes the use of this HTML format redundant.

Exports the table into Excel/HTML format

See Also:

exportTable(SpreadsheetExportContext)

exportTable

protected void exportTable(SpreadsheetExportContext ctx)

Export of a table into a spreadsheet format (typically Excel but in the future we might add support for Open Office).

Parameters:

ctx - The SpreadsheetExportContext.

Since:

2010.3.0

exportTable

protected void exportTable(PDFExportContext ctx)

Exports a table into PDF format

Parameters:

ctx - The PDFExportContext

exportTable

protected void exportTable(TextExportContext ctx)

Exports a table into text (CSV or Text)

Parameters:

ctx - The TextExportContext

exportTable

protected void exportTable(XMLExportContext ctx)

Exports a table into XML format

Parameters:

ctx - THe XMLExportContext

exportTableBody

protected void exportTableBody(SpreadsheetExportContext ctx)

exportTableBody

protected void exportTableBody(HTMLExportContext ctx)

exportTableBody

protected void exportTableBody(XMLExportContext ctx)

exportTableColumn

protected void exportTableColumn(PDFExportCellHeaderContext ctx)

exportTableHeader

protected void exportTableHeader(SpreadsheetExportCellHeaderContext ctx)

exportTableHeader

protected void exportTableHeader(HTMLExportContext ctx)

exportTableHeader

protected void exportTableHeader(TextExportContext ctx)

exportTableHeader

protected void exportTableHeader(XMLExportContext ctx)

exportTableHeaderBegin

protected void exportTableHeaderBegin(HTMLExportContext ctx)

exportTableHeaderBegin

protected void exportTableHeaderBegin(TextExportContext ctx)

exportTableHeaderBegin

protected void exportTableHeaderBegin(XMLExportContext ctx)

exportTableHeaderCell

protected void exportTableHeaderCell(HTMLExportCellHeaderContext ctx)

exportTableHeaderCell

protected void exportTableHeaderCell(TextExportCellHeaderContext ctx)

exportTableHeaderCell

protected void exportTableHeaderCell(XMLExportCellHeaderContext ctx)

exportTableHeaderCells

protected void exportTableHeaderCells(HTMLExportContext ctx)

exportTableHeaderCells

protected void exportTableHeaderCells(PDFExportContext ctx)

exportTableHeaderCells

protected void exportTableHeaderCells(TextExportContext ctx)

exportTableHeaderCells

protected void exportTableHeaderCells(XMLExportContext ctx)

exportTableHeaderContent

protected void exportTableHeaderContent(HTMLExportContext ctx)

exportTableHeaderContent

protected void exportTableHeaderContent(SpreadsheetExportContext ctx)

exportTableHeaderContent

protected void exportTableHeaderContent(PDFExportContext ctx)

exportTableHeaderContent

protected void exportTableHeaderContent(TextExportContext ctx)

exportTableHeaderContent

protected void exportTableHeaderContent(XMLExportContext ctx)

exportTableHeaderEnd

protected void exportTableHeaderEnd(HTMLExportContext ctx)

exportTableHeaderEnd

protected void exportTableHeaderEnd(TextExportContext ctx)

exportTableHeaderEnd

protected void exportTableHeaderEnd(XMLExportContext ctx)

exportTableHeaderGroup

protected void exportTableHeaderGroup(HTMLExportContext ctx)

exportTableHeaderGroup

protected void exportTableHeaderGroup(PDFExportContext ctx)

exportTableHeaderGroup

protected void exportTableHeaderGroup(TextExportContext ctx)

exportTableHeaderGroup

protected void exportTableHeaderGroup(XMLExportContext ctx)

exportTableHeaderGroupImpl

protected void exportTableHeaderGroupImpl(HTMLExportContext ctx)

exportTableHeaderGroupImpl

protected void exportTableHeaderGroupImpl(XMLExportContext ctx)

exportTableHeaderStructure

protected void exportTableHeaderStructure(HTMLExportContext ctx)

exportTableHeaderStructure

protected void exportTableHeaderStructure(TextExportContext ctx)

exportTableImpl

protected void exportTableImpl(HTMLExportContext ctx)

exportTableRow

protected void exportTableRow(SpreadsheetExportRowContext ctx)

exportTableRow

protected void exportTableRow(HTMLExportRowContext ctx)

exportTableRow

protected void exportTableRow(TextExportRowContext ctx)

exportTableRow

protected void exportTableRow(XMLExportRowContext ctx)

exportTableRowBegin

protected void exportTableRowBegin(SpreadsheetExportRowContext ctx)

exportTableRowBegin

protected void exportTableRowBegin(HTMLExportRowContext ctx)

exportTableRowBegin

protected void exportTableRowBegin(PDFExportRowContext ctx)

exportTableRowBegin

protected void exportTableRowBegin(TextExportRowContext ctx)

exportTableRowBegin

protected void exportTableRowBegin(XMLExportRowContext ctx)

exportTableRowCell

protected void exportTableRowCell(SpreadsheetExportCellContext ctx)

exportTableRowCell

protected void exportTableRowCell(HTMLExportCellContext ctx)

exportTableRowCell

protected void exportTableRowCell(PDFExportCellContext ctx)

exportTableRowCell

protected void exportTableRowCell(TextExportCellContext ctx)

exportTableRowCell

protected void exportTableRowCell(XMLExportCellContext ctx)

exportTableRowCells

protected void exportTableRowCells(HTMLExportRowContext ctx)

exportTableRowCells

protected void exportTableRowCells(PDFExportRowContext ctx)

exportTableRowCells

protected void exportTableRowCells(TextExportRowContext ctx)

exportTableRowCells

protected void exportTableRowCells(XMLExportRowContext ctx)

exportTableRowCells

protected void exportTableRowCells(SpreadsheetExportRowContext ctx)

exportTableRowContent

protected void exportTableRowContent(SpreadsheetExportRowContext ctx)

exportTableRowContent

protected void exportTableRowContent(HTMLExportRowContext ctx)

exportTableRowContent

protected void exportTableRowContent(PDFExportRowContext ctx)

exportTableRowContent

protected void exportTableRowContent(TextExportRowContext ctx)

exportTableRowContent

protected void exportTableRowContent(XMLExportRowContext ctx)

exportTableRowEnd

protected void exportTableRowEnd(SpreadsheetExportRowContext ctx)

exportTableRowEnd

protected void exportTableRowEnd(HTMLExportRowContext ctx)

exportTableRowEnd

protected void exportTableRowEnd(PDFExportRowContext ctx)

exportTableRowEnd

protected void exportTableRowEnd(TextExportRowContext ctx)

exportTableRowEnd

protected void exportTableRowEnd(XMLExportRowContext ctx)

exportTableRowGroup

protected void exportTableRowGroup(HTMLExportRowContext ctx)

exportTableRowGroup

protected void exportTableRowGroup(PDFExportRowContext ctx)

exportTableRowGroup

protected void exportTableRowGroup(TextExportRowContext ctx)

exportTableRowGroup

protected void exportTableRowGroup(XMLExportRowContext ctx)

exportTableRows

protected void exportTableRows(PDFExportContext ctx)

exportTableRows

protected void exportTableRows(TextExportContext ctx)

exportTableRows

protected void exportTableRows(XMLExportContext ctx)

exportTableRowStructure

protected void exportTableRowStructure(HTMLExportRowContext ctx)

exportTableRowStructure

protected void exportTableRowStructure(TextExportRowContext ctx)

exportTableCalculations

protected void exportTableCalculations(SpreadsheetExportContext ctx)

renderInCellEdit

public void renderInCellEdit(TableBodyRenderContext rc,
                             long dataid,
                             int columnIndex,
                             boolean edit)

getInCellEditCellRenderContext

protected TableCellRenderContext getInCellEditCellRenderContext(TableBodyRenderContext rc,
                                                                long dataid,
                                                                int columnIndex,
                                                                boolean edit)

isTableRowActionsCombinedMouseOverEnabled

public boolean isTableRowActionsCombinedMouseOverEnabled(TableBean<?> tableBean)

Returns true if mouseover should be enabled when row actions are rendered as aggregated into one common column. Setting applicable only when Table row actions are combined.

Parameters:

tableBean - The current table

Returns:

True if so. False otherwise.

Since:

2015.3.0

See Also:

EnvironmentUtils.isTableRowActionsCombinedMouseOverEnabled(Environment)

addLaunchFromPortalButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addLaunchFromPortalButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addSearchButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addSearchButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addFinderButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addFinderButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addWrapButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addWrapButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addUnwrapButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addUnwrapButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addCompareButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addCompareButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addTriggerValidationButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addTriggerValidationButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addPromoteButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addPromoteButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addDemoteButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addDemoteButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addPrinterFriendlyButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addPrinterFriendlyButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addExportButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addExportButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addPreferencesButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addPreferencesButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addHelpButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addHelpButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

beforeToolbarLayout

public void beforeToolbarLayout(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

afterToolbarLayout

public void afterToolbarLayout(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addMaximizeButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addMaximizeButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

Adds the maximize button.

Parameters:

ctx - The rendering context.

addGoBackButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addGoBackButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addSeparator

public com.technia.tvc.core.gui.toolbar.ToolbarItem addSeparator(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addToolbarMenu

public com.technia.tvc.core.gui.toolbar.ToolbarItem addToolbarMenu(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addViewChooser

public com.technia.tvc.core.gui.toolbar.ToolbarItem addViewChooser(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addTableChooser

public com.technia.tvc.core.gui.toolbar.ToolbarItem addTableChooser(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addFilterChooser

public com.technia.tvc.core.gui.toolbar.ToolbarItem addFilterChooser(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addTableConfiguratorButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addTableConfiguratorButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addReloadButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addReloadButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addAdvancedSortButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addAdvancedSortButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addFullExpandButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addFullExpandButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addFlattenStructureButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addFlattenStructureButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addDisconnectButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addDisconnectButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addChartButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addChartButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addDataGroupButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addDataGroupButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addAddToClipboardButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addAddToClipboardButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

Parameters:

ctx - The current context

Returns:

The menu item used for the add-to-clipboard

Since:

2016.1.0

addAddToCollectionButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addAddToCollectionButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

Parameters:

ctx - The current context

Returns:

The menu item used for the add-to-collection

Since:

2016.1.0

addOpenClipboardButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addOpenClipboardButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

Parameters:

ctx - The current context

Returns:

The menu item used for the view-clipboard

Since:

2016.1.0

addManageCollectionsButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addManageCollectionsButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

Parameters:

ctx - The current context

Returns:

The menu item used for the manage-collections

Since:

2016.1.0

addToggleToReadButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addToggleToReadButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

Adds the toggle to read button.

Parameters:

ctx - The rendering context.

addToggleToEditButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addToggleToEditButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

Adds the toggle to edit button.

Parameters:

ctx - The rendering context.

addBuildStructureRelationshipChooser

public com.technia.tvc.core.gui.toolbar.ToolbarItem addBuildStructureRelationshipChooser(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addBuildStructureRelationshipDirection

public com.technia.tvc.core.gui.toolbar.ToolbarItem addBuildStructureRelationshipDirection(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addBuildStructureConnectButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addBuildStructureConnectButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addBuildStructureReplaceButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addBuildStructureReplaceButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addBuildStructureMoveButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addBuildStructureMoveButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx)

addTooolbarItem

public com.technia.tvc.core.gui.toolbar.ToolbarItem addTooolbarItem(com.technia.tvc.structurebrowser.render.ToolbarRenderContext ctx,
                                                                    java.lang.String name,
                                                                    java.util.Map<java.lang.String,java.lang.String> attributes)

createToolbarComponentFilter

protected ComponentFilter createToolbarComponentFilter(TableRenderContext ctx)

createToolbarParameterProvider

protected ParameterProvider createToolbarParameterProvider(TableRenderContext ctx)

addInlineCompareButton

public com.technia.tvc.core.gui.toolbar.ToolbarItem addInlineCompareButton(com.technia.tvc.structurebrowser.render.ToolbarRenderContext context)