Column (Technia Value Components (2016.1.0) API Documentation

All Known Implementing Classes:

AbstractColumn, ConfigurableColumn
```
public interface Column
```
Represents a column in a table.

Since:

5.2.1

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Column.Localizer
A utility for localizing cell values.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Column.Localizer` A utility for localizing cell values.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAlt()` Returns the alt text.
`java.lang.String`	`getAttribute()` Returns the name of the attribute whose value is referenced by the expression.
`AttributeInfo`	`getAttributeInfo()` Returns the associated attribute info, if this column applies to an attribute.
`int`	`getAttributeType()` Returns the attribute's data type if the expression references an attribute.
`CellRenderer`	`getCellRenderer(java.lang.Class<? extends CellRenderer> type)` Returns the cell renderer of the specified type.
`DataHandler`	`getDataHandler()` Returns the datahandler instance.
`java.lang.String`	`getDescription()` Returns the description.
`java.lang.String`	`getExpression()` Returns the expression used to retrieve the column values.
`java.lang.String`	`getGroupHeader()` Returns the group header.
`java.lang.String`	`getGroupHeaderBGColor()` Returns the background color of group header.
`java.lang.String`	`getHref()` Returns the column's href.
`java.lang.String`	`getLabel()` Returns the column label.
`java.util.Locale`	`getLocale()` Returns the locale of this column.
`Column.Localizer`	`getLocalizer()` This method will return a localized version of a cell value.
`java.lang.String`	`getName()` Returns the name of the column.
`RangeHandler`	`getRangeHandler()` Returns the `RangeHandler` for this column.
`java.lang.String`	`getRangeHref()` Returns the column's range href.
`java.util.List<RangeValue>`	`getRangeValues()` Returns a list of range values available when editing the column's values.
`ColumnSettings`	`getSettings()` Returns a view of the `settings`.
`SortType`	`getSortType()` Returns the column's sort type.
`Table`	`getTable()` Returns the `Table`, which this column is a part of.
`java.lang.String`	`getUpdateURL()` Returns the column's update URL.
`boolean`	`hasEditAccess()` Returns true if the user has edit access to this column.
`boolean`	`isAttributeExpression()` Returns whether the expression references an attribute's value or not.
`boolean`	`isFixed()` Returns true if the column is fixed.
`boolean`	`isMultiline()` Returns whether the column is multiline or not.
`boolean`	`isVisible()` Returns whether the column is visible or not
`void`	`setFixed(boolean fixed)` Sets if this column should be fixed or not.
`void`	`setVisible(boolean visible)` Sets the visibility of the column
`void`	`updateRangeValues()` Updates the range values if necessary.
`boolean`	`usesBusinessObject()` Returns whether the column uses business objects or not.
`boolean`	`usesRelationship()` Returns whether the column uses relationships or not.

- Method Detail
  - getHref
```
java.lang.String getHref()
```
    Returns the column's href.
  - usesBusinessObject
```
boolean usesBusinessObject()
```
    Returns whether the column uses business objects or not.
  - usesRelationship
```
boolean usesRelationship()
```
    Returns whether the column uses relationships or not.
  - getExpression
```
java.lang.String getExpression()
```
    Returns the expression used to retrieve the column values.
  - isAttributeExpression
```
boolean isAttributeExpression()
```
    Returns whether the expression references an attribute's value or not.
  - hasEditAccess
```
boolean hasEditAccess()
```
    Returns true if the user has edit access to this column.
    
    Returns:
    Returns true if the user has edit access to this column.
  - getAttribute
```
java.lang.String getAttribute()
```
    Returns the name of the attribute whose value is referenced by the expression.
    
    See Also:
    getExpression(), isAttributeExpression()
  - getAttributeType
```
int getAttributeType()
```
    Returns the attribute's data type if the expression references an attribute. If the expression doesn't reference an attribute then this method will return unknown.
    
    See Also:
    getExpression(), getAttribute(), isAttributeExpression(), AttributeConstants
  - getAttributeInfo
```
AttributeInfo getAttributeInfo()
```
    Returns the associated attribute info, if this column applies to an attribute.
    
    Returns:
    Returns the associated attribute info, if this column applies to an attribute.
    Since:
    
    6.1.1
  - isVisible
```
boolean isVisible()
```
    Returns whether the column is visible or not
  - setVisible
```
void setVisible(boolean visible)
```
    Sets the visibility of the column
    
    Parameters:
    visible - True for visible
  - getName
```
java.lang.String getName()
```
    Returns the name of the column.
  - getRangeHref
```
java.lang.String getRangeHref()
```
    Returns the column's range href.
  - getUpdateURL
```
java.lang.String getUpdateURL()
```
    Returns the column's update URL.
  - getSortType
```
SortType getSortType()
```
    Returns the column's sort type.
  - getRangeValues
```
java.util.List<RangeValue> getRangeValues()
```
    Returns a list of range values available when editing the column's values.
  - isMultiline
```
boolean isMultiline()
```
    Returns whether the column is multiline or not.
  - getTable
```
Table getTable()
```
    Returns the Table, which this column is a part of.
  - getLocale
```
java.util.Locale getLocale()
```
    Returns the locale of this column.
    
    Since:
    
    3.6
  - updateRangeValues
```
void updateRangeValues()
                       throws TVCException
```
    Updates the range values if necessary.
    
    Throws:
    
    TVCException
    Since:
    
    4.1.0
  - getLocalizer
```
Column.Localizer getLocalizer()
```
    This method will return a localized version of a cell value.
    
    Returns:
    A localized version of the specified cell value.
    Since:
    
    5.0.2
  - getDataHandler
```
DataHandler getDataHandler()
```
    Returns the datahandler instance.
    
    Returns:
    Returns the datahandler instance.
    Since:
    
    5.1.3
  - getSettings
```
ColumnSettings getSettings()
```
    Returns a view of the settings.
    
    Since:
    
    5.2.1
  - getLabel
```
java.lang.String getLabel()
```
    Returns the column label.
    
    Returns:
    The label.
  - getAlt
```
java.lang.String getAlt()
```
    Returns the alt text.
    
    Returns:
    The alt text.
  - getGroupHeader
```
java.lang.String getGroupHeader()
```
    Returns the group header.
    
    Returns:
    Returns the group header.
  - getGroupHeaderBGColor
```
java.lang.String getGroupHeaderBGColor()
```
    Returns the background color of group header.
    
    Returns:
    Returns the background color of group header.
  - getDescription
```
java.lang.String getDescription()
```
    Returns the description.
    
    Returns:
    Returns the description.
  - getCellRenderer
```
CellRenderer getCellRenderer(java.lang.Class<? extends CellRenderer> type)
```
    Returns the cell renderer of the specified type.
    
    Parameters:
    type - The type of cell renderer to return
    
    Returns:
    The cell render of the specified type, or null.
    Since:
    
    5.2.2
  - setFixed
```
void setFixed(boolean fixed)
```
    Sets if this column should be fixed or not. How this flag is interpreted is upto the functionality using the column.
    
    Parameters:
    fixed - True if fixed, otherwise false.
    Since:
    
    6.1.0
  - isFixed
```
boolean isFixed()
```
    Returns true if the column is fixed.
    
    Returns:
    the fixed status of this column.
    Since:
    
    6.1.0
  - getRangeHandler
```
RangeHandler getRangeHandler()
```
    Returns the RangeHandler for this column. The range handler is used internally to accuire the range values for a column.
    
    Returns:
    Returns the RangeHandler for this column.
    Since:
    
    6.2.1

Interface Column

Nested Class Summary

Method Summary

Method Detail

getHref

usesBusinessObject

usesRelationship

getExpression

isAttributeExpression

hasEditAccess

getAttribute

getAttributeType

getAttributeInfo

isVisible

setVisible

getName

getRangeHref

getUpdateURL

getSortType

getRangeValues

isMultiline

getTable

getLocale

updateRangeValues

getLocalizer

getDataHandler

getSettings

getLabel

getAlt

getGroupHeader

getGroupHeaderBGColor

getDescription

getCellRenderer

setFixed

isFixed

getRangeHandler