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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADF_FACES_DEFAULT_PREFIX |
static java.lang.String |
ADF_FACES_NS |
static java.lang.String |
REGION_TAGNAME |
Modifier | Constructor and Description |
---|---|
protected |
Page(PageOptions options) |
Modifier and Type | Method and Description |
---|---|
oracle.adfdt.model.objects.Executable |
createExecutable(oracle.adfdt.model.binding.BindingInfo executableInfo)
Creates a new executable and inserts it into the page definition.
|
RegionCreationResult |
createRegion(RegionCreationParams params)
Returns the element representation of the region instance tag for use
with JSF JSP documents as well as other related artifacts that
is used by the region.
|
FragmentAndBinding<oracle.adf.controller.internal.dtrt.binding.DTTaskFlowBinding> |
createRegionAndBinding(java.lang.String taskFlowPath,
java.lang.String taskFlowId)
Deprecated.
Use createRegion() instead.
|
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)
Deprecated.
Use createRegion() instead.
|
org.w3c.dom.DocumentFragment |
createRegionInstance(java.lang.String regionType)
Deprecated.
|
org.w3c.dom.DocumentFragment |
createRegionInstance(java.lang.String taskFlowPath,
java.lang.String taskFlowId)
Deprecated.
Use createRegion() instead.
|
org.w3c.dom.DocumentFragment |
createRegionInstance(java.lang.String taskFlowPath,
java.lang.String taskFlowId,
java.util.Map<java.lang.String,java.lang.String> taskFlowBindingParameters)
Deprecated.
Use createRegion() instead.
|
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 Widget s 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) |
public static final java.lang.String ADF_FACES_NS
public static final java.lang.String REGION_TAGNAME
public static final java.lang.String ADF_FACES_DEFAULT_PREFIX
protected Page(PageOptions options)
public static Page getInstance(PageOptions options)
PageOptions
for details on what required and optional parameters
may be passed in.options
- The configuration optionspublic final org.w3c.dom.Document getViewDocument()
public final DtAtRtContext getContext()
public oracle.adfdt.model.objects.PageDefinition getDesignTimePageDefinition()
public oracle.adfdt.model.objects.Application getDesignTimeApplication()
public oracle.adfdt.model.objects.ControlBinding findControlBinding(javax.faces.component.UIComponent component)
component
- The referring component.public oracle.adfdt.model.objects.Executable createExecutable(oracle.adfdt.model.binding.BindingInfo executableInfo)
executableInfo
- Containing namespace of DT binding factory, and
name of executable to create.public oracle.adfdt.model.objects.ControlBinding findOrCreateControlBinding(oracle.adfdt.model.objects.DataControl dataControl, oracle.binding.meta.NamedDefinition definition, oracle.adfdt.model.binding.BindingInfo controlInfo)
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.public final RegionCreationResult createRegion(RegionCreationParams params)
Returns the element representation of the region instance tag for use with JSF JSP documents as well as other related artifacts 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.
Information about the input/return of this method is located in the
RegionCreationParams
and RegionCreationResult
classes respectively.
params
- A valid set of parameters for region creation (see the class for
details).DocumentFragment
representing the
view region instance as well as associated metadata.java.lang.IllegalStateException
- if the set of parameters is not complete. See that
class for more details.@Deprecated 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.
taskFlowPath
- Runtime path to the taskflow.taskFlowId
- Id for the particular taskflow to use.DocumentFragment
representing the
view region instance.@Deprecated 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
.
taskFlowPath
- Runtime path to the taskflow.taskFlowId
- Id for the particular taskflow to use.taskFlowBindingParameters
- Parameters to be set on the taskflow
binding.DocumentFragment
representing the
view region instance.@Deprecated 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
.
taskFlowPath
- Runtime path to the taskflow.taskFlowId
- Id for the particular taskflow to use.DocumentFragment
representing the
view region instance.@Deprecated 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
.
taskFlowPath
- Runtime path to the taskflow.taskFlowId
- Id for the particular taskflow to use.taskFlowBindingParameters
- Parameters to be set on the taskflow
binding.DocumentFragment
representing the
view region instance.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 Widget
s that
can be used to create databound components. A creatable widget is a
composition of bound components. Some examples are:
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.
public final void safeDelete(org.w3c.dom.Element subtreeRoot)
subtreeRoot
- Root of the view subtree to delete@Deprecated public final org.w3c.dom.DocumentFragment createRegionInstance(java.lang.String regionType)
@Deprecated public static Page getInstance(oracle.adf.model.BindingContext bindingContext, java.lang.String jspPath)
Creates a new instance of the Page
representing the
current view document.
bindingContext
- The runtime binding context.jspPath
- The context path to the JSP file.Page
representing the view document.@Deprecated public static Page getInstance(oracle.adf.model.BindingContext bindingContext, java.lang.String jspPath, boolean usePersonalization)
Creates a new instance of the Page
representing the
current view document.
bindingContext
- The runtime binding context.jspPath
- The context path to the JSP file.usePersonalization
- controls option to turn on personalizationPage
representing the view document.@Deprecated public static Page getInstance(oracle.adf.model.BindingContext bindingContext, java.lang.String applicationFullName, java.lang.String pagePath)
Creates a new instance of the Page
representing the
current view document.
bindingContext
- the runtime binding contextapplicationFullName
- the full name of the application(.cpx) file.pagePath
- The context path to the JSP filePage
representing the view document.@Deprecated public static Page getInstance(oracle.adf.model.BindingContext bindingContext, java.lang.String applicationFullName, java.lang.String pagePath, boolean usePersonalization)
Creates a new instance of the Page
representing the
current view document.
bindingContext
- the runtime binding contextapplicationFullName
- the full name of the application(.cpx) file.pagePath
- The context path to the JSP fileusePersonalization
- Should be true if personalization is to be used.Page
representing the view document.public void setPageDefinitionUsageResolver(PageDefinitionUsageResolver resolver)