JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.automation
Class AdfRichAutomation

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.automation.AdfRichAutomation

public class AdfRichAutomation
extends Object

LOGGER

public static Object LOGGER

_severityMap

private static Object _severityMap

AdfRichAutomation

public AdfRichAutomation()

Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved. The contents of this file are currently considered private implementation details of the RichClient framework and are currently only supported for calls from the RichClient Automation Framework.

cancelPopup

public static Object cancelPopup(String id)

Utility method to cancel a popup

Parameters:

id

-

of the target popup component

Return:

Object

_checkElement

private static Object _checkElement(Object el,
                                    Object caller)

Parameters:

el
caller

Return:

Object

getAllRichDialogIds

public static Array getAllRichDialogIds()

Returns an arrray of ids that identify all the rich dialogs currently open.

Return:

Array - a list of rich dialogs as Numbers

getAndClearLogMessages

public static Array getAndClearLogMessages(Object level)

Collects the log messages recorded in the logger, clears the logger and returns an array containing strings of the form "severity: message"

Parameters:

level

Return:

Array - of Strings of the form "severity: message"

getBodyBounds

public static String getBodyBounds()

Returns the bounds of document body.

Return:

String - element dimensions in the format ",,,"

getComputedStyle

public static Object getComputedStyle(Object el)

Retrieve the computed CSS style for the specified DOM element.

Parameters:

el

Return:

Object - containing the style and its computed values

getElementPageBounds

public static String getElementPageBounds(Object el)

Returns the page bounds object for a DOM element.

Parameters:

el

Return:

String - element dimensions in the format ",,,"

getInlineWindowDomId

public static String getInlineWindowDomId(String clientId)

Gets the inline dialog title.

Parameters:

clientId

-

of the inline dialog

Return:

String - title of the inline dialog

See also:

"#doWaitForRichDialogLaunch"

getRichComponent

public static Object getRichComponent(String clientId)

Gets the rich component instance identified by the clientId.

Parameters:

clientId

-

of the component.

Return:

Object - the rich component object, or underfined of it cannot be found.

getRichComponentByElement

public static Object getRichComponentByElement(Object element)

Gets the component for the dom element.

Parameters:

element

Return:

Object - the rich component object, or underfined of it cannot be found.

getRichComponentProperties

public static List getRichComponentProperties(Object el,
                                              Object attrNames)

Gets a list of property values from a rich component.

Parameters:

el
attrNames

Return:

List - with {propertyName, propertyValue} pairs

getRichComponentProperty

public static Object getRichComponentProperty(Object el,
                                              Object attrName)

Gets a property from a rich component.

Parameters:

el
attrName

Return:

Object - property value, generally a string.

getRichComponentType

public static Object getRichComponentType(Object el)

Gets componentType for the component

Parameters:

el

Return:

Object - null if el is not a rich component, valid component type otherwise.

getRichDialogInfo

public static Array getRichDialogInfo(Object dialogId)

Returns information regarding the dialog identified by the dialogId.

Parameters:

dialogId

Return:

Array - information if dialog is inline or window and its id.

_getSeverity

private static Object _getSeverity(Object level)

Util method to map level to severity

Parameters:

level

Return:

Object

getWaitForRichPageFnName

public static String getWaitForRichPageFnName()

Determines the correct wait method to be used when waiting for a rich page to load. The wait method used may vary depending on PPR Navigation settings.

Return:

String - one of waitForPagePPRNavAlways, waitForPagePPRNavSometimes, waitForPagePPRNavOff

See also:

waitForPagePPRNavAlways()

waitForPagePPRNavSometimes()

waitForPagePPRNavOff()

invokeRichComponentFunction

public static Object invokeRichComponentFunction(Object el,
                                                 Object functionName,
                                                 Object args)

Invokes a function on the rich component.

Parameters:

el
functionName
args

Return:

Object - function 's return value

invokeRichComponentFunctionChain

public static Object invokeRichComponentFunctionChain(Object el,
                                                      Object args)

Invokes a function chain on the rich component.

Parameters:

el
args

Return:

Object - function 's return value

_isInternetExplorer

private static Object _isInternetExplorer()

Return:

Object

locateElementByRich

public static Element locateElementByRich(String locatorString)

Returns the dom element corresponding to the locator string in the format #. If it doesn't find the dom element related to the subid, it returns the dom element of the component itself. Returns null if no component found with the specific scopedId.

Parameters:

locatorString

-

locator string in the format #

Return:

Element - the DOM within the component related to subId.

_logSevereAndThrow

private static Object _logSevereAndThrow(Object msg)

Parameters:

msg

Return:

Object

queueCachedPollEvents

public static Object queueCachedPollEvents()

Queue all outstanding Poll Events when test automation is running with asynchronous updates set to onDemand. When asynchronous updates is set to on, this function does nothing.

Return:

Object

setRichComponentProperty

public static Object setRichComponentProperty(Object el,
                                              Object propertyName,
                                              String value)

Sets a property on a rich component

Parameters:

el
propertyName
value	-	to be set on the property

Return:

Object

subIdToDomEl

public static String subIdToDomEl(String componentLocator,
                                  Object subIds)

Runs through all the subIds of a component and verifies that they return a valid dom. This method exists as we have a few components (like showDetailItem) that aren't setup yet for full subIdToDomElToSubId testing. Once all components are testing via subIdToDomElToSubId, this method can be removed.

Parameters:

componentLocator	-	locator to the rich component
subIds

Return:

String - null , if all the subIds work correctly error string, if some subIds do not work correctly.

subIdToDomElToSubId

public static String subIdToDomElToSubId(String componentLocator,
                                         Object subIds)

Runs through all the subIds of a component and verifies that they return a valid dom which gives back the same subId when converted.

Parameters:

componentLocator	-	locator to the rich component
subIds

Return:

String - null , if all the subIds work correctly error string, if some subIds do not work correctly.

_translateLogLevel

private static Object _translateLogLevel(Object level)

Parameters:

level

Return:

Object

waitForPagePPRNavAlways

public static Boolean waitForPagePPRNavAlways()

Wait method to determine whether we have any outstanding communication with the server when running in PPR Navigation "onWithForcePPR" mode. In this mode, all submits, including full submits are turned into partial submits, so we wait until the server is done before continuing.

Return:

Boolean - null true if the client has no outstanding state to synchronize with the server.

See also:

getWaitForRichPageFnName()

waitForPagePPRNavOff

public static Boolean waitForPagePPRNavOff()

Wait method to determine whether we have any outstanding communication with the server when running in PPR Navigation "off" mode. In this mode, we simulate the normal Selenium mechanism for determine whether a page is loaded and also ensure that the rich client is done initializing itself.

Return:

Boolean - null true if the page is fully loaded with all content available.

See also:

getWaitForRichPageFnName()

waitForPagePPRNavSometimes

public static Boolean waitForPagePPRNavSometimes()

Wait method to determine whether we have any outstanding communication with the server when running in PPR Navigation "On" mode. In this mode, full submits are still full submits and therefore when full submitting we need to wait for the full page to load. When partial submitting, we need to wait untils the server is done.

Return:

Boolean - null true if page has successfully loaded, false otherwise

See also:

getWaitForRichPageFnName()

waitForRichInlineDialogLaunch

public static Boolean waitForRichInlineDialogLaunch(String clientId)

Waits until the client-side rich dialog service knows of a newly opened dialog.

Parameters:

clientId

-

of the inline dialog

Return:

Boolean - true if the wait condition is successful

See also:

"#doWaitForRichDialogLaunch"

"#doWaitForRichDialogReturn"

"#doSelectRichDialog"