de.hybris.platform.print.jalo.table

Class TableBlock

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.print.jalo.GeneratedContentBlock

de.hybris.platform.print.jalo.ContentBlock

de.hybris.platform.print.jalo.table.GeneratedTableBlock

de.hybris.platform.print.jalo.table.TableBlock

All Implemented Interfaces:

Serializable, Comparable

public class TableBlock
extends GeneratedTableBlock

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
static String	TABLE_INIT_PARAMETERS Session attribute name.

Fields inherited from class de.hybris.platform.print.jalo.table.GeneratedTableBlock

ALLTABLETEMPLATES, CELLS, CELLSHANDLER, COLUMNS, COLUMNSHANDLER, DEFAULT_INITIAL_ATTRIBUTES, FOOTERROWCOUNT, HEADERROWCOUNT, ISTEMPLATE, LOCKED, ROWS, ROWSHANDLER, TABLEDATAHOLDERS, TABLEDATAHOLDERSHANDLER, TABLESTYLE, TABLETEMPLATE, WIDTH, WIDTHTYPE

Fields inherited from class de.hybris.platform.print.jalo.GeneratedContentBlock

CATALOGVERSION, CATEGORIES, CATEGORY2CONTENTBLOCKRELATION_MARKMODIFIED, CATEGORY2CONTENTBLOCKRELATION_SRC_ORDERED, CATEGORY2CONTENTBLOCKRELATION_TGT_ORDERED, CODE, NAME, RENDEREDCONTENT

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
TableBlock()

Method Summary

Modifier and Type	Method and Description
Object	computeCellRawValue(CellEntry cell, Object rowData, Object columnData)
CellStyle	computeCellStyle(CellEntry cell, RowEntry row, Object rowData, int rowDataIndex, int rowDataCount, ColumnEntry column, Object columnData, int colDataIndex, int colDataCount, ExpressionContext initialContext)
String	computeCellValue(CellEntry cell, Object rawValue, Object rowData, int rowDataIndex, int rowDataCount, Object columnData, int colDataIndex, int colDataCount, ExpressionContext initialContext)
double	computeColWidth(ColumnEntry column, int colDataIndex, int colDataCount, ExpressionContext initialContext)
String	computeExtendedStyle(CellEntry cell, RowEntry row, Object rowData, int rowDataIndex, int rowDataCount, ColumnEntry column, Object columnData, int colDataIndex, int colDataCount, ExpressionContext initialContext)
PrintTable	computePrintTable()
List<Object>	getAllAxisData(AxisEntry axis)
Collection<TableBlock>	getAllTableTemplates(SessionContext ctx) Generated method - Getter of the TableBlock.allTableTemplates attribute.
Object	getAxisData(AxisEntry axis, int index)
PrintTable	getCachedPrintTable() Returns cached PrintTable.
static CellEntry	getCellEntry(ColumnEntry column, RowEntry row)
List<ColumnEntry>	getColumnsConsideringTemplate()
TableDataHolder	getDataHolderConsideringTemplate()
AxisDataHolder	getDataHolderConsideringTemplate(AxisEntry axis)
CellDataHolder	getDataHolderConsideringTemplate(CellEntry cell)
Map<String,Object>	getGlobalParameterValues()
String	getRenderedContent(SessionContext ctx) Generated method - Getter of the ContentBlock.renderedContent attribute.
List<RowEntry>	getRowsConsideringTemplate()
TableBlock	getTableOrTemplate()
boolean	isUsedAsTemplate()
void	remove(SessionContext ctx) Removes this item.
String	renderHTML()
String	renderHTML(SessionContext ctx)
String	renderInDesign()
String	renderInDesign(SessionContext ctx)
void	setCatalogVersion(SessionContext ctx, CatalogVersion catalogVersion) Generated method - Setter of the ContentBlock.catalogVersion attribute.
void	setIsTemplate(SessionContext ctx, Boolean isTemplate) Generated method - Setter of the TableBlock.isTemplate attribute.
void	setTableTemplate(SessionContext ctx, TableBlock value) Generated method - Setter of the TableBlock.tableTemplate attribute.
void	setTableTemplate(TableBlock value) Generated method - Setter of the TableBlock.tableTemplate attribute.

Methods inherited from class de.hybris.platform.print.jalo.table.GeneratedTableBlock

addToCells, addToCells, addToColumns, addToColumns, addToRows, addToRows, addToTableDataHolders, addToTableDataHolders, getAllTableTemplates, getCells, getCells, getColumns, getColumns, getDefaultAttributeModes, getFooterRowCount, getFooterRowCount, getFooterRowCountAsPrimitive, getFooterRowCountAsPrimitive, getHeaderRowCount, getHeaderRowCount, getHeaderRowCountAsPrimitive, getHeaderRowCountAsPrimitive, getRows, getRows, getTableDataHolders, getTableDataHolders, getTableStyle, getTableStyle, getTableTemplate, getTableTemplate, getWidth, getWidth, getWidthAsPrimitive, getWidthAsPrimitive, getWidthType, getWidthType, isIsTemplate, isIsTemplate, isIsTemplateAsPrimitive, isIsTemplateAsPrimitive, isLocked, isLocked, isLockedAsPrimitive, isLockedAsPrimitive, removeFromCells, removeFromCells, removeFromColumns, removeFromColumns, removeFromRows, removeFromRows, removeFromTableDataHolders, removeFromTableDataHolders, setCells, setCells, setColumns, setColumns, setFooterRowCount, setFooterRowCount, setFooterRowCount, setFooterRowCount, setHeaderRowCount, setHeaderRowCount, setHeaderRowCount, setHeaderRowCount, setIsTemplate, setIsTemplate, setIsTemplate, setLocked, setLocked, setLocked, setLocked, setRows, setRows, setTableDataHolders, setTableDataHolders, setTableStyle, setTableStyle, setWidth, setWidth, setWidth, setWidth, setWidthType, setWidthType

Methods inherited from class de.hybris.platform.print.jalo.GeneratedContentBlock

addToCategories, addToCategories, getAllName, getAllName, getCatalogVersion, getCatalogVersion, getCategories, getCategories, getCategoriesCount, getCategoriesCount, getCode, getCode, getName, getName, getRenderedContent, removeFromCategories, removeFromCategories, setAllName, setAllName, setCatalogVersion, setCategories, setCategories, setCode, setCode, setName, setName

Methods inherited from class de.hybris.platform.jalo.GenericItem

createItem, getInitialProperties, getNonInitialAttributes

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TABLE_INIT_PARAMETERS

public static final String TABLE_INIT_PARAMETERS

Session attribute name. This attribute can contain Map of parameters to override the global table parameters.

See Also:

Constant Field Values

Constructor Detail

TableBlock

public TableBlock()

Method Detail

getCellEntry

public static CellEntry getCellEntry(ColumnEntry column,
                                     RowEntry row)

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Description copied from class: Item

Removes this item.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
n/a (this is a setter method)		no, language doesn't matter for removal		yes if called on a StageableItem, no otherwise

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

ConsistencyCheckException - if this item could not be removed for some reason

setCatalogVersion

public void setCatalogVersion(SessionContext ctx,
                              CatalogVersion catalogVersion)

Description copied from class: GeneratedContentBlock

Generated method - Setter of the ContentBlock.catalogVersion attribute.

Overrides:

setCatalogVersion in class GeneratedContentBlock

catalogVersion - the catalogVersion

setIsTemplate

public void setIsTemplate(SessionContext ctx,
                          Boolean isTemplate)

Description copied from class: GeneratedTableBlock

Generated method - Setter of the TableBlock.isTemplate attribute.

Overrides:

setIsTemplate in class GeneratedTableBlock

isTemplate - the isTemplate

isUsedAsTemplate

public boolean isUsedAsTemplate()

getAllTableTemplates

public Collection<TableBlock> getAllTableTemplates(SessionContext ctx)

Description copied from class: GeneratedTableBlock

Generated method - Getter of the TableBlock.allTableTemplates attribute.

Specified by:

getAllTableTemplates in class GeneratedTableBlock

Returns:

the allTableTemplates

getTableOrTemplate

public TableBlock getTableOrTemplate()

getColumnsConsideringTemplate

public List<ColumnEntry> getColumnsConsideringTemplate()

getRowsConsideringTemplate

public List<RowEntry> getRowsConsideringTemplate()

getDataHolderConsideringTemplate

public TableDataHolder getDataHolderConsideringTemplate()

getGlobalParameterValues

public Map<String,Object> getGlobalParameterValues()

getDataHolderConsideringTemplate

public AxisDataHolder getDataHolderConsideringTemplate(AxisEntry axis)

getDataHolderConsideringTemplate

public CellDataHolder getDataHolderConsideringTemplate(CellEntry cell)

renderHTML

public String renderHTML()

renderHTML

public String renderHTML(SessionContext ctx)

renderInDesign

public String renderInDesign()

renderInDesign

public String renderInDesign(SessionContext ctx)

computePrintTable

public PrintTable computePrintTable()

getCachedPrintTable

public PrintTable getCachedPrintTable()

Returns cached PrintTable. If no PrintTable is in the cache, it returns null. Computed PrintTable is put in the cache each time the computePrintTable() is called.
However, it can fly out form cache after some time, so please check if the returned value is not null each time.

Returns:

cached PrintTable or null if no table in cache

computeCellRawValue

public Object computeCellRawValue(CellEntry cell,
                                  Object rowData,
                                  Object columnData)
                           throws DataResolverException

Throws:

DataResolverException

computeCellValue

public final String computeCellValue(CellEntry cell,
                                     Object rawValue,
                                     Object rowData,
                                     int rowDataIndex,
                                     int rowDataCount,
                                     Object columnData,
                                     int colDataIndex,
                                     int colDataCount,
                                     ExpressionContext initialContext)

computeCellStyle

public CellStyle computeCellStyle(CellEntry cell,
                                  RowEntry row,
                                  Object rowData,
                                  int rowDataIndex,
                                  int rowDataCount,
                                  ColumnEntry column,
                                  Object columnData,
                                  int colDataIndex,
                                  int colDataCount,
                                  ExpressionContext initialContext)

computeExtendedStyle

public String computeExtendedStyle(CellEntry cell,
                                   RowEntry row,
                                   Object rowData,
                                   int rowDataIndex,
                                   int rowDataCount,
                                   ColumnEntry column,
                                   Object columnData,
                                   int colDataIndex,
                                   int colDataCount,
                                   ExpressionContext initialContext)

computeColWidth

public double computeColWidth(ColumnEntry column,
                              int colDataIndex,
                              int colDataCount,
                              ExpressionContext initialContext)

getAllAxisData

public List<Object> getAllAxisData(AxisEntry axis)

getAxisData

public Object getAxisData(AxisEntry axis,
                          int index)

setTableTemplate

public void setTableTemplate(SessionContext ctx,
                             TableBlock value)

Description copied from class: GeneratedTableBlock

Generated method - Setter of the TableBlock.tableTemplate attribute.

Overrides:

setTableTemplate in class GeneratedTableBlock

value - the tableTemplate

setTableTemplate

public void setTableTemplate(TableBlock value)

Description copied from class: GeneratedTableBlock

Generated method - Setter of the TableBlock.tableTemplate attribute.

Overrides:

setTableTemplate in class GeneratedTableBlock

Parameters:

value - the tableTemplate

getRenderedContent

public String getRenderedContent(SessionContext ctx)

Description copied from class: GeneratedContentBlock

Generated method - Getter of the ContentBlock.renderedContent attribute.

Specified by:

getRenderedContent in class GeneratedContentBlock

Returns:

the renderedContent