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

java.lang.Object
  oracle.adfdt.view.common.binding.creator.v2.BaseBinder2<O>
      oracle.adfdt.view.common.binding.creator.v2.BasePattern<TableOptions>
          oracle.adfdt.view.rich.binding.pattern.table.TablePattern

All Implemented Interfaces:

Binder2<TableOptions>, Creator2<TableOptions>

public class TablePattern
extends BasePattern<TableOptions>

The pattern responsible for creation and binding an ADF table. This pattern has three uses: 1. It can be used to create a table. 2. It can be used to determine the characteristics of an existing table. 3. It can be used to rebind an existing table. See the APIs on Creator2 and Binder2 for more details on these use cases.

Constructor Summary

TablePattern()

Method Summary

BinderResult	bind(BinderParams<TableOptions> params) Binds or rebinds a table.
CreatorResult	create(CreatorParams<TableOptions> params) Creates a table.
TableOptions	createOptions(CreatorParams<TableOptions> params) Returns a TableOptions class that is populated with the default options for sorting, filtering, selection, etc.
TableOptions	generateOptions(BinderParams<TableOptions> params) Returns a TableOptions class that is prepopulated with state to match the existing table.

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

canRebind, getSingleBindRoot

Methods inherited from class java.lang.Object

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

Constructor Detail

TablePattern

public TablePattern()

Method Detail

create

public CreatorResult create(CreatorParams<TableOptions> params)

Creates a table. If you wish to customize the columns of the table, or change how the table is generated, you must set a TableOptions class on the parameters that is passed in.

Specified by:

create in interface Creator2<TableOptions>

Specified by:

create in class BasePattern<TableOptions>

Parameters:

params - See CreatorParams for listing

bind

public BinderResult bind(BinderParams<TableOptions> params)

Binds or rebinds a table. Customization of the table is controller by TableOptions, which can be set on the parameters object. Rebinding a table is usually destructive (that is some changes are made to the DOM), even if the net result is no changes to the table. On a rebind, all characteristics of a table may be changed (i.e. filtering, sorting, selection) and even the set of columns, or the components that are used within those columns.

Specified by:

bind in interface Binder2<TableOptions>

Specified by:

bind in class BaseBinder2<TableOptions>

Parameters:

params - See BinderParams for a complete list

Returns:

Typically just one of the convenience classes in BinderResult

createOptions

public TableOptions createOptions(CreatorParams<TableOptions> params)

Returns a TableOptions class that is populated with the default options for sorting, filtering, selection, etc.

Specified by:

createOptions in interface Creator2<TableOptions>

Overrides:

createOptions in class BasePattern<TableOptions>

Parameters:

params - See CreatorParams for a complete list

Returns:

An instance of PatternOptions with the current options set, or null if not supported

generateOptions

public TableOptions generateOptions(BinderParams<TableOptions> params)

Returns a TableOptions class that is prepopulated with state to match the existing table. That is, options for filtering, sorting, and selection will match what the current table is making use of. The one exception is the read only status. This will never be set by this method. Users can also expect that the current set of columns will be accurately returned from this class. This includes the text used for the header, and the widget used to generate the component with the column. In fact, it is gauranteed that the widget used by the component will be set on all columns that are returned. Note: Columns that do not have components that have registered patterns are currently omitted.

Specified by:

generateOptions in interface Binder2<TableOptions>

Overrides:

generateOptions in class BaseBinder2<TableOptions>

Parameters:

params - See BinderParams for a complete list

Returns:

An instance of PatternOptions with the current options set, or null if not supported