JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adfinternal.view.js.util
Class AdfAutomationUtils

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.util.AdfAutomationUtils

public class AdfAutomationUtils
extends Object

Utility class only included by automation that exports internal functionality not normally published for framework testing purposes.

Field Summary

Fields inherited from org.ecmascript.object.Object

constructor, prototype

Constructor Summary

public

AdfAutomationUtils() Utility class only included by automation that exports internal functionality not normally published for framework testing purposes.

Method Summary

public static void	doMenuCommand(String locator, Object command, boolean isScrollDown)
public static int	getAutoDismissalManagerElementCount()
public static String	getContainedFormIdForVisiblePopup(String popupId)
public static int	getDialogManagerElementCount()
private static AdfDhtmlDialogServicePopupContainerPeer	_getDlgSrvPopupCtnrPeer()
public static String	getInternalIdForLocator(String id, String subId)
public static int	getModalityManagerElementCount()
public static HTMLElement	getPopupContentDom(String popupId)
public static Object	getPopupDisclosedState(String id) Returns the disclosed state of a popup by id.
public static int	getPositionManagerElementCount()
public static Array	getRichDialogServiceAllIds() Returns an array of ids that uniquely identify all the rich dialogs currently managed by the {@link AdfDhtmlRichDialogService}.
public static Object	getRichDialogServiceState(String dialogId) Returns the state object for a given dialogId.
public static String	getSkinProperty(String key)
public static int	getZOrderManagerElementCount()
public static boolean	isAboveTopGlassPane(String id) Returns true if the dom element identified by client id is above the top modal pane.
public static boolean	isDomElementVisible(Object domElement)
public static Object	queueCachedPollEvents() Queue all outstanding Poll Events when test automation is running with asynchronous updates set to onDemand.
public static Object	selectLovTableRow(String tblLocator, int row) Selects a table row nested in the LOV component.
public static Object	showPopupInZorderScope(String popupId, String zorderScope) Shows a popup identified by is in an alternate zorder container.

Field Detail

Constructor Detail

AdfAutomationUtils

public AdfAutomationUtils()

Utility class only included by automation that exports internal functionality not normally published for framework testing purposes.

Method Detail

doMenuCommand

public static void doMenuCommand(String locator,
Object command,
boolean isScrollDown)

Parameters:

locator	-	menu locator
command
isScrollDown	-	optionally used by the "scroll" command

Return:

void - null

getAutoDismissalManagerElementCount

public static int getAutoDismissalManagerElementCount()

Return:

int - returns the number of elements currently managed by the auto dismissal manager

getContainedFormIdForVisiblePopup

public static String getContainedFormIdForVisiblePopup(String popupId)

Parameters:

popupId

-

to test

Return:

String - the id of the containing form element the shown popup is contained within or an emtpy string if not contained within a form but in the body

getDialogManagerElementCount

public static int getDialogManagerElementCount()

Return:

int - returns the number of elements currently managed by the dialog manager

_getDlgSrvPopupCtnrPeer

private static AdfDhtmlDialogServicePopupContainerPeer _getDlgSrvPopupCtnrPeer()

Return:

AdfDhtmlDialogServicePopupContainerPeer - dialog service container peer

getInternalIdForLocator

public static String getInternalIdForLocator(String id,
String subId)

Parameters:

id	-	of the target component
subId	-	of the target component identified by id

Return:

String - internal id of a dom node identified by id and subId

getModalityManagerElementCount

public static int getModalityManagerElementCount()

Return:

int - returns the number of elements currently managed by the modality manager

getPopupContentDom

public static HTMLElement getPopupContentDom(String popupId)

Parameters:

popupId

-

target popup

Return:

HTMLElement - the content container element for a popup that is made visible

getPopupDisclosedState

public static Object getPopupDisclosedState(String id)

Returns the disclosed state of a popup by id. The resultant map has two properties that identifies that the component by id is a popup or menu and visibility state.

Parameters:

id

-

of the target component to check

Return:

Object

getPositionManagerElementCount

public static int getPositionManagerElementCount()

Return:

int - returns the number of elements currently managed by the position manager

getRichDialogServiceAllIds

public static Array getRichDialogServiceAllIds()

Returns an array of ids that uniquely identify all the rich dialogs currently managed by the AdfDhtmlRichDialogService.

Return:

Array - String array of ids assigned to open rich dialogs

getRichDialogServiceState

public static Object getRichDialogServiceState(String dialogId)

Returns the state object for a given dialogId. If dialogId is not passed as an actual parameter, the last open dialog state is returned.

Parameters:

dialogId

-

(optional) unique id that identifies the state of rich dialog

Return:

Object - state about open dialogs managed by the AdfDhtmlRichDialogService.

getSkinProperty

public static String getSkinProperty(String key)

Parameters:

key

-

used to identify this skin property

Return:

String - skin property

getZOrderManagerElementCount

public static int getZOrderManagerElementCount()

Return:

int - returns the number of elements currently managed by the zorder container

isAboveTopGlassPane

public static boolean isAboveTopGlassPane(String id)

Returns true if the dom element identified by client id is above the top modal pane.

Parameters:

id

-

of a dom element to check

Return:

boolean - null true if the dom element identified by id is above the top modal pane.

isDomElementVisible

public static boolean isDomElementVisible(Object domElement)

Parameters:

domElement

Return:

boolean - null true if the domElement is visible

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

selectLovTableRow

public static Object selectLovTableRow(String tblLocator,
int row)

Selects a table row nested in the LOV component.

Parameters:

tblLocator	-	rich locator such as 'tmplt:query#criterion_value[60]#lovDialog_query#criterion_value[40]#lovDialog_table'
row	-	in the table to select

Return:

Object

showPopupInZorderScope

public static Object showPopupInZorderScope(String popupId,
String zorderScope)

Shows a popup identified by is in an alternate zorder container. The default is the first form in the document. Internal hint AdfDhtmlPopupHints.ZORDER_SCOPE can be used to direct to the contianer form or within the body.

Parameters:

popupId	-	clientId of the target popup
zorderScope	-	values are "ZORDER_SCOPE_CONTAINED_FORM" and "ZORDER_SCOPE_BODY"

Return:

Object

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD