oracle.adfdt.view.rich.binding.pattern.table

Class Column

java.lang.Object

oracle.adfdt.view.rich.binding.pattern.table.Column

Direct Known Subclasses:

ColumnGroup, DynamicColumn, DynamicHierColumn

public class Column
extends java.lang.Object

Represents a single column in the table. Used mainly to customize the label and what component to use for the column.

Method Summary

Methods

Modifier and Type	Method and Description
static Column	create(oracle.binding.meta.NamedDefinition namedDefinition) Creates a column with the given required named definition.
org.w3c.dom.Element	getColumnElement() Returns column element associated with this Column object and it could reutrn null when Column is not yet bound to any source.
java.lang.String	getDefaultLabelExpr(TableOptions options) Returns default Label expression for this column
oracle.binding.meta.NamedDefinition	getDefinition() The definition the columns's component will use to bind itself with.
java.lang.String	getLabel() Returns the label to be used.
Widget	getWidget() The specific widget to use for this column's contained component.
void	setDefinition(oracle.binding.meta.NamedDefinition namedDefinition, TableOptions options) Set the defintion that the column's component will use to bind itself with.
void	setLabel(java.lang.String label) Sets the label to use for this column.
void	setWidget(Widget widget) Sets the widget to use for this column's contained component.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Column create(oracle.binding.meta.NamedDefinition namedDefinition)

Creates a column with the given required named definition. By default this will generate a default label and use the highest ranked component that is compatible with the table. NOTE: The definition should be vended by TableOptions.getAvailableColumnDefinitions(). If the definition does not exist in that list, an exception will occur when this column is committed.

getDefinition

public oracle.binding.meta.NamedDefinition getDefinition()

The definition the columns's component will use to bind itself with.

setDefinition

public void setDefinition(oracle.binding.meta.NamedDefinition namedDefinition,
                 TableOptions options)

Set the defintion that the column's component will use to bind itself with.

getLabel

public java.lang.String getLabel()

Returns the label to be used. If no label has been set (the label is null), a default label will be used.

setLabel

public void setLabel(java.lang.String label)

Sets the label to use for this column. If no label is set (label is null), a default label will be used.

setWidget

public void setWidget(Widget widget)

Sets the widget to use for this column's contained component. This widget must support this inclusion context and be compatible with the table. For a listing of supported widgets, see the TableOptions.getAvailableWidgets(column) api.

getWidget

public Widget getWidget()

The specific widget to use for this column's contained component. If null, then the default component will be used.

getColumnElement

public org.w3c.dom.Element getColumnElement()

Returns column element associated with this Column object and it could reutrn null when Column is not yet bound to any source.

Returns:

Element column element

getDefaultLabelExpr

public java.lang.String getDefaultLabelExpr(TableOptions options)

Returns default Label expression for this column