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

Class NBoxPattern

java.lang.Object

oracle.adfdt.view.common.binding.creator.v2.BaseBinder2<NBoxOptions>

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

All Implemented Interfaces:

Binder2<NBoxOptions>, Creator2<NBoxOptions>

public class NBoxPattern
extends BaseBinder2<NBoxOptions>
implements Creator2<NBoxOptions>

 NBoxPattern, the databinding pattern for configuring DVT NBox
 

Since:

12.1.2.0.0

Constructor Summary

Constructors

Constructor and Description
NBoxPattern()

Method Summary

Modifier and Type	Method and Description
BinderResult	bind(BinderParams<NBoxOptions> params) To be implemented by subclasses.
CreatorResult	create(CreatorParams<NBoxOptions> params) Creates nodes to be inserted into the DOM.
NBoxOptions	createOptions(CreatorParams<NBoxOptions> params) If supported by the Creator, can create an pattern options resembling the default options for this creator.
NBoxOptions	generateOptions(BinderParams<NBoxOptions> params) Binders can provide an options class that can be used to configure the environment based on what is already there.
protected org.w3c.dom.Element	getSingleBindRoot(org.w3c.dom.Node bindRoots) Convenience method to return a single element from the set of bind roots.

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

canRebind

Methods inherited from class java.lang.Object

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

Constructor Detail

NBoxPattern

public NBoxPattern()

Method Detail

create

public CreatorResult create(CreatorParams<NBoxOptions> params)

Description copied from interface: Creator2

Creates nodes to be inserted into the DOM. See CreatorResult for other return options.

Specified by:

create in interface Creator2<NBoxOptions>

Parameters:

params - See CreatorParams for listing

Returns:

creator result

bind

public BinderResult bind(BinderParams<NBoxOptions> params)

Description copied from class: BaseBinder2

To be implemented by subclasses. See Binder2 for API usage.

Specified by:

bind in interface Binder2<NBoxOptions>

Specified by:

bind in class BaseBinder2<NBoxOptions>

Parameters:

params - See BinderParams for a complete list

Returns:

Typically just one of the convenience classes in BinderResult

generateOptions

public NBoxOptions generateOptions(BinderParams<NBoxOptions> params)

Description copied from class: BaseBinder2

Binders can provide an options class that can be used to configure the environment based on what is already there. Most binders do not support this however. The framework will never call this method.

Specified by:

generateOptions in interface Binder2<NBoxOptions>

Overrides:

generateOptions in class BaseBinder2<NBoxOptions>

Parameters:

params - See BinderParams for a complete list

Returns:

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

createOptions

public NBoxOptions createOptions(CreatorParams<NBoxOptions> params)

Description copied from interface: Creator2

If supported by the Creator, can create an pattern options resembling the default options for this creator.

Specified by:

createOptions in interface Creator2<NBoxOptions>

Parameters:

params - See CreatorParams for a complete list

Returns:

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

getSingleBindRoot

protected org.w3c.dom.Element getSingleBindRoot(org.w3c.dom.Node bindRoots)

Convenience method to return a single element from the set of bind roots. This is only applicable and useful for binders that are expecting to bind a single element rooted subtree. Specifically, if the bind roots is a document element, the first child (if it's an element) will be returned. If the bind roots is a single element already, that will just be returned. Anything else will return null.

Overrides:

getSingleBindRoot in class BaseBinder2<NBoxOptions>

Parameters:

bindRoots - binding roots

Returns:

element