Class TableDataCell
- java.lang.Object
-
- com.priint.pubserver.plugin.entitydata.TableDataCell
-
- All Implemented Interfaces:
GetIdentifier,GetSequence,EntityData,PersistentData,java.io.Serializable,java.lang.Comparable<TableDataCell>
@Entity public class TableDataCell extends java.lang.Object implements java.io.Serializable, GetIdentifier, GetSequence, EntityData, PersistentData, java.lang.Comparable<TableDataCell>
TableDataCell represents a table cell in a TableData object and is connected to a row.TableDataCell is a cell representation optimized for comet output scenarios. It may also be used to represent table data for HTML output.
- Since:
- 4.0.0, 4.0.5 added JPA annotations
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTableDataCell.PlaceholderTypeTypes of placeholders uses in comet.
-
Constructor Summary
Constructors Constructor Description TableDataCell()Default constructorTableDataCell(java.lang.String identifier, java.lang.String createdBy, java.util.Date createdOn, java.lang.String updatedBy, java.util.Date updatedOn)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intcompareTo(TableDataCell compareObject)Two cells are compared using their sequence property.java.lang.StringgetCellStyle()java.lang.StringgetCharacterStyle()intgetColspan()java.util.List<ContentMetaData>getContentMetaData()ContextgetContext()java.lang.StringgetCreatedBy()java.util.DategetCreatedOn()java.lang.StringgetEntityIdentifier()Identifier of an entity in the entity model where the current object refers to.floatgetHeight()java.lang.StringgetIdentifier()Get the string identifier of the cell.java.lang.StringgetLabel()Display label for the cell.floatgetMaxHeight()java.util.List<KeyValue>getMetaData()java.lang.StringgetObjectEntityClass()java.lang.StringgetObjectEntityId()java.lang.StringgetObjectGroupIdentifier()java.lang.StringgetObjectIdentifier()java.lang.StringgetParagraphStyle()java.lang.StringgetParentEntityClass()java.lang.StringgetParentEntityId()java.lang.StringgetParentGroupIdentifier()java.lang.StringgetParentIdentifier()java.lang.StringgetPlaceholder()intgetPlaceholderAutoLoad()Deprecated.java.lang.StringgetPlaceholderInfo1()java.lang.StringgetPlaceholderInfo2()floatgetPlaceholderInlineHeight()intgetPlaceholderInlinePlacement()floatgetPlaceholderInlineWidth()java.lang.StringgetPlaceholderType()intgetRowspan()intgetSequence()Get sequence number for the cell as given in the content system.TableDatagetTableData()java.lang.StringgetTableDataId()TableDataRowgetTableRow()java.lang.StringgetUpdatedBy()java.util.DategetUpdatedOn()java.lang.StringgetValue()floatgetWidth()voidsetCellStyle(java.lang.String cellStyle)voidsetCharacterStyle(java.lang.String characterStyle)voidsetColspan(int colspan)voidsetContentMetaData(java.util.List<ContentMetaData> contentMetaData)voidsetContext(Context context)set the context of entity data objectvoidsetCreatedBy(java.lang.String createdBy)voidsetCreatedOn(java.util.Date createdOn)voidsetEntityIdentifier(java.lang.String entityIdentifier)Identifier of an entity in the entity model where the current object refers to.voidsetHeight(float height)voidsetIdentifier(java.lang.String identifier)voidsetLabel(java.lang.String label)voidsetMaxHeight(float maxHeight)voidsetMetaData(java.util.List<KeyValue> metaData)voidsetObjectEntityClass(java.lang.String objectEntityClass)voidsetObjectEntityId(java.lang.String objectEntityId)voidsetObjectGroupIdentifier(java.lang.String objectGroupIdentifier)voidsetObjectIdentifier(java.lang.String objectIdentifier)voidsetParagraphStyle(java.lang.String paragraphStyle)voidsetParentEntityClass(java.lang.String parentEntityClass)voidsetParentEntityId(java.lang.String parentEntityId)voidsetParentGroupIdentifier(java.lang.String parentGroupIdentifier)voidsetParentIdentifier(java.lang.String parentIdentifier)voidsetPlaceholder(java.lang.String placeholder)voidsetPlaceholderAutoLoad(int placeholderAutoLoad)Deprecated.voidsetPlaceholderInfo1(java.lang.String placeholderInfo1)voidsetPlaceholderInfo2(java.lang.String placeholderInfo2)voidsetPlaceholderInlineHeight(float placeholderInlineHeight)voidsetPlaceholderInlinePlacement(int placeholderInlinePlacement)voidsetPlaceholderInlineWidth(float placeholderInlineWidth)voidsetPlaceholderType(java.lang.String placeholderType)voidsetRowspan(int rowspan)voidsetSequence(int sequence)voidsetTableData(TableData tableData)voidsetTableDataId(java.lang.String tableDataId)voidsetTableRow(TableDataRow tableRow)voidsetUpdatedBy(java.lang.String updatedBy)voidsetUpdatedOn(java.util.Date updatedOn)voidsetValue(java.lang.String value)voidsetWidth(float width)
-
-
-
Constructor Detail
-
TableDataCell
public TableDataCell()
Default constructor
-
TableDataCell
public TableDataCell(java.lang.String identifier, java.lang.String createdBy, java.util.Date createdOn, java.lang.String updatedBy, java.util.Date updatedOn)- Parameters:
identifier-getIdentifier()createdBy-getCreatedBy()createdOn-getCreatedOn()updatedBy-getUpdatedBy()updatedOn-getUpdatedOn()
-
-
Method Detail
-
getIdentifier
public java.lang.String getIdentifier()
Get the string identifier of the cell.- Specified by:
getIdentifierin interfaceEntityData- Specified by:
getIdentifierin interfaceGetIdentifier- Specified by:
getIdentifierin interfacePersistentData- Returns:
- identifier string or
nullif not set
-
setIdentifier
public void setIdentifier(java.lang.String identifier)
- Specified by:
setIdentifierin interfaceEntityData- Parameters:
identifier- seegetIdentifier()
-
getTableRow
public TableDataRow getTableRow()
-
setTableRow
public void setTableRow(TableDataRow tableRow)
-
getColspan
public int getColspan()
- Returns:
- Number of columns that this cell spans.
-
setColspan
public void setColspan(int colspan)
- Parameters:
colspan-getColspan()
-
getRowspan
public int getRowspan()
- Returns:
- Number of rows that this cell spans.
-
setRowspan
public void setRowspan(int rowspan)
- Parameters:
rowspan-getRowspan()
-
getCellStyle
public java.lang.String getCellStyle()
- Returns:
- name of cell style or an empty string
-
setCellStyle
public void setCellStyle(java.lang.String cellStyle)
- Parameters:
cellStyle-getCellStyle()
-
getWidth
public float getWidth()
- Returns:
- Width of the cell.
Comet: millimeter, HTML: pixel.
Default is "0" meaning not explicitly set.
-
setWidth
public void setWidth(float width)
- Parameters:
width-getWidth()
-
getHeight
public float getHeight()
- Returns:
- Height of the cell.
Comet: millimeter, HTML: pixel.
Default is "0" meaning not explicitly set.
-
setHeight
public void setHeight(float height)
- Parameters:
height-getHeight()
-
getValue
public java.lang.String getValue()
- Returns:
- Initial content of the cell.
Might be overwritten by placeholder.
-
setValue
public void setValue(java.lang.String value)
- Parameters:
value-getValue()
-
getPlaceholder
public java.lang.String getPlaceholder()
- Returns:
- Placeholder for reloading the content of the cell.
-
setPlaceholder
public void setPlaceholder(java.lang.String placeholder)
- Parameters:
placeholder-getPlaceholder()
-
getPlaceholderType
public java.lang.String getPlaceholderType()
- Returns:
- placeholderType is one of
TableDataCell.PlaceholderType
-
setPlaceholderType
public void setPlaceholderType(java.lang.String placeholderType)
- Parameters:
placeholderType-getPlaceholderType()
-
getObjectIdentifier
public java.lang.String getObjectIdentifier()
- Returns:
- Id of the object that is linked to the cell.
In comet the placeholder needs this to create a comet StringID.
-
setObjectIdentifier
public void setObjectIdentifier(java.lang.String objectIdentifier)
- Parameters:
objectIdentifier-getObjectIdentifier()
-
getObjectGroupIdentifier
public java.lang.String getObjectGroupIdentifier()
- Returns:
- GroupId of the object that is linked to the cell.
In comet the placeholder needs this to create a comet StringID.
-
setObjectGroupIdentifier
public void setObjectGroupIdentifier(java.lang.String objectGroupIdentifier)
- Parameters:
objectGroupIdentifier-getObjectGroupIdentifier()
-
getObjectEntityId
public java.lang.String getObjectEntityId()
- Returns:
- EntityId of the object that is linked to the cell. In comet the placeholder needs this to create a comet StringID.
-
setObjectEntityId
public void setObjectEntityId(java.lang.String objectEntityId)
- Parameters:
objectEntityId-getObjectEntityId()
-
getObjectEntityClass
public java.lang.String getObjectEntityClass()
- Returns:
- EntityClass of the object that is linked to the cell.
In comet the placeholder needs this to create a comet StringID.
-
setObjectEntityClass
public void setObjectEntityClass(java.lang.String objectEntityClass)
- Parameters:
objectEntityClass-getObjectEntityClass()
-
getParentIdentifier
public java.lang.String getParentIdentifier()
- Returns:
- Id of the parent that is linked to the cell.
In comet the placeholder needs this to create a comet StringID.
-
setParentIdentifier
public void setParentIdentifier(java.lang.String parentIdentifier)
- Parameters:
parentIdentifier-getParentIdentifier()
-
getParentGroupIdentifier
public java.lang.String getParentGroupIdentifier()
- Returns:
- GroupId of the parent that is linked to the cell.
In comet the placeholder needs this to create a comet StringID.
-
setParentGroupIdentifier
public void setParentGroupIdentifier(java.lang.String parentGroupIdentifier)
- Parameters:
parentGroupIdentifier-getParentGroupIdentifier()
-
getParentEntityId
public java.lang.String getParentEntityId()
- Returns:
- EntityId of the parent that is linked to the cell.
In comet the placeholder needs this to create a comet StringID.
-
setParentEntityId
public void setParentEntityId(java.lang.String parentEntityId)
- Parameters:
parentEntityId-getParentEntityId()
-
getParentEntityClass
public java.lang.String getParentEntityClass()
- Returns:
- EntityClass of the parent that is linked to the cell.
In comet the placeholder needs this to create a comet StringID.
-
setParentEntityClass
public void setParentEntityClass(java.lang.String parentEntityClass)
- Parameters:
parentEntityClass-getParentEntityClass()
-
getPlaceholderAutoLoad
@Deprecated public int getPlaceholderAutoLoad()
Deprecated.the "placeholderAutoload" flag is never evaluated. it stays here for backward compatibility.- Returns:
- autoload flag of placeholder
-
setPlaceholderAutoLoad
@Deprecated public void setPlaceholderAutoLoad(int placeholderAutoLoad)
Deprecated.the "placeholderAutoload" flag is never evaluated. it stays here for backward compatibility.- Parameters:
placeholderAutoLoad-getPlaceholderAutoLoad()
-
getPlaceholderInlineHeight
public float getPlaceholderInlineHeight()
- Returns:
- placeholderInlineHeight
-
setPlaceholderInlineHeight
public void setPlaceholderInlineHeight(float placeholderInlineHeight)
- Parameters:
placeholderInlineHeight-getPlaceholderInlineHeight()
-
getPlaceholderInlineWidth
public float getPlaceholderInlineWidth()
- Returns:
- placeholderInlineWidth
-
setPlaceholderInlineWidth
public void setPlaceholderInlineWidth(float placeholderInlineWidth)
- Parameters:
placeholderInlineWidth-getPlaceholderInlineWidth()
-
getPlaceholderInlinePlacement
public int getPlaceholderInlinePlacement()
- Returns:
- placeholderInlinePlacement
-
setPlaceholderInlinePlacement
public void setPlaceholderInlinePlacement(int placeholderInlinePlacement)
- Parameters:
placeholderInlinePlacement-getPlaceholderInlinePlacement()
-
getCreatedBy
public java.lang.String getCreatedBy()
- Returns:
- creation user or
nullif not set
-
setCreatedBy
public void setCreatedBy(java.lang.String createdBy)
- Parameters:
createdBy- seegetCreatedBy()
-
getCreatedOn
public java.util.Date getCreatedOn()
- Returns:
- creation date or
nullif not set
-
setCreatedOn
public void setCreatedOn(java.util.Date createdOn)
- Parameters:
createdOn- seegetCreatedOn()
-
getUpdatedBy
public java.lang.String getUpdatedBy()
- Returns:
- last modified user or
nullif not set
-
setUpdatedBy
public void setUpdatedBy(java.lang.String updatedBy)
- Parameters:
updatedBy- seegetUpdatedBy()
-
getUpdatedOn
public java.util.Date getUpdatedOn()
- Returns:
- last modified date or
nullif not set
-
setUpdatedOn
public void setUpdatedOn(java.util.Date updatedOn)
- Parameters:
updatedOn- seegetUpdatedOn()
-
getMaxHeight
public float getMaxHeight()
- Returns:
- Maximum height of the cell.
Comet: millimeter, HTML: pixel.
Default is "0" meaning not explicitly set.
-
setMaxHeight
public void setMaxHeight(float maxHeight)
- Parameters:
maxHeight-getMaxHeight()
-
getMetaData
public java.util.List<KeyValue> getMetaData()
- Returns:
- List of meta data related to the cell or empty list
-
setMetaData
public void setMetaData(java.util.List<KeyValue> metaData)
- Parameters:
metaData- seegetMetaData()
-
getTableData
public TableData getTableData()
- Returns:
- table data this cell is part of
-
setTableData
public void setTableData(TableData tableData)
- Parameters:
tableData-getTableData()
-
getTableDataId
public java.lang.String getTableDataId()
- Returns:
- Identifier of the table this cell is part of.
-
setTableDataId
public void setTableDataId(java.lang.String tableDataId)
- Parameters:
tableDataId-getTableDataId()
-
getParagraphStyle
public java.lang.String getParagraphStyle()
- Returns:
- name of paragraph style for the cell or an empty string
-
setParagraphStyle
public void setParagraphStyle(java.lang.String paragraphStyle)
- Parameters:
paragraphStyle-getParagraphStyle()
-
getCharacterStyle
public java.lang.String getCharacterStyle()
- Returns:
- name of character style for the cell or an empty string
-
setCharacterStyle
public void setCharacterStyle(java.lang.String characterStyle)
- Parameters:
characterStyle-getCharacterStyle()
-
getSequence
public int getSequence()
Get sequence number for the cell as given in the content system.This should reflect the position of the current cell in the sorting of cells of its row.
- Specified by:
getSequencein interfaceGetSequence- Returns:
- ordered position within a list sequenceable objects
-
setSequence
public void setSequence(int sequence)
- Parameters:
sequence- seegetSequence()
-
getLabel
public java.lang.String getLabel()
Display label for the cell.- Returns:
- label or
nullif not set
-
setLabel
public void setLabel(java.lang.String label)
- Parameters:
label- seegetLabel()
-
getPlaceholderInfo1
public java.lang.String getPlaceholderInfo1()
-
setPlaceholderInfo1
public void setPlaceholderInfo1(java.lang.String placeholderInfo1)
-
getPlaceholderInfo2
public java.lang.String getPlaceholderInfo2()
-
setPlaceholderInfo2
public void setPlaceholderInfo2(java.lang.String placeholderInfo2)
-
compareTo
public int compareTo(TableDataCell compareObject)
Two cells are compared using their sequence property.- Specified by:
compareToin interfacejava.lang.Comparable<TableDataCell>- See Also:
Comparable.compareTo(java.lang.Object)
-
getEntityIdentifier
public java.lang.String getEntityIdentifier()
Description copied from interface:EntityDataIdentifier of an entity in the entity model where the current object refers to.- Specified by:
getEntityIdentifierin interfaceEntityData- Returns:
- entity identifier as string
-
setEntityIdentifier
public void setEntityIdentifier(java.lang.String entityIdentifier)
Description copied from interface:EntityDataIdentifier of an entity in the entity model where the current object refers to.- Specified by:
setEntityIdentifierin interfaceEntityData
-
getContext
public Context getContext()
- Specified by:
getContextin interfaceEntityData- Returns:
- entity context
-
setContext
public void setContext(Context context)
Description copied from interface:EntityDataset the context of entity data object- Specified by:
setContextin interfaceEntityData
-
getContentMetaData
public java.util.List<ContentMetaData> getContentMetaData()
- Returns:
- List of ContentMetaData related to Bucket
-
setContentMetaData
public void setContentMetaData(java.util.List<ContentMetaData> contentMetaData)
- Parameters:
contentMetaData-getContentMetaData()
-
-