oracle.adfdt.view.dvt.binding.pattern.pivotTable

Class PivotTableOptions

java.lang.Object

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

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

oracle.adfdt.view.dvt.binding.pattern.options.DvtExtendedPatternOptions

oracle.adfdt.view.dvt.binding.pattern.pivotTable.PivotTableOptions

public class PivotTableOptions
extends DvtExtendedPatternOptions

 PivotTableOptions.
 

Binding options that allow the user to change the structure and functionality of an PivotTable.

Since:

12.1.1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PivotTableOptions.CellStampingOption CellStampingOption enum.
static class	PivotTableOptions.PivotFilterBarOptions PivotFilterBarOptions enum.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PIVOT_FILTER_BAR_OPTIONS
static java.lang.String	STAMPING_OPTIONS

Method Summary

Modifier and Type	Method and Description
void	applyChanges(BinderParams bindParams) Applies changes from this set of properties to the subtree rooted by the bind root in the bind params.
static PivotTableOptions	cloneFrom(PivotTableOptions options) Creates an options class from the specified options class, transferring any common properties
PivotTableBindingOptions	getBindingOptions() Returns the BindingOptions of this pattern if present.
PivotTableOptions.CellStampingOption	getCellStampingCellOption() Retrieves whether the default data cell and header cell stamping pattern has been generated or not.
PivotTableExtendedProperties	getExtendedProperties() Returns the ExtendedProperties of this pattern if present.
PivotTableOptions.PivotFilterBarOptions	getPivotFilterBarOption() Retrieves whether a Pivot Filter Bar has been created and bound to the Pivot Table or not.
void	setCellStampingCellOption(PivotTableOptions.CellStampingOption cellStampingOption) Determines if the default data cell and header cell stamping pattern should be generated or removed.
void	setPivotFilterBarOption(PivotTableOptions.PivotFilterBarOptions pivotFilterBarOptions) Specifies if a Pivot Filter Bar should be created and bound to the Pivot Table or removed.

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

Field Detail

PIVOT_FILTER_BAR_OPTIONS

public static final java.lang.String PIVOT_FILTER_BAR_OPTIONS

See Also:

Constant Field Values

STAMPING_OPTIONS

public static final java.lang.String STAMPING_OPTIONS

See Also:

Constant Field Values

Method Detail

applyChanges

public void applyChanges(BinderParams bindParams)

Applies changes from this set of properties to the subtree rooted by the bind root in the bind params. The bind root must be of an Element type for this to take into affect.

Parameters:

bindParams - The bind params containing the binding root

getExtendedProperties

public PivotTableExtendedProperties getExtendedProperties()

Returns the ExtendedProperties of this pattern if present. Properties may be set on the extended properties until the component is bound.

Specified by:

getExtendedProperties in class ExtendedPatternOptions

Returns:

extended properties

getBindingOptions

public PivotTableBindingOptions getBindingOptions()

Description copied from class: DvtExtendedPatternOptions

Returns the BindingOptions of this pattern if present. Binding related properties may be set on the BindingOptions class until the component is bound.

Specified by:

getBindingOptions in class DvtExtendedPatternOptions

Returns:

An instance of a BindingOptions that contains component specific options used by the binding task. Check the component's options class for the specific implementation of BindingOptions used by that component. For instance: charts are using ChartBindingOptions

cloneFrom

public static PivotTableOptions cloneFrom(PivotTableOptions options)

Creates an options class from the specified options class, transferring any common properties

Parameters:

options - the options class that properties will be transferred from

setPivotFilterBarOption

public void setPivotFilterBarOption(PivotTableOptions.PivotFilterBarOptions pivotFilterBarOptions)
                             throws java.lang.UnsupportedOperationException

Specifies if a Pivot Filter Bar should be created and bound to the Pivot Table or removed.

Parameters:

pivotFilterBarOptions - A PivotFilterBarOptions enum that determines whether a Pivot Filter Bar should be created and bound to the Pivot Table or removed (if present).

Throws:

java.lang.UnsupportedOperationException

getPivotFilterBarOption

public PivotTableOptions.PivotFilterBarOptions getPivotFilterBarOption()
                                                                throws java.lang.UnsupportedOperationException

Retrieves whether a Pivot Filter Bar has been created and bound to the Pivot Table or not.

Returns:

PivotFilterBarOptions enum that determines whether a Pivot Filter Bar has been created and bound to the Pivot Table or not.

Throws:

java.lang.UnsupportedOperationException

setCellStampingCellOption

public void setCellStampingCellOption(PivotTableOptions.CellStampingOption cellStampingOption)
                               throws java.lang.UnsupportedOperationException

Determines if the default data cell and header cell stamping pattern should be generated or removed.

Parameters:

cellStampingOption - A CellStampingOption enum that determines whether the default data cell and header cell stamping pattern should be generated for the Pivot Table or removed (if present).

Throws:

java.lang.UnsupportedOperationException

getCellStampingCellOption

public PivotTableOptions.CellStampingOption getCellStampingCellOption()
                                                               throws java.lang.UnsupportedOperationException

Retrieves whether the default data cell and header cell stamping pattern has been generated or not.

Returns:

CellStampingOption enum that determines whether the default data cell and header cell stamping pattern has been generated for the Pivot Table or not.

Throws:

java.lang.UnsupportedOperationException