oracle.adfdt.view.dvt.binding.pattern.nBox

Class NBoxOptions

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.nBox.NBoxOptions

public class NBoxOptions
extends DvtExtendedPatternOptions

 NBoxOptions.
 

Binding options that allow the user to change the structure and functionality of a NBox.

Since:

12.1.3.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FACET_NAME_COLUMNS Standard facet name for columns.
static java.lang.String	FACET_NAME_ROWS Standard facet name for rows.

Method Summary

Modifier and Type	Method and Description
void	applyChanges(BinderParams binderParams, org.w3c.dom.Element elementNBox) Applies changes from this set of properties to the subtree rooted by the bind root in the bind params.
static NBoxOptions	cloneFrom(NBoxOptions options) Creates an options class from the specified options class, transferring any common properties
NBoxBindingOptions	getBindingOptions() Returns the BindingOptions of this pattern if present.
java.lang.String	getColumnsTitle() Retrieves the Columns title associated with the NBox.
NBoxExtendedProperties	getExtendedProperties() Returns the ExtendedProperties of this pattern if present.
java.util.HashMap<java.lang.String,java.util.List<NBoxRowOptions>>	getHashMapFacetNameToNBoxRowOptions()
java.util.List<NBoxColumnOptions>	getNBoxColumnOptions() Retrieves the List of NBoxColumnOptions associated with the NBox.
NBoxNodeOptions	getNBoxNodeOptions() Retrieves the NBoxNodeOptions associated with the NBox.
java.util.List<NBoxRowOptions>	getNBoxRowOptions() Retrieves the List of NBoxRowOptions associated with the NBox.
java.lang.String	getRowsTitle() Retrieves the Rows title associated with the NBox.
boolean	isRebind(org.w3c.dom.Element elementRoot)
MarkerOptions	makeMarkerOptions() Marker constructor.
NBoxColumnOptions	makeNBoxColumnOptions() NBoxColumnOptions constructor.
NBoxNodeOptions	makeNBoxNodeOptions() NBoxNodeOptions constructor.
NBoxRowOptions	makeNBoxRowOptions() NBoxRowOptions constructor.
java.lang.String	setColumnsTitle(java.lang.String strColumnsTitle) Specifies the Columns title associated with the NBox.
void	setNBoxColumnOptions(java.lang.String strFacetName, java.util.List<NBoxColumnOptions> listNBoxColumnOptions) Specifies the List of NBoxColumnOptions associated with the NBox.
void	setNBoxNodeOptions(NBoxNodeOptions nboxNodeOptions) Specifies the NBoxNodeOptions associated with the NBox.
void	setNBoxRowOptions(java.lang.String strFacetName, java.util.List<NBoxRowOptions> listNBoxRowOptions) Specifies the List of NBoxRowOptions associated with the NBox.
java.lang.String	setRowsTitle(java.lang.String strRowsTitle) Specifies the Rows title associated with the NBox.

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

FACET_NAME_ROWS

public static final java.lang.String FACET_NAME_ROWS

Standard facet name for rows.

See Also:

Constant Field Values

FACET_NAME_COLUMNS

public static final java.lang.String FACET_NAME_COLUMNS

Standard facet name for columns.

See Also:

Constant Field Values

Method Detail

applyChanges

public void applyChanges(BinderParams binderParams,
                         org.w3c.dom.Element elementNBox)

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:

binderParams - The bind params containing the binding root

elementNBox - A Element

getExtendedProperties

public NBoxExtendedProperties 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 NBoxBindingOptions 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 NBoxOptions cloneFrom(NBoxOptions 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

isRebind

public boolean isRebind(org.w3c.dom.Element elementRoot)

makeNBoxColumnOptions

public NBoxColumnOptions makeNBoxColumnOptions()

NBoxColumnOptions constructor.

Returns:

NBoxColumnOptions

makeNBoxRowOptions

public NBoxRowOptions makeNBoxRowOptions()

NBoxRowOptions constructor.

Returns:

NBoxRowOptions

makeNBoxNodeOptions

public NBoxNodeOptions makeNBoxNodeOptions()

NBoxNodeOptions constructor.

Returns:

NBoxNodeOptions

makeMarkerOptions

public MarkerOptions makeMarkerOptions()

Marker constructor.

Returns:

MarkerOptions

setNBoxRowOptions

public void setNBoxRowOptions(java.lang.String strFacetName,
                              java.util.List<NBoxRowOptions> listNBoxRowOptions)

Specifies the List of NBoxRowOptions associated with the NBox.

Parameters:

strFacetName - A String representing the facet name.

listNBoxRowOptions - A List of NBoxRowOptions associated with the NBox.

See Also:

FACET_NAME_ROWS

getNBoxRowOptions

public java.util.List<NBoxRowOptions> getNBoxRowOptions()

Retrieves the List of NBoxRowOptions associated with the NBox.

Returns:

A List of NBoxRowOptions associated with the NBox.

setNBoxColumnOptions

public void setNBoxColumnOptions(java.lang.String strFacetName,
                                 java.util.List<NBoxColumnOptions> listNBoxColumnOptions)

Specifies the List of NBoxColumnOptions associated with the NBox.

Parameters:

strFacetName - A String representing the facet name.

listNBoxColumnOptions - A List of NBoxColumnOptions associated with the NBox.

See Also:

FACET_NAME_COLUMNS

getNBoxColumnOptions

public java.util.List<NBoxColumnOptions> getNBoxColumnOptions()

Retrieves the List of NBoxColumnOptions associated with the NBox.

Returns:

A List of NBoxColumnOptionss associated with the NBox.

setNBoxNodeOptions

public void setNBoxNodeOptions(NBoxNodeOptions nboxNodeOptions)

Specifies the NBoxNodeOptions associated with the NBox.

Parameters:

nboxNodeOptions - A NBoxNodeOptions associated with the NBox.

getNBoxNodeOptions

public NBoxNodeOptions getNBoxNodeOptions()

Retrieves the NBoxNodeOptions associated with the NBox.

Returns:

A NBoxNodeOptions associated with the NBox.

setRowsTitle

public java.lang.String setRowsTitle(java.lang.String strRowsTitle)

Specifies the Rows title associated with the NBox.

Parameters:

strRowsTitle - A String representing the Rows Title associated with the NBox.

getRowsTitle

public java.lang.String getRowsTitle()

Retrieves the Rows title associated with the NBox.

Returns:

A String representing the Rows Title associated with the NBox.

setColumnsTitle

public java.lang.String setColumnsTitle(java.lang.String strColumnsTitle)

Specifies the Columns title associated with the NBox.

Parameters:

strColumnsTitle - A String representing the Columns Title associated with the NBox.

getColumnsTitle

public java.lang.String getColumnsTitle()

Retrieves the Columns title associated with the NBox.

Returns:

A String representing the Columns Title associated with the NBox.

getHashMapFacetNameToNBoxRowOptions

public java.util.HashMap<java.lang.String,java.util.List<NBoxRowOptions>> getHashMapFacetNameToNBoxRowOptions()