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

Class TableOptions

java.lang.Object

oracle.adfdt.view.common.binding.creator.v2.PatternOptions

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

public final class TableOptions
extends PatternOptions

Binding options that allow the user to change the structure and functionality of the table, and help choose what columns should compose the table.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableOptions.Selection

Method Summary

Methods

Modifier and Type	Method and Description
Column	createColumn(oracle.binding.meta.NamedDefinition namedDefinition) Create column for a named definition.
DynamicColumn	createDynamicColumn() Return a dynamic column which consists of an iterator that contains a column that contains a dynamic component widget.
DynamicHierColumn	createDynamicHierarchyColumn() Return a dynamic hierarchy column which embeds a switcher containing a GROUP and ATTRIBUTE facet.
java.util.List<oracle.binding.meta.NamedDefinition>	getAvailableColumnDefinitions() Returns the current list of NamedDefinitions that can be used in conjunction with the Column class, and in particular the create(namedDef) method.
java.util.List<Widget>	getAvailableWidgets(Column column) Returns the set of usable widgets for the given column definition.
java.util.List<Column>	getColumns() Returns the current list of columns that the table will create when constructing the table.
TableOptions.Selection	getSelection()
Column	group(java.util.List<Column> columnList, java.lang.String columnGroupLabel) Group a list of columns into a column group using the specified column group label.
boolean	isFiltered() Determines whether or not the pattern should create or modify the table to support column based filtering.
boolean	isReadOnly() When true, all columns that are auto generated (that is, the component that is picked by the table pattern) will default to read only controls.
boolean	isRebindingToOriginalSource() Returns true if the source of a rebind is the same source as the table was originally created with, otherwise false.
boolean	isSelectionEnabled() Returns true if the pattern should create or modify the table to support selection of the columns.
boolean	isSorted() Returns true if the pattern should create or modify the table to support column based sorting.
void	setColumns(java.util.List<Column> columns) Sets the columns to use to create the table.
void	setFiltered(boolean filtered) Returns true if the pattern should create or modify the table to support column based filtering.
void	setReadOnly(boolean readOnly) Only affects the default generation of column components, where only read only patterns will be considered.
void	setSelection(TableOptions.Selection selection) Determines whether or not the pattern should create or modify the table to support selection of the columns.
void	setSelectionEnabled(boolean enabled) Deprecated. Use setSelection(Selection) instead.
void	setSorted(boolean sorted) Determines whether or not the pattern should create or modify the table to support column based sorting.
void	ungroup(Column column) UnGroup a column group into it's individual columns.

Methods inherited from class oracle.adfdt.view.common.binding.creator.v2.PatternOptions

merge

Methods inherited from class java.lang.Object

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

Method Detail

setColumns

public void setColumns(java.util.List<Column> columns)

Sets the columns to use to create the table. This can either be initially fetched from getColumns(), or can be constructed from scratch (see Column). If constructed from scratch, all definitions must be based of the accessor that was used to generate the table.

getColumns

public java.util.List<Column> getColumns()

Returns the current list of columns that the table will create when constructing the table. If you have not set the columns (via setColumns()), this will be default return all the available column definitions in the accessor definition. The returned list is mutable, however if any modification are made, the list must be set back on this options class via setColumns() in order for the changes to be picked up.

group

public Column group(java.util.List<Column> columnList,
           java.lang.String columnGroupLabel)

Group a list of columns into a column group using the specified column group label.

ungroup

public void ungroup(Column column)

UnGroup a column group into it's individual columns.

createColumn

public Column createColumn(oracle.binding.meta.NamedDefinition namedDefinition)

Create column for a named definition.

createDynamicColumn

public DynamicColumn createDynamicColumn()

Return a dynamic column which consists of an iterator that contains a column that contains a dynamic component widget.

createDynamicHierarchyColumn

public DynamicHierColumn createDynamicHierarchyColumn()

Return a dynamic hierarchy column which embeds a switcher containing a GROUP and ATTRIBUTE facet.

getAvailableColumnDefinitions

public java.util.List<oracle.binding.meta.NamedDefinition> getAvailableColumnDefinitions()

Returns the current list of NamedDefinitions that can be used in conjunction with the Column class, and in particular the create(namedDef) method.

isSorted

public boolean isSorted()

Returns true if the pattern should create or modify the table to support column based sorting.

setSorted

public void setSorted(boolean sorted)

Determines whether or not the pattern should create or modify the table to support column based sorting.

isSelectionEnabled

public boolean isSelectionEnabled()

Returns true if the pattern should create or modify the table to support selection of the columns.

getSelection

public TableOptions.Selection getSelection()

setSelection

public void setSelection(TableOptions.Selection selection)

Determines whether or not the pattern should create or modify the table to support selection of the columns.

setSelectionEnabled

@Deprecated
public void setSelectionEnabled(boolean enabled)

Deprecated. Use setSelection(Selection) instead.

Determines whether or not the pattern should create or modify the table to support selection of the columns. This API enables single selection only.

isReadOnly

public boolean isReadOnly()

When true, all columns that are auto generated (that is, the component that is picked by the table pattern) will default to read only controls. Users can still override individual columns to contain editable components.

setReadOnly

public void setReadOnly(boolean readOnly)

Only affects the default generation of column components, where only read only patterns will be considered. The list of available widgets will continue to show all bindable patterns. Only takes affect when generating new columns. This does not modify existing columns.

setFiltered

public void setFiltered(boolean filtered)

Returns true if the pattern should create or modify the table to support column based filtering.

isFiltered

public boolean isFiltered()

Determines whether or not the pattern should create or modify the table to support column based filtering.

getAvailableWidgets

public java.util.List<Widget> getAvailableWidgets(Column column)

Returns the set of usable widgets for the given column definition. When setting the widget on a column, it must be from among the set of widgets returned by this API.

isRebindingToOriginalSource

public boolean isRebindingToOriginalSource()

Returns true if the source of a rebind is the same source as the table was originally created with, otherwise false. For create cases, this will always return false.