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.

Method Summary

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 set of columns that the table will create when constructing the table.
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	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> fields) 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	setSelectionEnabled(boolean enabled) Determines whether or not the pattern should create or modify the table to support selection of the columns.
void	setSorted(boolean sorted) Determines whether or not the pattern should create or modify the table to support column based sorting.

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> fields)

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 set 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.

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.

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.

setSelectionEnabled

public void setSelectionEnabled(boolean enabled)

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

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.

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.