Skip navigation links

oracle.adf.view.rich.dt
Class Page

java.lang.Object
oracle.adf.view.rich.dt.Page

public final class Page

extends java.lang.Object

The Page is the virtual representation of both the view and model activities related to a JSP document.

Field Summary

static WidgetFactory.WidgetFilter	_WIDGET_FILTER
static java.lang.String	ADF_FACES_DEFAULT_PREFIX
static java.lang.String	ADF_FACES_NS
static java.lang.String	REGION_TAGNAME

Constructor Summary

protected

Page(PageOptions options)

Method Summary

oracle.adfdt.model.objects.Executable	createExecutable(oracle.adfdt.model.binding.BindingInfo executableInfo) Creates a new executable and inserts it into the page definition.
FragmentAndBinding<oracle.adf.controller.internal.dtrt.binding.DTTaskFlowBinding>	createRegionAndBinding(java.lang.String taskFlowPath, java.lang.String taskFlowId) Returns the element representation of the region instance tag for use with JSF JSP documents as well as the DTTaskFlowBinding that is used by the region.
FragmentAndBinding<oracle.adf.controller.internal.dtrt.binding.DTTaskFlowBinding>	createRegionAndBinding(java.lang.String taskFlowPath, java.lang.String taskFlowId, java.util.Map<java.lang.String,java.lang.String> taskFlowBindingParameters) Returns the element representation of the region instance tag for use with JSF JSP documents as well as the DTTaskFlowBinding that is used by the region.
org.w3c.dom.DocumentFragment	createRegionInstance(java.lang.String regionType) Deprecated.
org.w3c.dom.DocumentFragment	createRegionInstance(java.lang.String taskFlowPath, java.lang.String taskFlowId) Returns the element representation of the region instance tag for use with JSF JSP documents.
org.w3c.dom.DocumentFragment	createRegionInstance(java.lang.String taskFlowPath, java.lang.String taskFlowId, java.util.Map<java.lang.String,java.lang.String> taskFlowBindingParameters) Returns the element representation of the region instance tag for use with JSF JSP documents.
oracle.adfdt.model.objects.ControlBinding	findControlBinding(javax.faces.component.UIComponent component) Finds the binding (executable or control) that the component is currently bound to.
oracle.adfdt.model.objects.ControlBinding	findOrCreateControlBinding(oracle.adfdt.model.objects.DataControl dataControl, oracle.binding.meta.NamedDefinition definition, oracle.adfdt.model.binding.BindingInfo controlInfo) Creates a new binding and inserts it into the page definition.
java.util.Map<java.lang.String,Widget>	getAvailableWidgets(oracle.adfdt.model.objects.DataControl dataControl, oracle.binding.meta.NamedDefinition definition) Returns a map of Widget.name to Widgets that can be used to create databound components.
DtAtRtContext	getContext() Returns the DT@RT design time context.
oracle.adfdt.model.objects.Application	getDesignTimeApplication() Returns the current Application CPX represenation.
oracle.adfdt.model.objects.PageDefinition	getDesignTimePageDefinition() Returns the Page Definition for the current view.
static Page	getInstance(oracle.adf.model.BindingContext bindingContext, java.lang.String jspPath) Deprecated. It is advisable to now create a PageOptions object and pass in the parameters via that class to getInstance(...).
static Page	getInstance(oracle.adf.model.BindingContext bindingContext, java.lang.String jspPath, boolean usePersonalization) Deprecated. It is advisable to now create a PageOptions object and pass in the parameters via that class to getInstance(...).
static Page	getInstance(oracle.adf.model.BindingContext bindingContext, java.lang.String applicationFullName, java.lang.String pagePath) Deprecated. It is advisable to now create a PageOptions object and pass in the parameters via that class to getInstance(...).
static Page	getInstance(oracle.adf.model.BindingContext bindingContext, java.lang.String applicationFullName, java.lang.String pagePath, boolean usePersonalization) Deprecated. It is advisable to now create a PageOptions object and pass in the parameters via that class to getInstance(...).
static Page	getInstance(PageOptions options) Returns an new instance of the Page class given the options.
org.w3c.dom.Document	getViewDocument() Returns the read-only representation of the view DOM document.
void	safeDelete(org.w3c.dom.Element subtreeRoot) Safely deletes the elements in the subtree.
void	setPageDefinitionUsageResolver(PageDefinitionUsageResolver resolver)

Methods inherited from class java.lang.Object

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

Field Detail

_WIDGET_FILTER

public static final WidgetFactory.WidgetFilter _WIDGET_FILTER

ADF_FACES_NS

public static final java.lang.String ADF_FACES_NS

See Also:

Constant Field Values

REGION_TAGNAME

public static final java.lang.String REGION_TAGNAME

See Also:

Constant Field Values

ADF_FACES_DEFAULT_PREFIX

public static final java.lang.String ADF_FACES_DEFAULT_PREFIX

See Also:

Constant Field Values

Constructor Detail

Page

protected Page(PageOptions options)

Method Detail

getInstance

public static Page getInstance(PageOptions options)

Returns an new instance of the Page class given the options. See PageOptions for details on what required and optional parameters may be passed in.

Parameters:

options - The configuration options

Returns:

new Page object

getViewDocument

public final org.w3c.dom.Document getViewDocument()

Returns the read-only representation of the view DOM document.

Returns:

DOM document representing the view.

getContext

public final DtAtRtContext getContext()

Returns the DT@RT design time context.

Returns:

Gauranteed design time context designed for DT@RT.

getDesignTimePageDefinition

public oracle.adfdt.model.objects.PageDefinition getDesignTimePageDefinition()

Returns the Page Definition for the current view.

Returns:

The view's Page Definition representation.

getDesignTimeApplication

public oracle.adfdt.model.objects.Application getDesignTimeApplication()

Returns the current Application CPX represenation.

Returns:

The webapp Application representation.

findControlBinding

public oracle.adfdt.model.objects.ControlBinding findControlBinding(javax.faces.component.UIComponent component)

Finds the binding (executable or control) that the component is currently bound to. If the component is not bound to a binding, then null is returned. This method uses a heuristic algorithm to associate a component with a binding.

Parameters:

component - The referring component.

Returns:

Control binding for the component, or null if none.

createExecutable

public oracle.adfdt.model.objects.Executable createExecutable(oracle.adfdt.model.binding.BindingInfo executableInfo)

Creates a new executable and inserts it into the page definition.

Parameters:

executableInfo - Containing namespace of DT binding factory, and name of executable to create.

Returns:

New executable matching the information passed in.

findOrCreateControlBinding

public oracle.adfdt.model.objects.ControlBinding findOrCreateControlBinding(oracle.adfdt.model.objects.DataControl dataControl,
                                                                            oracle.binding.meta.NamedDefinition definition,
                                                                            oracle.adfdt.model.binding.BindingInfo controlInfo)

Creates a new binding and inserts it into the page definition. If an identical binding already exists in the page definition, this will just return that binding.

Parameters:

dataControl - Data control containing passed in definition.

definition - Definition of the data structure to create the binding.

controlInfo - Containing namespace and name of the binding to create.

Returns:

New control binding, or an existing one matching the information passed in.

createRegionInstance

public final org.w3c.dom.DocumentFragment createRegionInstance(java.lang.String taskFlowPath,
                                                               java.lang.String taskFlowId)

Returns the element representation of the region instance tag for use with JSF JSP documents. The region is guaranteed to contain a component ID that is unique to the page.

This will bind the region to the a taskflow binding that will be created given the passed in taskflow path and id (which must uniquely identify a taskflow.

The invocation of this method assumes no view or model parameters.

Parameters:

taskFlowPath - Runtime path to the taskflow.

taskFlowId - Id for the particular taskflow to use.

Returns:

Fully consumable DocumentFragment representing the view region instance.

createRegionInstance

public final org.w3c.dom.DocumentFragment createRegionInstance(java.lang.String taskFlowPath,
                                                               java.lang.String taskFlowId,
                                                               java.util.Map<java.lang.String,java.lang.String> taskFlowBindingParameters)

Returns the element representation of the region instance tag for use with JSF JSP documents. The region is guaranteed to contain a component ID that is unique to the page.

This will bind the region to the a taskflow binding that will be created given the passed in taskflow path and id (which must uniquely identify a taskflow.

Parameters can be passed using the String:String Map.

Parameters:

taskFlowPath - Runtime path to the taskflow.

taskFlowId - Id for the particular taskflow to use.

taskFlowBindingParameters - Parameters to be set on the taskflow binding.

Returns:

Fully consumable DocumentFragment representing the view region instance.

createRegionAndBinding

public final FragmentAndBinding<oracle.adf.controller.internal.dtrt.binding.DTTaskFlowBinding> createRegionAndBinding(java.lang.String taskFlowPath,
                                                                                                                      java.lang.String taskFlowId)

Returns the element representation of the region instance tag for use with JSF JSP documents as well as the DTTaskFlowBinding that is used by the region. The region is guaranteed to contain a component ID that is unique to the page.

This will bind the region to the a taskflow binding that will be created given the passed in taskflow path and id (which must uniquely identify a taskflow.

Parameters can be passed using the String:String Map.

Parameters:

taskFlowPath - Runtime path to the taskflow.

taskFlowId - Id for the particular taskflow to use.

taskFlowBindingParameters - Parameters to be set on the taskflow binding.

Returns:

Fully consumable DocumentFragment representing the view region instance.

createRegionAndBinding

public final FragmentAndBinding<oracle.adf.controller.internal.dtrt.binding.DTTaskFlowBinding> createRegionAndBinding(java.lang.String taskFlowPath,
                                                                                                                      java.lang.String taskFlowId,
                                                                                                                      java.util.Map<java.lang.String,java.lang.String> taskFlowBindingParameters)

Returns the element representation of the region instance tag for use with JSF JSP documents as well as the DTTaskFlowBinding that is used by the region. The region is guaranteed to contain a component ID that is unique to the page.

This will bind the region to the a taskflow binding that will be created given the passed in taskflow path and id (which must uniquely identify a taskflow.

Parameters can be passed using the String:String Map.

Parameters:

taskFlowPath - Runtime path to the taskflow.

taskFlowId - Id for the particular taskflow to use.

taskFlowBindingParameters - Parameters to be set on the taskflow binding.

Returns:

Fully consumable DocumentFragment representing the view region instance.

getAvailableWidgets

public final java.util.Map<java.lang.String,Widget> getAvailableWidgets(oracle.adfdt.model.objects.DataControl dataControl,
                                                                        oracle.binding.meta.NamedDefinition definition)

Returns a map of Widget.name to Widgets that can be used to create databound components. A creatable widget is a composition of bound components. Some examples are:

• Read-only Table
• Master-detail (1:many) Composite
• Output Value

The widgets will be tailored to the particular type of JSR 227 definition that is passed in. For instance, form widgets will only be selectable for structured, and iterator definitions.

See Widget on more discussion on how these widgets can be created.

safeDelete

public final void safeDelete(org.w3c.dom.Element subtreeRoot)

Safely deletes the elements in the subtree. In addition, any referenced binding in the subtree will also be removed so long as the following is not true:

1. The binding is used elsewhere in the view document
2. The binding is used elsewhere in the page definition
   This will delete all bindings - both control and executable as necessary.

   Parameters:

   subtreeRoot - Root of the view subtree to delete

   createRegionInstance

   @Deprecated
   public final org.w3c.dom.DocumentFragment createRegionInstance(java.lang.String regionType)
   

   Deprecated.

   Used to not break any ADFp projects that don't compile with the build.

   getInstance

   @Deprecated
   public static Page getInstance(oracle.adf.model.BindingContext bindingContext,
                                             java.lang.String jspPath)
   

   Deprecated. It is advisable to now create a PageOptions object and pass in the parameters via that class to getInstance(...).

   Creates a new instance of the Page representing the current view document.

   Parameters:

   bindingContext - The runtime binding context.

   jspPath - The context path to the JSP file.

   Returns:

   The Page representing the view document.

   getInstance

   @Deprecated
   public static Page getInstance(oracle.adf.model.BindingContext bindingContext,
                                             java.lang.String jspPath,
                                             boolean usePersonalization)
   

   Deprecated. It is advisable to now create a PageOptions object and pass in the parameters via that class to getInstance(...).

   Creates a new instance of the Page representing the current view document.

   Parameters:

   bindingContext - The runtime binding context.

   jspPath - The context path to the JSP file.

   usePersonalization - controls option to turn on personalization

   Returns:

   The Page representing the view document.

   getInstance

   @Deprecated
   public static Page getInstance(oracle.adf.model.BindingContext bindingContext,
                                             java.lang.String applicationFullName,
                                             java.lang.String pagePath)
   

   Deprecated. It is advisable to now create a PageOptions object and pass in the parameters via that class to getInstance(...).

   Creates a new instance of the Page representing the current view document.

   Parameters:

   bindingContext - the runtime binding context

   applicationFullName - the full name of the application(.cpx) file.

   jspPath - The context path to the JSP file

   Returns:

   The Page representing the view document.

   getInstance

   @Deprecated
   public static Page getInstance(oracle.adf.model.BindingContext bindingContext,
                                             java.lang.String applicationFullName,
                                             java.lang.String pagePath,
                                             boolean usePersonalization)
   

   Deprecated. It is advisable to now create a PageOptions object and pass in the parameters via that class to getInstance(...).

   Creates a new instance of the Page representing the current view document.

   Parameters:

   bindingContext - the runtime binding context

   applicationFullName - the full name of the application(.cpx) file.

   pagePath - The context path to the JSP file

   usePersonalization - Should be true if personalization is to be used.

   Returns:

   The Page representing the view document.

   setPageDefinitionUsageResolver

   public void setPageDefinitionUsageResolver(PageDefinitionUsageResolver resolver)