Package net.simplace.pipe.formcomponents.choice

Class FWFormTableOption

java.lang.Object

net.simplace.pipe.formcomponents.choice.FWFormOption

net.simplace.pipe.formcomponents.choice.FWFormTableOption

public class FWFormTableOption
extends FWFormOption

Used by FWTableChoiceSubComponent to store selectable options and their attributes in a TableModel. This class works different FWFormOption:

• It has no value, because table contains multiple columns (in contrast to the other choice components); the representing selection value column is defined by FWTableChoiceSubComponent
• It has no text, because table has not (yet) a leading column to display a row text
• It has no image, because table not (yet) supports image rendering

The reason why this class inherits FWFormOption is to maintain the instances in FWChoiceFormComponent without any special cases. There are two ways to construct a FWFormTableOption:

1. Specifying XML-Element in constructor: In this case the table column values are extracted from element children:
   • <th>..</th> children define a FWFormTableOption representing the column names in table header; the optional type-Attribute can define the (fully qualified) classname for TableModel.getColumnClass(int)
   • <td>..</td> children define a FWFormTableOption representing the column values for a table row
2. Specifying ResultSet or ResultSetMetaData in constructor: In this case the table column values are determined from element children:
   • ResultSetMetaData defines a FWFormTableOption representing the column names and types in table header
   • ResultSet defines a FWFormTableOption representing the column values for a table row

Author:

Martin Schmitz

Field Summary

Fields

Modifier and Type	Field	Description
protected Vector<Class<?>>	iColTypes	Holds the column types (only if iIsHeader is true)
protected Vector<Object>	iColValues	Holds the column values or the column names (depending on iIsHeader
protected boolean	iIsHeader	Indicates whether option represents the table header

Constructor Summary

Constructors

Constructor	Description
FWFormTableOption(String aId, String aText, ResultSet aResultSet)	Creates a table row FWFormTableOption from SQL Result.
FWFormTableOption(String aId, String aText, ResultSetMetaData aResultMetaData)	Creates a table headerFWFormTableOption from SQL Result.
FWFormTableOption(String aId, String aText, Vector<Object> aColValues)	Creates a table row FWFormTableOption "from scratch".
FWFormTableOption(String aId, String aText, Vector<Object> aColNames, Vector<Class<?>> aColTypes)	Creates a table header FWFormTableOption "from scratch".
FWFormTableOption(String aId, String aText, org.jdom2.Element aOptionElem)	Creates a FWFormTableOption from XML-Element.

Method Summary

Modifier and Type	Method	Description
Vector<Class<?>>	getColumnTypes()	Returns the column types if is true. For data rows it returns the specific data types of the individual data object (may differ from column class!).
Vector<Object>	getColumnValues()	Returns the column values or the column names (depending on isHeader().
protected void	init(ResultSet aResultSet)	Called by constructor to initializes FWFormTableOption as table row from ResultSet.
protected void	init(ResultSetMetaData aResultMetaData)	Called by constructor to initializes FWFormTableOption as table header from ResultSetMetaData.
protected void	init(Vector<Object> aColValues, Vector<Class<?>> aColTypes)	Called by constructor to initializes FWFormTableOption "from scratch".
protected void	init(org.jdom2.Element aColDef)	Called by constructor to initializes FWFormTableOption from XML-Element.
boolean	isHeader()	Returns whether the FWFormTableOption represents the table header (TRUE) or a table row (FALSE).
void	setImage(ImageIcon aImage)	Always throws UnsupportedOperationException (unless aImage is not null) because FWFormTableOption does not yet support images.

Methods inherited from class net.simplace.pipe.formcomponents.choice.FWFormOption

getHTMLText, getId, getImage, getJumper, getText, getValue, setId, setJumper, setText, toString

Methods inherited from class java.lang.Object

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

Field Details

iIsHeader

protected boolean iIsHeader

Indicates whether option represents the table header

iColValues

protected Vector<Object> iColValues

Holds the column values or the column names (depending on iIsHeader

iColTypes

protected Vector<Class<?>> iColTypes

Holds the column types (only if iIsHeader is true)

Constructor Details

FWFormTableOption

public FWFormTableOption(String aId,
 String aText,
 org.jdom2.Element aOptionElem)

Creates a FWFormTableOption from XML-Element. Weather it represents table header or row depends on the Element (see class documentation).

Parameters:

aId - id-attribute of the option

aText - translated display text of the option (NOT yet used by FWTableChoiceSubComponent!)

aOptionElem - complete -Element the table column values are extracted from

FWFormTableOption

public FWFormTableOption(String aId,
 String aText,
 ResultSetMetaData aResultMetaData)

Creates a table headerFWFormTableOption from SQL Result.

Parameters:

aId - id-attribute of the option

aText - translated display text of the option (NOT yet used by FWTableChoiceSubComponent!)

aResultMetaData - meta data from Statement

FWFormTableOption

public FWFormTableOption(String aId,
 String aText,
 ResultSet aResultSet)

Creates a table row FWFormTableOption from SQL Result.

Parameters:

aId - id-attribute of the option

aText - translated display text of the option (NOT yet used by FWTableChoiceSubComponent!)

aResultSet - result from Statement

FWFormTableOption

public FWFormTableOption(String aId,
 String aText,
 Vector<Object> aColNames,
 Vector<Class<?>> aColTypes)

Creates a table header FWFormTableOption "from scratch".

Parameters:

aId - id-attribute of the option

aText - translated display text of the option (NOT yet used by FWTableChoiceSubComponent!)

aColNames - list of column names

aColTypes - list of column types

FWFormTableOption

public FWFormTableOption(String aId,
 String aText,
 Vector<Object> aColValues)

Creates a table row FWFormTableOption "from scratch".

Parameters:

aId - id-attribute of the option

aText - translated display text of the option (NOT yet used by FWTableChoiceSubComponent!)

aColValues -

aColNames - list of column values

Method Details

init

protected void init(org.jdom2.Element aColDef)

Called by constructor to initializes FWFormTableOption from XML-Element.

Parameters:

aColDef -

init

protected void init(ResultSetMetaData aResultMetaData)

Called by constructor to initializes FWFormTableOption as table header from ResultSetMetaData.

Parameters:

aResultMetaData -

init

protected void init(ResultSet aResultSet)

Called by constructor to initializes FWFormTableOption as table row from ResultSet.

Parameters:

aResultSet -

init

protected void init(Vector<Object> aColValues,
 Vector<Class<?>> aColTypes)

Called by constructor to initializes FWFormTableOption "from scratch". Whether table option represents header or row depends on parameter aColType. If it is not null a header option is created with specified types. Otherwise a row option is created (types are determines from values).

Parameters:

aColValues -

aColTypes -

setImage

public void setImage(ImageIcon aImage)

Always throws UnsupportedOperationException (unless aImage is not null) because FWFormTableOption does not yet support images.

Overrides:

setImage in class FWFormOption

isHeader

public boolean isHeader()

Returns whether the FWFormTableOption represents the table header (TRUE) or a table row (FALSE).

Returns:

getColumnValues

public Vector<Object> getColumnValues()

Returns the column values or the column names (depending on isHeader().

Returns:

getColumnTypes

public Vector<Class<?>> getColumnTypes()

Returns the column types if is true. For data rows it returns the specific data types of the individual data object (may differ from column class!).

Returns: