OracleJavaScript API Reference for Oracle ADF Faces

 

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

oracle.adfinternal.view.js.agent.ie
Class AdfIEAgent

Warning:

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.agent.AdfAgent
               |
               +--oracle.adfinternal.view.js.agent.ie.AdfIEAgent
Direct Known Subclasses:
AdfIE6Agent, AdfIE8Agent

public class AdfIEAgent
extends AdfAgent
IE AdfAgent capabilities.



Field Summary

private static Object
_CAPTURE_PANE_STYLE_CLASS
private static Object
_CSS3_TO_IE_MAP
Maps the CSS3 cursor name to the nearest CSS2 cursor name
private static Object
_CSS_TO_DOM_MAP
Maps the CSS property name to DOM property name.
private Object
_cursorURLsInited
private static Object
_DEFAULT_WINDOW_ID
private Object
_EVENT_CAPTURES
private Object
_ID_TO_DOM_MAP
private Object
_imageURLs
private static Object
_IMG_URL_LOADED
private static Object
_IN_CAPTURE
private static Object
_REDISTRIBUTE_EVENTS
private static Object
_RESIZE_EVENTS
private Object
_scrollRecord
private static Object
_SESSION_WINDOW_DATA_TIMEOUT
private static Object
_USERDATA_BEHAVIOR
private static Object
_USERDATA_DATA_ELEMENT
private static Object
_USERDATA_ID
private static Object
_USERDATA_PROP_KEY
private static Object
_USERDATA_PROP_VALUE
private static Object
_USERDATA_ROOT_ELEMENT_ID
private static Object
_USERDATA_SEPARATOR
private static Object
_USERDATA_WINDOW_ELEMENT
private static Object
_USERDATA_WINDOW_ID
private Object
_userDataStorageInstance


Fields inherited from oracle.adf.view.js.agent.AdfAgent

AGENT, GECKO_PLATFORM, IE_PLATFORM, KEY_EVENTS, MAC_OS, OPERA_PLATFORM, SOLARIS_OS, UNKNOWN_OS, UNKNOWN_PLATFORM, WEBKIT_PLATFORM, WINDOWS_OS


Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass


Fields inherited from org.ecmascript.object.Object

prototype


Constructor Summary

public
AdfIEAgent(Object domWindow)
IE AdfAgent capabilities.


Method Summary

public Object
addBubbleEventListener(Object element, Object eventType, Object listener)
Adds an event listener that fires in the non-Capture phases for the specified eventType.
private Object
_addCapturePane(Object nodeId)
Creates and adds the element to use to simulate event capture in IE.
public Object
addEventBubbles(Object element, Object listener)
Adds event listeners for all of the events that the Rich client framework is interested in to the relevant element using the specified listener
public Object
addEventCaptures(Node node, Function listener)
Adds event captures for all of the events that the Rich client framework is interested in to the relevant element using the specified listener
public Object
addKeyEventListener(Object element, Object listener)
Adds key event listener to the specified element.
public Object
addOption(Object element, Object label, Object value, Object selected, Object disabled, Object description, Object index)
IE doesn't support disabled options natively TODO - investigate showing a "disabled" option in ie - some fancy javascript could probably make it work
public Object
allElementsRemoved()
Resets any id->element cache when all elements are removed This method should be called AFTER the elements are removed
public Object
autoCompleteForm(Object htmlForm)
private Object
_captureListener(Event domEvent)
Listener for redistributing captured events.
private static Object
_captureListenerStub()
Stub for distributing events to the AdfIEAgent instance
public Object
checkMouseOutEvent(Object element, Object evt)
Checks wthether a mouseout event was received by the container when mouse was moved form one of its child elements to another
public Object
clearSubtreeIds(Object element)
Clear id of the specified element and its children.
public Object
cloneEvent(Object event, Object newTarget)
Returns a new Event Object, based on a current event, retargetted to the new target.
public Node
cloneNode(Node domNode)
Clones a DOM node with special handling for IE7.
private static Object
_computeScrollDelta(Object scrollRecord, Object viewPortSize, Object canvasSize, Object dragDelta)
public Event
copyEvent(Event event)
Copies an event from an existing event.
protected Object
CreateNativeLogWriter()
Creates and returns the native AdfLogWriter to use for this AdfAgent
public DOMElement
createStyle(String content)
Inserts a new style block into the document using the specified style content.
protected Object
CreateUIInputEvent(Object component, Object type, Object nativeEvent)
private Object
_createUserDataChildNode(Object objXmlDoc, String nodeName, String nodeIdName, String nodeIdVal)
This function creates a node element using passed xmlDocument with the given node element name and then set the node id as nodeIdName and value as nodeIdVal
public Object
createXmlDocument()
private Object
_deliverEventToEventCaptures(Object eventCaptures, Object capturedEvent)
Delivers the specified event to all of the event capture listeners
public Object
disableUserSelect(Object element)
Disable the user's ability to select text in this component
public Object
dispatchEvent(Object targetElement, Object event)
Dispatches the specified event to the target, returning whether the dispatch was successful
private static Object
_doNothing()
public Object
elementFromPagePoint(Object pageX, Object pageY, Object hintElement, Object exclusionContext, Object exclusionCallback)
Returns the topmost element at the give mouse point in Window coordinates.
public Object
elementsAdded(Object node)
Updates any id->element cache by adding the elements in the specified subtree
public Object
elementsRemoved(Object node)
Updates any id->element cache by removing the elements in the specified subtree.
public Object
enableUserSelect(Object element)
Enable the user's ability to select text in this component
public Object
endDocumentKeyEventCapture(Object listenerMap, Object focusProxy, Object focusState)
Remove agent-specific techniques for capturing key events for the focusProxy's document
public Object
execScript(Object ownerWindow, Object scriptText)
Executes a script.
private Object
_getAttribute(Object node, Object attrName)
private Object
_getBlockingDiv()
Conveenience function for getting the glasspane DIV used with inline editing
public Object
getBooleanAttribute(Object element, Object attrName, Object defaultValue)
Returns the value of a boolean attribute.
public Number
getBrowserViewportScrollLeft()
private String
_getCapturePaneId(Object nodeId)
Returns the id of the capture pane for the node with the specified id.
public Object
getComputedStyle(Object element)
Tries to return the current style, taking into account the inline styles and style sheets
protected Object
GetCssToDomPropertyNameMap()
Returns the map which contains the CSS property name and it's DOM version.
public Object
getCursor(Object cursorName)
Returns the CSS cursor property value to return for a CSS3 cursor name
public Array<AdfUIComponent>
getDescendantComponentsForNode(Node node, Array<AdfUIComponent> children)
Get components descended from a node.
public Object
getElementById(Object id)
Cover function to allow more performant implementations of document.getElementById()
public Object
getElementLeft(Object element)
Returns the element's left side in Window coordinates.
public Object
getElementPageBounds(HTMLElement domElement)
Return a rectangle object containing the page bounds of an element in top/left/bottom/right form
public Object
getElementPosition(Object element)
Returns HTML element's coordinates relative to the document's body
public Object
getElementTop(Object element)
Returns the element's top side in Window coordinates.
public Object
getEventFromElement(Object nativeEvent)
Some events, like the mouseover event, can tell you the dom node being moved from.
public Object
getEventTarget(Object event)
public Object
getEventToElement(Object nativeEvent)
Some events, like the mouseout event, can tell you the dom node being moved to.
public Object
getFormElement(Object form, Object elementName)
Finds the form element by name.
public Object
getIntAttribute(Object element, Object attrName, Object defaultValue)
Returns the value of a number attribute.
public Object
getLocalName(Object element)
public Object
getMousePosition(Object evt)
Returns event's mouse coordinates relative to the document
public Object
getNodeName(Object node)
This method returns the name of the node in all upper case letters.
public Object
getNodeXml(Object node)
public Object
getOverrideStyle(Object element)
Returns the override style for this element
public Object
getPrefix(Object element)
protected Array
GetResizeEvents()
An array of event types used by the addResizeListener and removeResizeListener functions.
public String
getSessionStorageProperty(String propKey, Number dataTimeout)
This function returns the value for a given key stored in data storage using userData.
public Object
getStyleProperty(Object style, Object propertyName)
Returns the value of a property for the AdfAgent's style object
public Object
getTableRowCells(Object tableRow)
At least on IE8 running in IE7 mode, the .cells collection for unconnected tables is empty.
public Object
getTextContent(Object node)
Returns the text content of a Node, as per DOM-level 3 spec
private Object
_getUserDataChildNode(Array children, String childName, String childVal)
This function returns the child node if it is found in the children array else returns null.
private Object
_getUserDataStorageDataNode(Object objXMLDoc, String propKey)
Returns the data node for existing propkey in given storage node.
private String
_getUserDataStorageId()
This function retruns the userData storage id.
public Number
getWindowClientHeight(Window domWindow)
Returns the client (or inner) height of the DOM window Object
public Number
getWindowClientWidth(Window domWindow)
Returns the client (or inner) width of the DOM window Object
public Object
getWindowHeight()
Returns the content height of the browser window
public Number
getWindowScrollHeight(Window domWindow)
Returns the scroll (or canvas) height of the DOM window Object
public Number
getWindowScrollWidth(Window domWindow)
Returns the scroll (or canvas) width of the DOM window Object
public Object
getWindowWidth()
Returns the content width of the browser window
private Object
_handleInlineEditingClick(Object domEvent)
Handles clicks on the scrollbars during inline editing
private Object
_handleInlineEditingMouseDown(Object domEvent)
Handles a mouse down during inline editing.
private Object
_handleInlineEditingMouseMove(Object domEvent)
Handles fake scrollbar thumb drags during inline editing
private Object
_handleInlineEditingMouseUp(Object domEvent)
Clean up the fake scrolling when the moouse comes up
private static Object
_handleScrollInterval()
Callback from in inline editing scrollbar timers
private static Object
_imageReadyCallback()
Actually updates the images used once they have finished loading
protected Object
Init(Object domWindow)
Initializes the instance.
private static Boolean
_isCapturePane(HTMLElement element)
Tests whether the specified element is a capture pane.
public boolean
isChromeEvent(Event domEvent)
Returns true if the event was on the element chrome
public Object
isDisabledOptionSupported()
Returns whether or not disabled is supported on an option tag
public Object
isEqualIcon(Object firstIcon, Object secondIcon)
IE's img icons innerHTML can be different.
public Object
isFunctionKey(Object keyEvent)
Returns whether the event's keycode should be considered as a function key.
public Object
isLeftButton(Object evt)
public Boolean
isSessionStorageEnabled()
This function returns true if userData persistence is enabled; false otherwise.
private Object
_loadUserDataFromStore()
This function reads information from the UserData store and loads it onto the object participating in the userData persistence.
public Object
parseXML(Object xmlString)
Parses XML string into a DOM document
public Object
pointInElementBounds(Object element, Object pageX, Object pageY)
Returns true if the specified point in page space is in the bounds of this element
public boolean
pointInElementChrome(HTMLElement element, int pageX, int pageY)
Returns true if the point in page coordinates is over element chrome on the specified component
public Object
preventDefault(Object evt)
public Object
removeBubbleEventListener(Object element, Object eventType, Object listener)
Removes an event listener that fired in the non-Capture phases for the specified eventType
private Object
_removeCapturePane(Object nodeId)
Removes the element we use to simulate event capture in IE.
public Object
removeEventBubbles(Object element, Object listener)
Removes event listeners for all of the events that the Rich client framework is interested in from the relevant element using the specified listener
public Object
removeEventCaptures(Node node, Object listener)
Removes event captures for all of the events that the Rich client framework is interested in to the relevant element using the specified listener
public Object
removeIdsFromDomSubTree(HTMLElement subTreeRoot)
Removes all of the ID values from every element in the given DOM sub tree.
public Object
removeKeyEventListener(Object element, Object listener)
Removes the key event capture from the specified element.
public Object
removeSessionStorageProperty(String propKey)
This function removes key/value pair stored in data storage using userData.
public Object
removeStyleProperty(Object element, Object styleProperty)
remove a styleProperty set on this element
private Object
_saveUserDataToStore(Object userDataInstance, Object storageId)
This function saves the object that is participating in userData persistence, into the UserData store.
public Object
setCssFloat(Object element, Object value)
public Object
setCursor(HTMLElement domElement, Object cursor)
Sets the cursor on the specified DOM ELement.
public Object
setImageSource(Object img, Object src)
Sets the image source.
public Object
setOpacity(Object element, Object opacityPercent)
sets opacity of a DOM element
private Object
_setSessionStorageExpiration(Object userDataInstance, Object storageId, Object expirationTime)
This function sets the expiration time (in minutes) for data stored in userData storage.
public Object
setSessionStorageProperty(String propKey, String propValue, Object dataTimeout)
This function stores the key/value pair in the object participating in userData persistence and subsequently saves the object to the UserData store.
public Object
setTableRowHeight(Object row, Object height)
public Object
setTextContent(Object node, Object newText)
Sets the text content of a Node, as per DOM-level 3 spec
public Object
startDocumentKeyEventCapture(Object listenerMap, Object focusProxy)
Use agent-specific techniques for capturing key events for the focusProxy's document.
public Object
startMouseEventCapture(Object listenerMap)
Starts capturing mouse events and installs event listeners.
public Object
stopMouseEventCapture(Object listenerMap)
Stops mouse events capture and removes event listeners.
public Object
stopPropagation(Object evt)


Methods inherited from oracle.adf.view.js.agent.AdfAgent

addResizeListener, atLeast, copyStyle, createDefaultLogWriter, CreateDefaultLogWriter, createTouchMoveManager, disableBrowserContextMenu, eatEvent, eatEventCallback, forceCursorChange, getAgent, getAttribute, getAttributeName, getBoxSizing, getBrowserViewportScrollTop, getComponentEvent, getCSS2Cursor, getCSSLengthAsInt, getDomDocument, getDomForCSSPropertyName, getDomWindow, getElementsByName, getExpandoProperty, getKeyCode, getModifierDisplayName, getOS, getOuterHeight, getOuterWidth, getPlatform, getPreferredKeyEventForRepetition, getTableRow, getTableRows, getVersion, guessOS, guessVersion, InitClass, installKeyboardBlocker, isAttributeSpecified, isClipped, isElementHTML, isEventInElement, isInlineDialogRepositioningOnScroll, isLeftButtonClick, isMouseEvent, mapNativeToComponentEventType, modifyIdsInDomSubTree, pointInElementOrChildBounds, prepareStretchedChild, preventDefaultCallback, removeResizeListener, replaceNode, repositionStretchedElement, resizeStretchedChild, resizeStretchedElement, scrollToPos, setAttribute, setButtonTextContent, setExpandoProperty, setImageTooltip, setOuterHeight, setOuterWidth, showBusyCursor


Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString


Field Detail


_CAPTURE_PANE_STYLE_CLASS

private static Object _CAPTURE_PANE_STYLE_CLASS

_CSS3_TO_IE_MAP

private static Object _CSS3_TO_IE_MAP

Maps the CSS3 cursor name to the nearest CSS2 cursor name

_CSS_TO_DOM_MAP

private static Object _CSS_TO_DOM_MAP

Maps the CSS property name to DOM property name.

Overrides:
AdfAgent._CSS_TO_DOM_MAP

_cursorURLsInited

private Object _cursorURLsInited

_DEFAULT_WINDOW_ID

private static Object _DEFAULT_WINDOW_ID

_EVENT_CAPTURES

private Object _EVENT_CAPTURES

_ID_TO_DOM_MAP

private Object _ID_TO_DOM_MAP

_imageURLs

private Object _imageURLs

_IMG_URL_LOADED

private static Object _IMG_URL_LOADED

_IN_CAPTURE

private static Object _IN_CAPTURE

_REDISTRIBUTE_EVENTS

private static Object _REDISTRIBUTE_EVENTS

Overrides:
AdfAgent._REDISTRIBUTE_EVENTS

_RESIZE_EVENTS

private static Object _RESIZE_EVENTS

Overrides:
AdfAgent._RESIZE_EVENTS

_scrollRecord

private Object _scrollRecord

_SESSION_WINDOW_DATA_TIMEOUT

private static Object _SESSION_WINDOW_DATA_TIMEOUT

_USERDATA_BEHAVIOR

private static Object _USERDATA_BEHAVIOR

_USERDATA_DATA_ELEMENT

private static Object _USERDATA_DATA_ELEMENT

_USERDATA_ID

private static Object _USERDATA_ID

_USERDATA_PROP_KEY

private static Object _USERDATA_PROP_KEY

_USERDATA_PROP_VALUE

private static Object _USERDATA_PROP_VALUE

_USERDATA_ROOT_ELEMENT_ID

private static Object _USERDATA_ROOT_ELEMENT_ID

_USERDATA_SEPARATOR

private static Object _USERDATA_SEPARATOR

_USERDATA_WINDOW_ELEMENT

private static Object _USERDATA_WINDOW_ELEMENT

_USERDATA_WINDOW_ID

private static Object _USERDATA_WINDOW_ID

_userDataStorageInstance

private Object _userDataStorageInstance

Constructor Detail


AdfIEAgent

public AdfIEAgent(Object domWindow)

IE AdfAgent capabilities.

Parameters:
domWindow    

Method Detail


addBubbleEventListener

public Object addBubbleEventListener(Object element,
                                     Object eventType,
                                     Object listener)

Adds an event listener that fires in the non-Capture phases for the specified eventType. There is no ordering guaranteee, nor is there a guarantee regarding the number of times that an event listener will be called if it is added to the same element multiple times.

Parameters:
element    
eventType    
listener    
Return:
Object
Overrides:
AdfAgent.addBubbleEventListener(Object, Object, Object)

_addCapturePane

private Object _addCapturePane(Object nodeId)

Creates and adds the element to use to simulate event capture in IE.

Parameters:
nodeId    
Return:
Object

addEventBubbles

public Object addEventBubbles(Object element,
                              Object listener)

Adds event listeners for all of the events that the Rich client framework is interested in to the relevant element using the specified listener

Parameters:
element    
listener    
Return:
Object
Overrides:
AdfAgent.addEventBubbles(Object, Object)

addEventCaptures

public Object addEventCaptures(Node node,
                               Function listener)

Adds event captures for all of the events that the Rich client framework is interested in to the relevant element using the specified listener

Parameters:
node  -  DOM node to listen on
listener  -  DOM event listener to send captured events to
Return:
Object
Overrides:
AdfAgent.addEventCaptures(Node, Function)

addKeyEventListener

public Object addKeyEventListener(Object element,
                                  Object listener)

Adds key event listener to the specified element. Listen to "keydown" event in IE.

Parameters:
element    
listener    
Return:
Object
Overrides:
AdfAgent.addKeyEventListener(Object, Object)

addOption

public Object addOption(Object element,
                        Object label,
                        Object value,
                        Object selected,
                        Object disabled,
                        Object description,
                        Object index)

IE doesn't support disabled options natively TODO - investigate showing a "disabled" option in ie - some fancy javascript could probably make it work

Parameters:
element    
label    
value    
selected    
disabled    
description    
index    
Return:
Object
Overrides:
AdfAgent.addOption(Object, Object, Object, Object, Object, Object, Object)

allElementsRemoved

public Object allElementsRemoved()

Resets any id->element cache when all elements are removed This method should be called AFTER the elements are removed

Return:
Object
See also:
getElementById(Object)
elementsAdded(Object)
Overrides:
AdfAgent.allElementsRemoved()

autoCompleteForm

public Object autoCompleteForm(Object htmlForm)

Parameters:
htmlForm    
Return:
Object
Overrides:
AdfAgent.autoCompleteForm(Object)

_captureListener

private Object _captureListener(Event domEvent)

Listener for redistributing captured events. If the event originated inside the captured node, send it to the capture listener, otherwise redispatch the event to its original target

Parameters:
domEvent  -  captured DOM Event
Return:
Object

_captureListenerStub

private static Object _captureListenerStub()

Stub for distributing events to the AdfIEAgent instance

Return:
Object

checkMouseOutEvent

public Object checkMouseOutEvent(Object element,
                                 Object evt)

Checks wthether a mouseout event was received by the container when mouse was moved form one of its child elements to another

Parameters:
element    
evt    
Return:
Object
Overrides:
AdfAgent.checkMouseOutEvent(Object, Object)

clearSubtreeIds

public Object clearSubtreeIds(Object element)

Clear id of the specified element and its children. This is called on cloned node for dragging so that the new node won't conflict with the original Node. For IE, we will use browser generated uniqueID property as the new id for the new element if it is available, otherwise, we'll just eliminate the id.

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.clearSubtreeIds(Object)

cloneEvent

public Object cloneEvent(Object event,
                         Object newTarget)

Returns a new Event Object, based on a current event, retargetted to the new target. If no newTarget is specified, the event will be cloned with the current target.

Parameters:
event  -  Event to base the new event on
newTarget  -  Optional DOM Node to retarget the event to
Return:
Object
Overrides:
AdfAgent.cloneEvent(Event, HTMLElement)

cloneNode

public Node cloneNode(Node domNode)

Clones a DOM node with special handling for IE7.

Parameters:
domNode  -  the DOM ndoe to clone the new node from
Return:
Node - the cloned DOM node.
Overrides:
AdfAgent.cloneNode(Node)

_computeScrollDelta

private static Object _computeScrollDelta(Object scrollRecord,
                                          Object viewPortSize,
                                          Object canvasSize,
                                          Object dragDelta)

Parameters:
scrollRecord  -  Information about scrolling
viewPortSize  -  size of scrollable viewport
canvasSize  -  size of scrollable canvas
dragDelta  -  # pixels the mouse is dragged from initial mouse down
Return:
Object - null # pixels to adjust original scroll position by

copyEvent

public Event copyEvent(Event event)

Copies an event from an existing event.

Parameters:
event  -  the event to clone the new event from
Return:
Event - the newly copied event
Overrides:
AdfAgent.copyEvent(Event)

CreateNativeLogWriter

protected Object CreateNativeLogWriter()

Creates and returns the native AdfLogWriter to use for this AdfAgent

Return:
Object
Overrides:
AdfAgent.CreateNativeLogWriter()

createStyle

public DOMElement createStyle(String content)

Inserts a new style block into the document using the specified style content.

Parameters:
content  -  the CSS text to be used inside of the newly created style element.
Return:
DOMElement - the newly-created style element
Overrides:
AdfAgent.createStyle(String)

CreateUIInputEvent

protected Object CreateUIInputEvent(Object component,
                                    Object type,
                                    Object nativeEvent)

Parameters:
component    
type    
nativeEvent    
Return:
Object
Overrides:
AdfAgent.CreateUIInputEvent(Object, Object, Object)

_createUserDataChildNode

private Object _createUserDataChildNode(Object objXmlDoc,
                                        String nodeName,
                                        String nodeIdName,
                                        String nodeIdVal)

This function creates a node element using passed xmlDocument with the given node element name and then set the node id as nodeIdName and value as nodeIdVal

Parameters:
objXmlDoc  -  xmlDocument associated with the userData element
nodeName  -  name of the node to be created
nodeIdName  -  name of the node id
nodeIdVal  -  value of the node id.
Return:
Object - created child node

createXmlDocument

public Object createXmlDocument()

Return:
Object
Overrides:
AdfAgent.createXmlDocument()

_deliverEventToEventCaptures

private Object _deliverEventToEventCaptures(Object eventCaptures,
                                            Object capturedEvent)

Delivers the specified event to all of the event capture listeners

Parameters:
eventCaptures    
capturedEvent    
Return:
Object

disableUserSelect

public Object disableUserSelect(Object element)

Disable the user's ability to select text in this component

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.disableUserSelect(Object)

dispatchEvent

public Object dispatchEvent(Object targetElement,
                            Object event)

Dispatches the specified event to the target, returning whether the dispatch was successful

Parameters:
targetElement    
event    
Return:
Object
Overrides:
AdfAgent.dispatchEvent(Object, Object)

_doNothing

private static Object _doNothing()

Return:
Object

elementFromPagePoint

public Object elementFromPagePoint(Object pageX,
                                   Object pageY,
                                   Object hintElement,
                                   Object exclusionContext,
                                   Object exclusionCallback)

Returns the topmost element at the give mouse point in Window coordinates. By default, all elements are included in the search for the topmost element. In some cases, for example, when a "glass pane" is used, the caller may need to exclude certain components (eg. the "glass pane" from the search. To accomplish this, an optional "exclusion filter" function may be specified. This exclusion filter is a function which is called for each element in the search. If the exclusion filter returns true, the element and its descendents are excluded from the search.

Please keep in mind that this method is inefficient when the there is no native implementation by the browser. This is because the method iterates the entire document depth first to find the element at a particular point


Parameters:
pageX    
pageY    
hintElement    
exclusionContext    
exclusionCallback    
Return:
Object
Overrides:
AdfAgent.elementFromPagePoint(Number, Object, HTMLElement, Object, Object)

elementsAdded

public Object elementsAdded(Object node)

Updates any id->element cache by adding the elements in the specified subtree

Parameters:
node  -  Either element or document node that is being added
Return:
Object
See also:
getElementById(Object)
elementsRemoved(Object)
Overrides:
AdfAgent.elementsAdded(Object)

elementsRemoved

public Object elementsRemoved(Object node)

Updates any id->element cache by removing the elements in the specified subtree.

Parameters:
node  -  Either element or document node that is being removed
Return:
Object
See also:
getElementById(Object)
elementsAdded(Object)
Overrides:
AdfAgent.elementsRemoved(Object)

enableUserSelect

public Object enableUserSelect(Object element)

Enable the user's ability to select text in this component

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.enableUserSelect(Object)

endDocumentKeyEventCapture

public Object endDocumentKeyEventCapture(Object listenerMap,
                                         Object focusProxy,
                                         Object focusState)

Remove agent-specific techniques for capturing key events for the focusProxy's document

Parameters:
listenerMap  -  JS Object map of event name to event listener
focusProxy  -  Component to stop getting key events for
focusState  -  State object returned by startDocumentKeyEventCapture
Return:
Object
Overrides:
AdfAgent.endDocumentKeyEventCapture(Object, Object)

execScript

public Object execScript(Object ownerWindow,
                         Object scriptText)

Executes a script.

Parameters:
ownerWindow  -  the DOM Window
scriptText  -  the script text
Return:
Object
Overrides:
AdfAgent.execScript(Object, Object)

_getAttribute

private Object _getAttribute(Object node,
                             Object attrName)

Parameters:
node    
attrName    
Return:
Object

_getBlockingDiv

private Object _getBlockingDiv()

Conveenience function for getting the glasspane DIV used with inline editing

Return:
Object

getBooleanAttribute

public Object getBooleanAttribute(Object element,
                                  Object attrName,
                                  Object defaultValue)

Returns the value of a boolean attribute.

Parameters:
element    
attrName    
defaultValue    
Return:
Object
Overrides:
AdfAgent.getBooleanAttribute(Object, Object, Object)

getBrowserViewportScrollLeft

public Number getBrowserViewportScrollLeft()

Return:
Number - returns the starting position on the canvas of the viewport
Overrides:
AdfAgent.getBrowserViewportScrollLeft()

_getCapturePaneId

private String _getCapturePaneId(Object nodeId)

Returns the id of the capture pane for the node with the specified id.

Parameters:
nodeId    
Return:
String - id of the capture pane for the specified node

getComputedStyle

public Object getComputedStyle(Object element)

Tries to return the current style, taking into account the inline styles and style sheets

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.getComputedStyle(Object)

GetCssToDomPropertyNameMap

protected Object GetCssToDomPropertyNameMap()

Returns the map which contains the CSS property name and it's DOM version.

Return:
Object
Overrides:
AdfAgent.GetCssToDomPropertyNameMap()

getCursor

public Object getCursor(Object cursorName)

Returns the CSS cursor property value to return for a CSS3 cursor name

Parameters:
cursorName    
Return:
Object
Overrides:
AdfAgent.getCursor(Object)

getDescendantComponentsForNode

public Array<AdfUIComponent> getDescendantComponentsForNode(Node node,
                                                            Array<AdfUIComponent> children)

Get components descended from a node. Children are returned in an array.

There is no guarantee about the order of the children returned. If visiting the children in a known order is required please use AdfUIComponent.visitChildren.

All descendent children are returned, visible or not. If ignoring hidden children is required please use AdfUIComponent.visitChildren.

This method is faster than AdfUIComponent.visitChildren, if the limitations above are acceptable it is preferable to use this method.


Parameters:
node  -  DOM node where to start searching
children  -  array to store child components in. Descendent components will be added to the end of the array. This param is optional, if not passed in an array will be created.
Return:
Array<AdfUIComponent> - array of descendent components, may be empty
Overrides:
AdfAgent.getDescendantComponentsForNode(Node, Array<AdfUIComponent>)

getElementById

public Object getElementById(Object id)

Cover function to allow more performant implementations of document.getElementById()

Parameters:
id    
Return:
Object
See also:
elementsRemoved(Object)
elementsAdded(Object)
Overrides:
AdfAgent.getElementById(Object)

getElementLeft

public Object getElementLeft(Object element)

Returns the element's left side in Window coordinates. This reproduce the code from the getElementPosition method.

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.getElementLeft(Object)

getElementPageBounds

public Object getElementPageBounds(HTMLElement domElement)

Return a rectangle object containing the page bounds of an element in top/left/bottom/right form

Parameters:
domElement    
Return:
Object - object with members "top", "left", "bottom", and "right"
Overrides:
AdfAgent.getElementPageBounds(Object)

getElementPosition

public Object getElementPosition(Object element)

Returns HTML element's coordinates relative to the document's body

Parameters:
element  -  HTML element
Return:
Object - an object with two properties (x for the left coordinate and y for the top coordinate)
Overrides:
AdfAgent.getElementPosition(Object)

getElementTop

public Object getElementTop(Object element)

Returns the element's top side in Window coordinates. This reproduce the code from the getElementPosition method.

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.getElementTop(Object)

getEventFromElement

public Object getEventFromElement(Object nativeEvent)

Some events, like the mouseover event, can tell you the dom node being moved from.

Parameters:
nativeEvent    
Return:
Object
Overrides:
AdfAgent.getEventFromElement(Object)

getEventTarget

public Object getEventTarget(Object event)

Parameters:
event    
Return:
Object
Overrides:
AdfAgent.getEventTarget(Object)

getEventToElement

public Object getEventToElement(Object nativeEvent)

Some events, like the mouseout event, can tell you the dom node being moved to.

Parameters:
nativeEvent    
Return:
Object
Overrides:
AdfAgent.getEventToElement(Object)

getFormElement

public Object getFormElement(Object form,
                             Object elementName)

Finds the form element by name.

Parameters:
form    
elementName    
Return:
Object
Overrides:
AdfAgent.getFormElement(Object, Object)

getIntAttribute

public Object getIntAttribute(Object element,
                              Object attrName,
                              Object defaultValue)

Returns the value of a number attribute.

Parameters:
element    
attrName    
defaultValue    
Return:
Object
Overrides:
AdfAgent.getIntAttribute(Object, Object, Object)

getLocalName

public Object getLocalName(Object element)

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.getLocalName(Object)

getMousePosition

public Object getMousePosition(Object evt)

Returns event's mouse coordinates relative to the document

Parameters:
evt    
Return:
Object
Overrides:
AdfAgent.getMousePosition(Object)

getNodeName

public Object getNodeName(Object node)

This method returns the name of the node in all upper case letters.

Parameters:
node    
Return:
Object
Overrides:
AdfAgent.getNodeName(HTMLElement)

getNodeXml

public Object getNodeXml(Object node)

Parameters:
node    
Return:
Object
Overrides:
AdfAgent.getNodeXml(Object)

getOverrideStyle

public Object getOverrideStyle(Object element)

Returns the override style for this element

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.getOverrideStyle(Object)

getPrefix

public Object getPrefix(Object element)

Parameters:
element    
Return:
Object
Overrides:
AdfAgent.getPrefix(Object)

GetResizeEvents

protected Array GetResizeEvents()

An array of event types used by the addResizeListener and removeResizeListener functions. The IE agent overrides using the resize event as the trigger versus dom mutation events.

Return:
Array - array of event types needed for the resize listener registration
See also:
AdfAgent.addResizeListener(String, Function)
AdfAgent.removeResizeListener(String)
Overrides:
AdfAgent.GetResizeEvents()

getSessionStorageProperty

public String getSessionStorageProperty(String propKey,
                                        Number dataTimeout)

This function returns the value for a given key stored in data storage using userData. Enables the object to persist data in user data. This is based on userData behavior mechanism, a means through which string key/value pairs can be securely stored and later retrieved for use. Uses AdfIEAgent._userDataSessionToken, holds session token which is generated at server and send down to the client.

Parameters:
propKey  -  this key will be used to get the value in storage
dataTimeout  -  data time out time in minutes
Return:
String - value of the property stored with key propKey
Throws:
Error if session storage is not supported
See also:
isSessionStorageEnabled()
Overrides:
AdfAgent.getSessionStorageProperty(String)

getStyleProperty

public Object getStyleProperty(Object style,
                               Object propertyName)

Returns the value of a property for the AdfAgent's style object

Parameters:
style    
propertyName    
Return:
Object
Overrides:
AdfAgent.getStyleProperty(Object, Object)

getTableRowCells

public Object getTableRowCells(Object tableRow)

At least on IE8 running in IE7 mode, the .cells collection for unconnected tables is empty. Grr.

Parameters:
tableRow    
Return:
Object
Overrides:
AdfAgent.getTableRowCells(Object)

getTextContent

public Object getTextContent(Object node)

Returns the text content of a Node, as per DOM-level 3 spec

Parameters:
node    
Return:
Object
Overrides:
AdfAgent.getTextContent(Object)

_getUserDataChildNode

private Object _getUserDataChildNode(Array children,
                                     String childName,
                                     String childVal)

This function returns the child node if it is found in the children array else returns null.

Parameters:
children  -  a collection of child Nodes
childName  -  name of the child
childVal  -  value of the child.
Return:
Object - returns existing child node or null if not found

_getUserDataStorageDataNode

private Object _getUserDataStorageDataNode(Object objXMLDoc,
                                           String propKey)

Returns the data node for existing propkey in given storage node.

Parameters:
objXMLDoc  -  xmlDocument associated with the userData element
propKey  -  this key will be used to store the key/value in storage
Return:
Object - returns data node

_getUserDataStorageId

private String _getUserDataStorageId()

This function retruns the userData storage id. This id will be concatenation of session token and window id using separator as '|'. storageId = '<sessionToken>|<windowId>'

Return:
String - a String to use as root element storage id.

getWindowClientHeight

public Number getWindowClientHeight(Window domWindow)

Returns the client (or inner) height of the DOM window Object

Parameters:
domWindow    
Return:
Number - null
Overrides:
AdfAgent.getWindowClientHeight(Window)

getWindowClientWidth

public Number getWindowClientWidth(Window domWindow)

Returns the client (or inner) width of the DOM window Object

Parameters:
domWindow    
Return:
Number - null
Overrides:
AdfAgent.getWindowClientWidth(Window)

getWindowHeight

public Object getWindowHeight()

Returns the content height of the browser window

Return:
Object
Overrides:
AdfAgent.getWindowHeight()

getWindowScrollHeight

public Number getWindowScrollHeight(Window domWindow)

Returns the scroll (or canvas) height of the DOM window Object

Parameters:
domWindow    
Return:
Number - null
Overrides:
AdfAgent.getWindowScrollHeight(Window)

getWindowScrollWidth

public Number getWindowScrollWidth(Window domWindow)

Returns the scroll (or canvas) width of the DOM window Object

Parameters:
domWindow    
Return:
Number - null
Overrides:
AdfAgent.getWindowScrollWidth(Window)

getWindowWidth

public Object getWindowWidth()

Returns the content width of the browser window

Return:
Object
Overrides:
AdfAgent.getWindowWidth()

_handleInlineEditingClick

private Object _handleInlineEditingClick(Object domEvent)

Handles clicks on the scrollbars during inline editing

Parameters:
domEvent    
Return:
Object

_handleInlineEditingMouseDown

private Object _handleInlineEditingMouseDown(Object domEvent)

Handles a mouse down during inline editing. If the mouse down was on a scrollbar, this function initializes the fake scrolling code and kicks it into action

Parameters:
domEvent    
Return:
Object

_handleInlineEditingMouseMove

private Object _handleInlineEditingMouseMove(Object domEvent)

Handles fake scrollbar thumb drags during inline editing

Parameters:
domEvent    
Return:
Object

_handleInlineEditingMouseUp

private Object _handleInlineEditingMouseUp(Object domEvent)

Clean up the fake scrolling when the moouse comes up

Parameters:
domEvent    
Return:
Object

_handleScrollInterval

private static Object _handleScrollInterval()

Callback from in inline editing scrollbar timers

Return:
Object

_imageReadyCallback

private static Object _imageReadyCallback()

Actually updates the images used once they have finished loading

Return:
Object

Init

protected Object Init(Object domWindow)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:
domWindow    
Return:
Object
Overrides:
AdfObject.Init()

_isCapturePane

private static Boolean _isCapturePane(HTMLElement element)

Tests whether the specified element is a capture pane.

Parameters:
element  -  The element to test.
Return:
Boolean - true if the element is a capture pane, false otherwise.

isChromeEvent

public boolean isChromeEvent(Event domEvent)

Returns true if the event was on the element chrome

Parameters:
domEvent  -  The DOM event to check the original target of
Return:
boolean - null true if the event was on the element chrome
Overrides:
AdfAgent.isChromeEvent(Event)

isDisabledOptionSupported

public Object isDisabledOptionSupported()

Returns whether or not disabled is supported on an option tag

Return:
Object
Overrides:
AdfAgent.isDisabledOptionSupported()

isEqualIcon

public Object isEqualIcon(Object firstIcon,
                          Object secondIcon)

IE's img icons innerHTML can be different. One can have the src be the complete url, another can be a relative url. This will return whether or not the icons contents are essentially equal for icon swapping purposes.

Parameters:
firstIcon    
secondIcon    
Return:
Object
Overrides:
AdfAgent.isEqualIcon(Object, Object)

isFunctionKey

public Object isFunctionKey(Object keyEvent)

Returns whether the event's keycode should be considered as a function key.

Parameters:
keyEvent    
Return:
Object
Overrides:
AdfAgent.isFunctionKey(Object)

isLeftButton

public Object isLeftButton(Object evt)

Parameters:
evt    
Return:
Object
Overrides:
AdfAgent.isLeftButton(Object)

isSessionStorageEnabled

public Boolean isSessionStorageEnabled()

This function returns true if userData persistence is enabled; false otherwise.

Return:
Boolean - false if userData persistence is disabled or if accessing to userData store is denied for security reasons.
Overrides:
AdfAgent.isSessionStorageEnabled(Object)

_loadUserDataFromStore

private Object _loadUserDataFromStore()

This function reads information from the UserData store and loads it onto the object participating in the userData persistence.

Return:
Object - the userData instance whose information was successfully loaded from the UserData store.
Throws:
Error loading from UserData store fails.

parseXML

public Object parseXML(Object xmlString)

Parses XML string into a DOM document

Parameters:
xmlString  -  string XML representation
Return:
Object - XML document if parsed successfully, null otherwise
Overrides:
AdfAgent.parseXML(Object)

pointInElementBounds

public Object pointInElementBounds(Object element,
                                   Object pageX,
                                   Object pageY)

Returns true if the specified point in page space is in the bounds of this element

Parameters:
element    
pageX    
pageY    
Return:
Object
Overrides:
AdfAgent.pointInElementBounds(Object, Object, Object)

pointInElementChrome

public boolean pointInElementChrome(HTMLElement element,
                                    int pageX,
                                    int pageY)

Returns true if the point in page coordinates is over element chrome on the specified component

Parameters:
element  -  The DOM event to check the original target of
pageX  -  X coordinate to check in page coordinates
pageY  -  Y coordinate to check in page coordinates
Return:
boolean - null true if the event was on the element chrome
Overrides:
AdfAgent.pointInElementChrome(HTMLElement, int, int)

preventDefault

public Object preventDefault(Object evt)

Parameters:
evt    
Return:
Object
Overrides:
AdfAgent.preventDefault(Object)

removeBubbleEventListener

public Object removeBubbleEventListener(Object element,
                                        Object eventType,
                                        Object listener)

Removes an event listener that fired in the non-Capture phases for the specified eventType

Parameters:
element    
eventType    
listener    
Return:
Object
Overrides:
AdfAgent.removeBubbleEventListener(Object, Object, Object)

_removeCapturePane

private Object _removeCapturePane(Object nodeId)

Removes the element we use to simulate event capture in IE.

Parameters:
nodeId    
Return:
Object

removeEventBubbles

public Object removeEventBubbles(Object element,
                                 Object listener)

Removes event listeners for all of the events that the Rich client framework is interested in from the relevant element using the specified listener

Parameters:
element    
listener    
Return:
Object
Overrides:
AdfAgent.removeEventBubbles(Object, Object)

removeEventCaptures

public Object removeEventCaptures(Node node,
                                  Object listener)

Removes event captures for all of the events that the Rich client framework is interested in to the relevant element using the specified listener

Parameters:
node  -  DOM node to remove event captures from
listener    
Return:
Object
Overrides:
AdfAgent.removeEventCaptures(Node, Object)

removeIdsFromDomSubTree

public Object removeIdsFromDomSubTree(HTMLElement subTreeRoot)

Removes all of the ID values from every element in the given DOM sub tree.

Parameters:
subTreeRoot  -  the root of the sub tree to remove IDs from
Return:
Object
Overrides:
AdfAgent.removeIdsFromDomSubTree(HTMLElement)

removeKeyEventListener

public Object removeKeyEventListener(Object element,
                                     Object listener)

Removes the key event capture from the specified element.

Parameters:
element    
listener    
Return:
Object
Overrides:
AdfAgent.removeKeyEventListener(Object, Object)

removeSessionStorageProperty

public Object removeSessionStorageProperty(String propKey)

This function removes key/value pair stored in data storage using userData. Enables the object to persist data in user data. This is based on userData behavior mechanism, a means through which string key/value pairs can be securely stored and later retrieved for use. Uses AdfIEAgent._userDataSessionToken, holds session token which is generated at server and send down to the client.

Parameters:
propKey  -  this key will be used to remove the key/value from storage
Return:
Object
Throws:
Error if session storage is not supported or if writing to the session storage fails
See also:
isSessionStorageEnabled()
Overrides:
AdfAgent.removeSessionStorageProperty(String)

removeStyleProperty

public Object removeStyleProperty(Object element,
                                  Object styleProperty)

remove a styleProperty set on this element

Parameters:
element    
styleProperty    
Return:
Object
Overrides:
AdfAgent.removeStyleProperty(Object, Object)

_saveUserDataToStore

private Object _saveUserDataToStore(Object userDataInstance,
                                    Object storageId)

This function saves the object that is participating in userData persistence, into the UserData store.

Parameters:
userDataInstance    
storageId    
Return:
Object
Throws:
Error when saving to UserData store fails.

setCssFloat

public Object setCssFloat(Object element,
                          Object value)

Parameters:
element    
value    
Return:
Object
Overrides:
AdfAgent.setCssFloat(Object, Object)

setCursor

public Object setCursor(HTMLElement domElement,
                        Object cursor)

Sets the cursor on the specified DOM ELement. This is necessary in order to get the cursor to change correctly during mouse capture on IE.

Parameters:
domElement    
cursor    
Return:
Object
Overrides:
AdfAgent.setCursor(HTMLElement, Object)

setImageSource

public Object setImageSource(Object img,
                             Object src)

Sets the image source.

Parameters:
img    
src    
Return:
Object
Overrides:
AdfAgent.setImageSource(Object, Object)

setOpacity

public Object setOpacity(Object element,
                         Object opacityPercent)

sets opacity of a DOM element

Parameters:
element    
opacityPercent    
Return:
Object
Overrides:
AdfAgent.setOpacity(Object, Object)

_setSessionStorageExpiration

private Object _setSessionStorageExpiration(Object userDataInstance,
                                            Object storageId,
                                            Object expirationTime)

This function sets the expiration time (in minutes) for data stored in userData storage. This ensures proper cleanup of stale data (for current or new sessions). It sets the expiration interval ahead of the current time by supplied expirationTime in mins or expiration interval is set to "AdfIEAgent._SESSION_WINDOW_DATA_TIMEOUT" if expirationTime is not provided.

Parameters:
userDataInstance    
storageId    
expirationTime    
Return:
Object

setSessionStorageProperty

public Object setSessionStorageProperty(String propKey,
                                        String propValue,
                                        Object dataTimeout)

This function stores the key/value pair in the object participating in userData persistence and subsequently saves the object to the UserData store. This is based on userData behavior mechanism, a means through which string key/value pairs can be securely stored and later retrieved for use. Uses AdfIEAgent._userDataSessionToken, that holds session token generated at server and sent down to the client.

Parameters:
propKey  -  this key will be used to store the key/value in storage.
propValue  -  value to be stored.
dataTimeout    
Return:
Object
Throws:
Error if session storage is not supported or if writing to the session storage fails
See also:
isSessionStorageEnabled()
Overrides:
AdfAgent.setSessionStorageProperty(String, String)

setTableRowHeight

public Object setTableRowHeight(Object row,
                                Object height)

Parameters:
row    
height    
Return:
Object
Overrides:
AdfAgent.setTableRowHeight(Object, Object)

setTextContent

public Object setTextContent(Object node,
                             Object newText)

Sets the text content of a Node, as per DOM-level 3 spec

Parameters:
node    
newText    
Return:
Object
Overrides:
AdfAgent.setTextContent(Object, Object)

startDocumentKeyEventCapture

public Object startDocumentKeyEventCapture(Object listenerMap,
                                           Object focusProxy)

Use agent-specific techniques for capturing key events for the focusProxy's document.

Parameters:
listenerMap  -  JS Object map of event name to event listener
focusProxy  -  Component to get key events for
Return:
Object - State object that should be passed to endDocumentKeyEventCapture
Overrides:
AdfAgent.startDocumentKeyEventCapture(Object, Object)

startMouseEventCapture

public Object startMouseEventCapture(Object listenerMap)

Starts capturing mouse events and installs event listeners. Listeners are provided in a map, as in {mouseup:func1, mousemove:func2}

Parameters:
listenerMap    
Return:
Object
Overrides:
AdfAgent.startMouseEventCapture(Object)

stopMouseEventCapture

public Object stopMouseEventCapture(Object listenerMap)

Stops mouse events capture and removes event listeners. Listeners are provided in a map, as in {mouseup:func1, mousemove:func2}

Parameters:
listenerMap    
Return:
Object
Overrides:
AdfAgent.stopMouseEventCapture(Object)

stopPropagation

public Object stopPropagation(Object evt)

Parameters:
evt    
Return:
Object
Overrides:
AdfAgent.stopPropagation(Object)

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

 

Generated on 2010.12.10 19:37 UTC
Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.