JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfLocators

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfLocators

public class AdfLocators
extends Object

AdfLocators

public AdfLocators()

Class to support automation

_addNameMatcher

private static Object _addNameMatcher(Object locator,
                                      Object startIndex,
                                      Object endIndex,
                                      Object matchers)

This function is currently commented out as this feature is currently disabled. Converts booleans for adding the component and terminating early to a component filter result

Parameters:

locator
startIndex
endIndex
matchers

Return:

Object

_buildMatchers

private static Object _buildMatchers(Object locator,
                                     Object nameMatchers,
                                     Object conditionMatchers)

Parse the locator and build the filter expressions to use

Parameters:

locator
nameMatchers
conditionMatchers

Return:

Object

_executeConditionMatchers

private static Object _executeConditionMatchers(Object conditionMatchers,
                                                Object filterOutput,
                                                Object matchedComponents)

Parameters:

conditionMatchers
filterOutput
matchedComponents

Return:

Object

_executeMatchers

private static Object _executeMatchers(Object nameMatchers,
                                       Object conditionMatchers)

Parameters:

nameMatchers
conditionMatchers

Return:

Object

_executeNameMatchers

private static Object _executeNameMatchers(Object nameMatchers,
                                           Object filterOutput)

Parameters:

nameMatchers
filterOutput

Return:

Object

findComponentByAbsoluteLocator

public static AdfUIComponent findComponentByAbsoluteLocator(Object page,
                                                            String absoluteLocator)

Retrieves a component by its absolute locator.

Parameters:

page
absoluteLocator	-	an implementation-agnostic String identifier. Provided primarily for test automation users. For most components, absoluteLocator will be same as absoluteId, except in the case of stamping components like table.

Return:

AdfUIComponent - the matching component instance, or null if no component matching that absolute locator exists.

See also:

AdfPage.findComponentOrAncestorByAbsoluteLocator(String)

AdfUIComponent.getAbsoluteLocator()

_findComponentByAbsoluteLocator

private static Object _findComponentByAbsoluteLocator(Object page,
                                                      Object componentId,
                                                      Object absoluteLocator)

Given a componentId and absoluteLocator, return the component with that absolute locator.

Parameters:

page
componentId
absoluteLocator

Return:

Object

findComponentByComplexLocator

public static Object findComponentByComplexLocator(Object page,
                                                   Object locator)

This method allows for "wildcard" searches. These forms are allowed: For af:table, af:treetable, af:tree, af:iterator and af:listView: <absolute locator>[<id1>.<property> = '<value>'].<id2> will match row(s) where <id>.<property> = '<value>' is true. <absolute locator>[*] will match all the rows (useful for nested cases) such as <absolute locator>[*].<id>[<id1>.<property> = '<value>'].<id2> For af:forEach: <absolute locator>.<partial id>*(<id1>.<property> = '<value>').<id2>

Parameters:

page
locator	-	The absolute locator filter expression

Return:

Object - the component, if a single match is found. If zero matches, or more than 1 match, null is returned.

See also:

findComponentsByComplexLocator(Object, Object)

findComponentOrAncestorByAbsoluteLocator

public static AdfUIComponent findComponentOrAncestorByAbsoluteLocator(Object page,
                                                                      String absoluteLocator)

Retrieves a component or one of its ancestors by its absolute locator. If a component with exactly the specified absolute locator isn't found, the nearest locatable ancestor is searched for by truncating the absolute locator from the end. This can help with backwards compatibility with obsolete locators.

Parameters:

page
absoluteLocator	-	an implementation-agnostic String identifier. Provided primarily for test automation users. For most components, absoluteLocator will be same as absoluteId, except in the case of stamping components like table.

Return:

AdfUIComponent - the matching component instance, or undefined if no component or ancestor matching that absolute locator exists.

See also:

AdfPage.findComponentOrAncestorByAbsoluteLocator(String)

AdfUIComponent.getAbsoluteLocator()

findComponentsByComplexLocator

public static Object findComponentsByComplexLocator(Object page,
                                                    Object locator)

This method allows for "wildcard" searches. These forms are allowed: For af:table, af:treetable, af:tree, af:iterator and af:listView: <absolute locator>[<id1>.<property> = '<value>'].<id2> will match row(s) where <id>.<property> = '<value>' is true. <absolute locator>[*] will match all the rows (useful for nested cases) such as <absolute locator>[*].<id>[<id1>.<property> = '<value>'].<id2> For af:forEach: <absolute locator>.<partial id>*(<id1>.<property> = '<value>').<id2>

Parameters:

page
locator	-	The absolute locator filter expression

Return:

Object - the array of matching components, or the empty array if there are no matches.

See also:

findComponentByComplexLocator(Object, Object)

_findComponentsByParsedWildcardLocator

private static Object _findComponentsByParsedWildcardLocator(Object locator)

Find a component with a locator that is known to have a wildcard filter expression

Parameters:

locator

Return:

Object

_findComponentsByWildcardLocator

private static Object _findComponentsByWildcardLocator(Object locator)

Find a component based on a locator with a wildcard filter expression.

Parameters:

locator

Return:

Object

_getBracketedExpression

private static Object _getBracketedExpression(Object locator,
                                              Object startIndex,
                                              Object lBracket,
                                              Object rBracket)

Returns an a filter expression in between brackets

Parameters:

locator
startIndex
lBracket
rBracket

Return:

Object

_isIndex

private static Object _isIndex(Object arrayExpression)

Parameters:

arrayExpression

Return:

Object

_isWildcardExpression

private static Object _isWildcardExpression(Object arrayExpression)

Parameters:

arrayExpression

Return:

Object

_matchByExpression

private static Object _matchByExpression(Object component)

Parameters:

component

Return:

Object

_matchComponentByName

private static Object _matchComponentByName(Object component)

AdfPage.matchComponents() filter function. This function first matches the absolute locator against the combination of a base and relative locator. Base locators ending in "[*]" are wildcards and considered to match any locator ending in brackets. If the combination of base and relative locator match, the component is added to the matchedComponents.

Parameters:

component

Return:

Object

_parseExpression

private static Object _parseExpression(Object arrayExpression,
                                       Object nameMatcherId,
                                       Object conditionMatchers)

Parameters:

arrayExpression
nameMatcherId
conditionMatchers

Return:

Object

_parseLocator

private static Object _parseLocator(Object locator,
                                    Object startIndex,
                                    Object nameMatchers,
                                    Object conditionMatchers)

Parameters:

locator
startIndex
nameMatchers
conditionMatchers

Return:

Object