com.technia.tvc.core.gui.table.impl

Class ConfigurableColumn

java.lang.Object

com.technia.tvc.core.gui.table.impl.AbstractColumn

com.technia.tvc.core.gui.table.impl.ConfigurableColumn

All Implemented Interfaces:

Column, java.lang.Cloneable

public class ConfigurableColumn
extends AbstractColumn
implements java.lang.Cloneable

A ConfigurableColumn belongs to a ConfigurableTable. To create such a column, one should do as:

1. ConfigurableTable table = new ConfigurableTable();
2. ColumnSettings settings = new ColumnSettingsImpl();
3. // todo: initialize settings...
4. ConfigurableColumn column = table.addColumn(settings, env);
5. column.setHref("${ROOT_DIR}/my-href.jsp");
6. column.setExpression("$");
7. column.setUsesBusinessObject(false);
8. // todo: set more properties on the column ...
9. column.init();
10. // todo: create more columns ...

Since:

5.2.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.technia.tvc.core.gui.table.Column

Column.Localizer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	alt The alt text that should be used on links.
protected java.lang.String	description The description of the column
protected java.lang.Boolean	editable Whether the column is editable or not.
protected java.lang.String	expression The expression.
protected java.lang.String	groupHeader The column header
protected java.lang.String	groupHeaderBGColor The column header background color
protected boolean	hidden Whether the column is hidden or not.
protected java.lang.String	href The href for the column.
protected java.lang.String	label The columns label.
protected boolean	multiline Whether the column's values are multiline.
protected java.lang.String	name The name of the column.
protected java.lang.String	rangeHref The column's range-href.
protected SortType	sortType The column's sort type.
protected java.lang.String	updateURL The column's update-href.
protected boolean	usesBusinessObject Whether the column applies to a business object or a relationship.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurableColumn(ConfigurableTable table, Environment env) Create a new configurable column.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
static ConfigurableColumn	create(ConfigurableTable table, ColumnSettings cs, Environment env) Creates a new column instance, based upon the settings provided.
static ConfigurableColumn	create(ConfigurableTable table, Environment env) Creates a new column instance, based upon the settings provided.
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.
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.lang.String	getName() Returns the name of the column.
java.lang.String	getRangeHref() Returns the column's range href.
SortType	getSortType() Returns the column's sort type.
java.lang.String	getUpdateURL() Returns the column's update URL.
java.lang.Object	getUserObject() Returns the user object.
boolean	hasEditAccess() Returns true if the user has edit access to this column.
void	init() This method will parse following items:
boolean	isAttributeExpression() Returns whether the expression references an attribute's value or not.
boolean	isHidden() Returns whether the column is hidden or not.
boolean	isMultiline() Returns whether the column is multiline or not.
void	resetEditAccess() Reset the edit access, i.e., derive it from the settings.
void	setAlt(java.lang.String alt) Sets the alt text.
void	setDescription(java.lang.String description) Sets the description.
void	setEditAccess(boolean editAccess) Set whether the user has edit access to this column.
void	setExpression(java.lang.String expression) Sets the expression.
void	setGroupHeader(java.lang.String groupHeader) Sets the group header.
void	setGroupHeaderBGColor(java.lang.String groupHeaderBGColor) Sets the background color of the group header.
void	setHidden(boolean hidden) Sets whether the column is hidden.
void	setHref(java.lang.String href) Sets the href.
void	setLabel(java.lang.String label) Sets the label.
void	setMultiline(boolean multiline) Sets whether the column is multiline.
void	setName(java.lang.String name) Sets the name of the column.
void	setRangeHref(java.lang.String rangeHref) Sets the range href.
void	setSetting(java.lang.String name, boolean value) Sets the specified setting on the column.
void	setSetting(java.lang.String name, int value) Sets the specified setting on the column.
void	setSetting(java.lang.String name, java.lang.String value) Sets the specified setting on the column.
void	setSortType(SortType sortType) Sets the sort type.
void	setUpdateURL(java.lang.String updateURL) Sets the update URL.
void	setUserObject(java.lang.Object userObject) Sets an arbitrary object that can for example be used to send information to a custom DataHandler or CellRenderer.
void	setUsesBusinessObject(boolean usesBusinessObject) Sets whether the column applies to business object.
boolean	usesBusinessObject() Returns whether the column uses business objects or not.
boolean	usesRelationship() Returns whether the column uses relationships or not.

Methods inherited from class com.technia.tvc.core.gui.table.impl.AbstractColumn

checkEditAccess, findLocalizer, getCellRenderer, getColumnOrientation, getColumnSettings, getDataHandler, getEnv, getLocale, getLocalizer, getRangeHandler, getRangeValues, getSettings, getTable, isFixed, isVisible, setColumnOrientation, setColumnSettings, setFixed, setVisible, updateRangeValues

Methods inherited from class java.lang.Object

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

Field Detail

label

protected java.lang.String label

The columns label.

alt

protected java.lang.String alt

The alt text that should be used on links.

groupHeader

protected java.lang.String groupHeader

The column header

groupHeaderBGColor

protected java.lang.String groupHeaderBGColor

The column header background color

description

protected java.lang.String description

The description of the column

usesBusinessObject

protected boolean usesBusinessObject

Whether the column applies to a business object or a relationship.

expression

protected java.lang.String expression

The expression.

editable

protected java.lang.Boolean editable

Whether the column is editable or not.

hidden

protected boolean hidden

Whether the column is hidden or not.

name

protected java.lang.String name

The name of the column. Note that this is not the same as it's label.

href

protected java.lang.String href

The href for the column.

rangeHref

protected java.lang.String rangeHref

The column's range-href.

updateURL

protected java.lang.String updateURL

The column's update-href.

sortType

protected SortType sortType

The column's sort type.

multiline

protected boolean multiline

Whether the column's values are multiline.

Constructor Detail

ConfigurableColumn

protected ConfigurableColumn(ConfigurableTable table,
                             Environment env)
                      throws TVCException

Create a new configurable column. This constructor is for subclasses and internal use. Please use create(ConfigurableTable, ColumnSettings, Environment) or ConfigurableTable.addColumn(ColumnSettings, Environment) to create a new column.

Parameters:

table - The table for which the column is created.

env - The environment.

Throws:

TVCException - If unable to create the column.

Method Detail

create

public static ConfigurableColumn create(ConfigurableTable table,
                                        Environment env)
                                 throws TVCException

Creates a new column instance, based upon the settings provided.

Parameters:

table - The table.

env - The environment.

Returns:

The configurable column.

Throws:

TVCException - If unable to create a column.

Since:

2009.1.0

create

public static ConfigurableColumn create(ConfigurableTable table,
                                        ColumnSettings cs,
                                        Environment env)
                                 throws TVCException

Creates a new column instance, based upon the settings provided.

Parameters:

table - The table.

cs - The column settings.

env - The environment.

Returns:

The configurable column.

Throws:

TVCException - If unable to create a column.

init

public void init()
          throws TVCException

This method will parse following items:

Directory Macros:

• href
• rangeHref
• updateURL
• columnIcon

Select Expressions:

• expression
• accessExpression
• editableExpression
• alternateOIDExpression
• alternateTypeExpression
• cellEditableExpression
• cellShowableExpression

From the expression, these properties will be initialized:

• multiline
• attributeType
• attributeName

Overrides:

init in class AbstractColumn

Throws:

TVCException - If unable to initialize.

getLabel

public java.lang.String getLabel()

Description copied from interface: Column

Returns the column label.

Specified by:

getLabel in interface Column

Returns:

The label.

usesBusinessObject

public boolean usesBusinessObject()

Description copied from interface: Column

Returns whether the column uses business objects or not.

Specified by:

usesBusinessObject in interface Column

usesRelationship

public boolean usesRelationship()

Description copied from interface: Column

Returns whether the column uses relationships or not.

Specified by:

usesRelationship in interface Column

getExpression

public java.lang.String getExpression()

Description copied from interface: Column

Returns the expression used to retrieve the column values.

Specified by:

getExpression in interface Column

isAttributeExpression

public boolean isAttributeExpression()

Description copied from interface: Column

Returns whether the expression references an attribute's value or not.

Specified by:

isAttributeExpression in interface Column

getAttribute

public java.lang.String getAttribute()

Description copied from interface: Column

Returns the name of the attribute whose value is referenced by the expression.

Specified by:

getAttribute in interface Column

See Also:

Column.getExpression(), Column.isAttributeExpression()

getAttributeType

public int getAttributeType()

Description copied from interface: Column

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.

Specified by:

getAttributeType in interface Column

See Also:

Column.getExpression(), Column.getAttribute(), Column.isAttributeExpression(), AttributeConstants

getAttributeInfo

public AttributeInfo getAttributeInfo()

Description copied from interface: Column

Returns the associated attribute info, if this column applies to an attribute.

Specified by:

getAttributeInfo in interface Column

Returns:

Returns the associated attribute info, if this column applies to an attribute.

hasEditAccess

public boolean hasEditAccess()

Description copied from interface: Column

Returns true if the user has edit access to this column.

Specified by:

hasEditAccess in interface Column

Overrides:

hasEditAccess in class AbstractColumn

Returns:

Returns true if the user has edit access to this column.

setEditAccess

public void setEditAccess(boolean editAccess)

Set whether the user has edit access to this column.

Parameters:

editAccess - Edit access?

Since:

6.1.5

resetEditAccess

public void resetEditAccess()

Reset the edit access, i.e., derive it from the settings.

Since:

6.1.5

isHidden

public boolean isHidden()

Returns whether the column is hidden or not.

getName

public java.lang.String getName()

Description copied from interface: Column

Returns the name of the column.

Specified by:

getName in interface Column

getHref

public java.lang.String getHref()

Description copied from interface: Column

Returns the column's href.

Specified by:

getHref in interface Column

getAlt

public java.lang.String getAlt()

Description copied from interface: Column

Returns the alt text.

Specified by:

getAlt in interface Column

Returns:

The alt text.

getDescription

public java.lang.String getDescription()

Description copied from interface: Column

Returns the description.

Specified by:

getDescription in interface Column

Returns:

Returns the description.

getRangeHref

public java.lang.String getRangeHref()

Description copied from interface: Column

Returns the column's range href.

Specified by:

getRangeHref in interface Column

getUpdateURL

public java.lang.String getUpdateURL()

Description copied from interface: Column

Returns the column's update URL.

Specified by:

getUpdateURL in interface Column

getSortType

public SortType getSortType()

Description copied from interface: Column

Returns the column's sort type.

Specified by:

getSortType in interface Column

isMultiline

public boolean isMultiline()

Description copied from interface: Column

Returns whether the column is multiline or not.

Specified by:

isMultiline in interface Column

setExpression

public void setExpression(java.lang.String expression)

Sets the expression.

Parameters:

expression - The new expression.

setHidden

public void setHidden(boolean hidden)

Sets whether the column is hidden.

Parameters:

hidden - Whether the column is hidden or not.

setHref

public void setHref(java.lang.String href)

Sets the href.

Parameters:

href - The new href.

setLabel

public void setLabel(java.lang.String label)

Sets the label.

Parameters:

label - The new label.

setGroupHeader

public void setGroupHeader(java.lang.String groupHeader)

Sets the group header.

Parameters:

groupHeader - The new group header.

getGroupHeader

public java.lang.String getGroupHeader()

Description copied from interface: Column

Returns the group header.

Specified by:

getGroupHeader in interface Column

Returns:

Returns the group header.

setGroupHeaderBGColor

public void setGroupHeaderBGColor(java.lang.String groupHeaderBGColor)

Sets the background color of the group header.

Parameters:

groupHeaderBGColor - The new background color of the group header.

getGroupHeaderBGColor

public java.lang.String getGroupHeaderBGColor()

Description copied from interface: Column

Returns the background color of group header.

Specified by:

getGroupHeaderBGColor in interface Column

Returns:

Returns the background color of group header.

setMultiline

public void setMultiline(boolean multiline)

Sets whether the column is multiline.

Parameters:

multiline - Whether the column is multiline or not.

setName

public void setName(java.lang.String name)

Sets the name of the column.

Parameters:

name - The new name.

setRangeHref

public void setRangeHref(java.lang.String rangeHref)

Sets the range href.

Parameters:

rangeHref - The new range href.

setSortType

public void setSortType(SortType sortType)

Sets the sort type.

Parameters:

sortType - The new sort type.

setUpdateURL

public void setUpdateURL(java.lang.String updateURL)

Sets the update URL.

Parameters:

updateURL - The new update URL.

setUsesBusinessObject

public void setUsesBusinessObject(boolean usesBusinessObject)

Sets whether the column applies to business object.

Parameters:

usesBusinessObject - Applies to business object?

setAlt

public void setAlt(java.lang.String alt)

Sets the alt text.

Parameters:

alt - The new alt.

setDescription

public void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - The new description.

setSetting

public void setSetting(java.lang.String name,
                       java.lang.String value)

Sets the specified setting on the column.

Parameters:

name - The name of the setting.

value - The new value.

setSetting

public void setSetting(java.lang.String name,
                       int value)

Sets the specified setting on the column.

Parameters:

name - The name of the setting.

value - The new value.

setSetting

public void setSetting(java.lang.String name,
                       boolean value)

Sets the specified setting on the column.

Parameters:

name - The name of the setting.

value - The new value.

getUserObject

public java.lang.Object getUserObject()

Returns the user object.

Returns:

Returns the user object.

Since:

6.1.5

See Also:

setUserObject(Object)

setUserObject

public void setUserObject(java.lang.Object userObject)

Sets an arbitrary object that can for example be used to send information to a custom DataHandler or CellRenderer.

Parameters:

userObject - The new user object.

Since:

6.1.5

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException