wt.enterprise.tabularresults
Class Column

java.lang.Object
  wt.enterprise.tabularresults.Column

public class Column

extends Object

This class plays the role of keeping track of all of the attributes of a column that would be displayed in an HTML table. The column maintains a reference ID, the header title for the column, the attributes for presenting the header and the attributes for presenting each row entry in the column.

Supported API: false

Extendable: false

See Also:

TableFormatService

Field Summary

private String	columnID The ID is used as an identifier for the column.
protected Properties	columnProperties Keeps track of the properties of the header.
protected Properties	headerProperties Keeps track of the properties of the header.
protected String	heading This is the actual string that you want placed between the
private String[]	TD_ATTRIBUTES These attributes are used to define what are valid attributes to adorn the individual table entries.
private String	tdBegin
private String[]	TH_ATTRIBUTES These attributes are used to define what are valid attributes to adorn the table header.

Constructor Summary

Column(String column_ID, Properties properties)
Supported API: false

Method Summary

String	getColumnID() Supported API: false Returns the ID of the column
Properties	getColumnProperties()
String	getColumnProperty(String property) Returns the value of the property from columnProperties Supported API: false
String	getHeader() Returns The string value in heading Supported API: false
Properties	getHeaderProperties() Supported API: false
String	getHeaderProperty(String property) Returns the value of the property from headerProperties Supported API: false
String	getTDFormat() Returns a string that should be placed in	tags.
String	getTH() Returns a string that should be placed in	tags.
void	initTDFormat() This method will initialize the ...
void	setColumnProperties(Properties properties) Enumerates through properties and updates columnProperties Supported API: false
void	setColumnProperty(String property, String value) This call sets an individual property based on the name=value pair Supported API: false
void	setHeader(String heading_entry) Sets the string to be display in the column header between the	header string Supported API: false
void	setHeaderProperties(Properties properties) Enumerates through properties and updates setHeaderProperty Supported API: false
void	setHeaderProperty(String property, String setting) This call sets an individual property based on the name=value pair Supported API: false

Methods inherited from class java.lang.Object

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

Field Detail

columnID

private String columnID

The ID is used as an identifier for the column. It can be used to give a meaningful name relative to the context of what the column is to present.

tdBegin

private String tdBegin

TD_ATTRIBUTES

private final String[] TD_ATTRIBUTES

These attributes are used to define what are valid attributes to adorn the individual table entries. These attributes show up in the tag of an individual table entry. When creating the tag, this array is looped over and any entries in column_properties that match are added as a name=value pair. Note : the match is case sensitive.

TH_ATTRIBUTES

private String[] TH_ATTRIBUTES

These attributes are used to define what are valid attributes to adorn the table header. These attributes show up in the tag of a table header. When creating the tag, this array is looped over and any entries in headerProperties that match are added as a name=value pair. Note : the match is case sensitive.

headerProperties

protected Properties headerProperties

Keeps track of the properties of the header. In particular, the TH attributes are placed here.

columnProperties

protected Properties columnProperties

Keeps track of the properties of the header. In particular, the attributes are placed here.

heading

protected String heading

This is the actual string that you want placed between the tags

Constructor Detail

Column

public Column(String column_ID,
              Properties properties)

Supported API: false

Parameters:

properties - Places any initial column parameters in columnProperties

Method Detail

getColumnID

public String getColumnID()

Supported API: false Returns the ID of the column

Returns:

String

setColumnProperties

public void setColumnProperties(Properties properties)

Enumerates through properties and updates columnProperties

Supported API: false

Parameters:

properties - Properties whose values will update columnProperties

setColumnProperty

public void setColumnProperty(String property,
                              String value)

This call sets an individual property based on the name=value pair

Supported API: false

Parameters:

property - The name of the property to update in columnProperties

getColumnProperty

public String getColumnProperty(String property)

Returns the value of the property from columnProperties

Supported API: false

Parameters:

property - The name of the property to get

Returns:

value of property from columnProperties

getColumnProperties

public Properties getColumnProperties()

setHeaderProperties

public void setHeaderProperties(Properties properties)

Enumerates through properties and updates setHeaderProperty

Supported API: false

Parameters:

properties - Properties whose values will update setHeaderProperty

setHeaderProperty

public void setHeaderProperty(String property,
                              String setting)

This call sets an individual property based on the name=value pair

Supported API: false

Parameters:

property - The name of the property to update in headerProperties

getHeaderProperty

public String getHeaderProperty(String property)

Returns the value of the property from headerProperties

Supported API: false

Parameters:

property - The name of the property to get

Returns:

value of property from headerProperties

getHeaderProperties

public Properties getHeaderProperties()

Supported API: false

Returns:

The headerProperties properties object

setHeader

public void setHeader(String heading_entry)

Sets the string to be display in the column header between the header string

Supported API: false

getHeader

public String getHeader()

Returns The string value in heading

Supported API: false

Returns:

The string value in heading to place in code> header string

initTDFormat

public void initTDFormat()

This method will initialize the ... in based upon what is in columnProperties.

Supported API: false

getTDFormat

public String getTDFormat()

Returns a string that should be placed in tags. It is assumed that you have called initTDFormat before this to initialize the string to place in the tag

Supported API: false

Returns:

The string that should be placed in

getTH

public String getTH()

Returns a string that should be placed in tags. It is assumed that you have called initTHFormat before this to initialize the string to place in the tag

Supported API: false

Returns:

The string that should be placed in