JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.util
Class AdfSubIdUtils

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

public class AdfSubIdUtils
extends Object

AdfSubIdUtils

public AdfSubIdUtils()

getBestMatchSubId

public static Object getBestMatchSubId(Object domElement,
                                       Object peer,
                                       Object subIdMap)

Default implementation for AdfRichUIPeer#GetBestMatchSubId Returns the best match subId by looking at _SUB_ID_MAP defined by the component if it exists, else returns null if no subId match is found.

- if domElement is the root DOM for the component, then a null value is returned
- if domElement is a descendant of the root DOM for the component, then the DOM element among the list of supported subIds for the component, that is the best match is determined and this best match subId is returned.
- if the domElement has no parent component then a null value is returned WARNING - You must make sure to bind the component to the peer before calling this function.

Parameters:

domElement
peer
subIdMap

Return:

Object

See also:

AdfRichUIPeer.GetSubIdDomElement(Object)

getBestMatchSubIdDelegateSuper

public static Object getBestMatchSubIdDelegateSuper(Object domElement,
                                                    Object peer,
                                                    Object subIdMap,
                                                    Object theClass)

Checks superclass common subid cases else invokes getBestMatchSubId with the subid map "label" and "content" subid cases are handled in the base peers. WARNING - You must make sure to bind the component to the peer before calling this function.

Parameters:

domElement
peer
subIdMap
theClass

Return:

Object

See also:

AdfRichUIPeer.GetSubIdDomElement(Object)

getChildElementByAttributeValue

public static HTMLElement getChildElementByAttributeValue(Object domElement,
                                                          Object attrName,
                                                          Object attrValue,
                                                          Object tagName)

Returns a dom element which is of type specified by tagName and has an attribute whose value is equal to attrValue. If it does not get any element with that attribute it returns null.

Deprecated: This method has been deprecated. Please use AdfDomUtils.getChildElementByAttributeValue

Parameters:

domElement	-	the dom element which contains child element to locate
attrName	-	the name of the attribute on the element
attrValue	-	the value of the attribute on the element
tagName	-	name of the tag, if undefined then tagName=

Return:

HTMLElement - The element with matching attribute value, or null if none exist

getChildElementByValueMap

public static HTMLElement getChildElementByValueMap(Object domElement,
                                                    Object keyValueArray,
                                                    Object tagName)

Returns a dom element which is of type specified by tagName and has an attribute whose key-value is provided by valueMap. If it does not get any element with that attribute it returns null.

Deprecated: This method has been deprecated. Please use AdfDomUtils.getChildElementByValueMap

Parameters:

domElement	-	the dom element which contains child element to locate
keyValueArray	-	key-value array for the attribute
tagName	-	name of the tag, if undefined then tagName=

Return:

HTMLElement - The element with matching attribute value, or null if none exist

getChildElementsByAttributeValue

public static HTMLElement[] getChildElementsByAttributeValue(Object domElement,
                                                             Object attrName,
                                                             Object attrValue,
                                                             Object tagName)

Returns the set of dom elements which are of the type specified by tagName and have an attribute whose value is equal to attrValue. If it doesn't find any element with that attriburte it returns null.

Deprecated: This method has been deprecated. Please use AdfDomUtils.getChildElementsByAttributeValue

Parameters:

domElement	-	the dom element which contains child elements to locate
attrName	-	the name of the attribute on the element
attrValue	-	the value of the attribute on the element
tagName	-	name of the tag, if undefined then tagName=

Return:

HTMLElement[] - Elements with matching attribute value, or null if none exist

getSubIdDomElementByMappedSubId

public static HTMLElement getSubIdDomElementByMappedSubId(String subElementId,
                                                          Object subIdMap,
                                                          AdfUIComponent component)

Returns the dom element for a given subElementId. Note that it is preferable to call this method with the subIdMap and component parameters, as otherwise this method will fail unless using method remapping (which is ugly/buggy code).

Parameters:

subElementId	-	the id of the child dom element or component
subIdMap	-	the map of sub IDs for the component's peer
component	-	the component whose subElement you wish to access

Return:

HTMLElement - the DOM within the component related to scopedId

getSubIdDomElementDelegateSuper

public static HTMLElement getSubIdDomElementDelegateSuper(String subElementId,
                                                          Object subIdMap,
                                                          AdfRichUIPeer component,
                                                          Object peer,
                                                          Object theClass)

Checks superclass for subid cases handled at the base class level else will invoke getSubIdDomElementByMappedSubId "content" and "label" is handled by base peer for input components

Parameters:

subElementId	-	the id of the child dom element or component
subIdMap	-	the map of sub IDs for the component's peer
component	-	Peer
peer
theClass

Return:

HTMLElement - the DOM within the component related to subId

getSubIdElementById

public static HTMLElement getSubIdElementById(AdfUIComponent component,
                                              String subElementId,
                                              Object isNC)

Returns the dom element for a given sub Element Id.

Parameters:

component	-	the adf component
subElementId	-	the id of the child dom element or component
isNC

Return:

HTMLElement - the DOM within the component related to subElementId