Monday, October 14, 2013

Attributes of the PageDef.xml File Element

Element SyntaxAttributesAttribute Description
<accessorIterator>BeanClassIdentifies the Java type of beans in the associated iterator/collection.


CacheResultsIf true, manage the data collection between requests.


DataControlThe data control which interprets/returns the collection referred to by this iterator binding.


idUnique identifier. May be referenced by any ADF value binding.


MasterBindingReference to the methodIterator (or iterator) that binds the data collection that serves as the master to the accessor iterator's detail collection.


ObjectTypeThis is used for ADF BC only. A boolean value determines if the collection is an object type or not.


RangeSizeSpecifies the number of data objects in a range to fetch from the bound collection. The range defines a window you can use to access a subset of the data objects in the collection. By default, the range size is set to a range that fetches just ten data objects. Use RangeSize when you want to work with an entire set or when you want to limit the number of data objects to display in the page. Note that the values -1 and 0 have specific meaning: the value -1 returns all available objects from the collection, while the value 0 will return the same number of objects as the collection uses to retrieve from its data source.


RefreshDetermines when and whether the executable should be invoked. Set one of the following properties as required:
  • always - causes the executable to be invoked each time the binding container is prepared. This will occur when the page is displayed and when the user submits changes, or when the application posts back to the page.
  • deferred - refresh occurs when another binding requires/refers to this executable.Since refreshing an executable may be a performance concern, you can set the refresh to only occur if it's used in a binding that is being rendered.
  • ifNeeded - whenever the framework needs to refresh the executable because it has not been refreshed to this point. For example, when you have an accessor hierarchy such that a detail is listed first in the page definition, the master could be refreshed twice (once for the detail and again for the master's iterator). Using ifNeeded gives the mean to avoid duplicate refreshes. This is the default behavior for executables.
  • never - When the application itself will call refresh on the executable during one of the controller phases and does not want the framework to refresh it at all.
  • prepareModel - causes the executable to be invoked each time the page's binding container is prepared.
  • prepareModelIfNeeded - causes the executable to be invoked during the prepareModel phase if this executable has not been refreshed to this point. See also ifNeeded above.
  • renderModel - causes the executable to be invoked each time the page is rendered.
  • renderModelIfNeeded - causes the executable to be invoked during the page's renderModel phase on the condition that it is needed. See also ifNeeded above.


RefreshConditionAn EL expression that when resolved, determines when and whether the executable should be invoked. For example, ${!bindings.findAllServiceRequestIter.findMode} resolves the value of the findModel on the iterator in the ADF binding context AllServiceRequest. Hint: Use the Property Inspector to create expressions from the available objects of the binding context (bindings namespace) or binding context (data namespace), JSF managed beans, and JSP objects.
<invokeAction>BindsDetermines the action to invoke. This may be on any actionBinding. Additionally, in the case, of the EJB session facade data control, you may bind to the finder method exposed by the data control. Built-in actions supported by the EJB session facade data control include:
  • Execute executes the bound action defined by the data collection.
  • Find retreives a data object from a collection.
  • First navigates to the first data object in the data collection range.
  • Last navigates to the first data object in the data collection range.
  • Next navigates to the first data object in the data collection range. If the current range position is already on the last data object, then no action is performed.
  • Previous navigates to the first data object in the data collection range. If the current position is already on the first data object, then no action is performed.
  • setCurrentRowWithKey passes the row key as a String converted from the value specified by the input field. The row key is used to set the currency of the data object in the bound data collection. When passing the key, the URL for the form will not display the row key value. You may use this operation when the data collection defines a multipart attribute key.
  • setCurrentRowWithKeyValue is used as above, but when you want to use a primary key value instead of the stringified key.


idUnique identifier. May be referenced by any ADF action binding


Refreshsee Refresh above.


RefreshConditionsee RefreshCondition above.
<iterator> and <methodIterator>BeanClassIdentifies the Java type of beans in the associated iterator/collection


BindingClassThis is for backward compatibility to indicate which class implements the runtime for this binding definition. Ignored in JDeveloper 10.1.3.


Bindssee Binds above.


CacheResultssee CacheResults above


DataControlName of the DataControl usage in the bindingContext (.cpx) which this iterator is associated with.


DefClassUsed internally for testing.


idUnique identifier. May be referenced by any ADF value binding.


ObjectTypeNot used by EJB session facade data control (used by ADF Business Components only).


RangeSizesee RangeSize above


Refreshsee Refresh above


RefreshConditionsee RefreshCondition above
<page> and <variableIterator>idUnique identifier. In the case of , refers to nested page/region that is included in this page. In the case of the executable, the identifier may be referenced by any ADF value binding


pathUsed by executable only. Advanced, a fully qualified path that may reference another page's binding container.


Refreshsee Refresh above


RefreshConditionsee RefreshCondition above

Tip:
You can determine the order of executable invocation using the refreshAfter attribute. For example, say you have two invokeAction elements; one with an ID of myAction and another with an ID of anotherAction, and you want myAction to fire afteranotherAction. You would set the refreshAfter condition on myAction toanotherAction.
Related Posts Plugin for WordPress, Blogger...