JavaScript API Reference for Oracle ADF Faces

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

oracle.adfinternal.view.js.agent.safari
Class AdfSafariAgent

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.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.agent.AdfAgent
               |
               +--oracle.adfinternal.view.js.agent.safari.AdfSafariAgent

Direct Known Subclasses:

AdfSafariMobileAgent

public class AdfSafariAgent
extends AdfAgent

SafariAdfAgent AdfAgent capabilities.

Field Summary

private static Object	_MODIFIER_DISPLAY_NAMES
private static Object	_REDISTRIBUTE_BUBBLE_EVENTS
private static Object	_REDISTRIBUTE_CAPTURE_EVENTS

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

AdfSafariAgent(Object version, Object domWindow) SafariAdfAgent AdfAgent capabilities.

Method Summary

public Object	addEventBubbles(Object node, Object listener) Override to add focus and blur as capture events.
private Object	_addEventListeners(Node node, Array<String> eventTypes, Function listener, Boolean capture) Add the listener to the Element or Document for all of the specified eventTypes using the specified capture strategy.
protected Object	CreateDefaultLogWriter(Object nativeLogWriter) Creates and returns the default AdfLogWriter to use for this AdfPage.
protected Object	CreateUIInputEvent(Object component, Object type, Object nativeEvent)
public Object	disableUserSelect(Object element) Disable the user's ability to select text in this component
public Object	enableUserSelect(Object element) Enable the user's ability to select text in this component
public Object	execScript(Window ownerWindow, String scriptText) Executes a script.
public String	getBoxSizing(HTMLElement element, CSSStyleDeclaration currentStyle) Returns the box model associated with an element (http://www.w3.org/TR/css3-ui/#box-sizing)
public Number	getBrowserViewportScrollLeft()
public Number	getBrowserViewportScrollTop()
public Array<AdfUIComponent>	getDescendantComponentsForNode(Node node, Array<AdfUIComponent> children) Get components descended from a node.
public Object	getModifierDisplayName(Object modifier) Returns the appropriate platform-specific translated display name for a AdfKeyStroke modifier.
public String	getSessionStorageProperty(String propKey) This function returns the value for a given key stored in sessionStorage.
public Object	getWindowScrollHeight(Object 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
protected Object	Init(Object version, Object domWindow) Initializes the instance.
protected Object	InitClass()
public Object	removeEventBubbles(Object node, Object listener) Removes event bubbles for all of the events that the Rich client framework is interested in from the relevant element using the specified listener.
private Object	_removeEventListeners(Node node, Array<String> eventTypes, Function listener, Boolean capture) Remove the listener from the Element or Document for all of the specified eventTypes using the specified capture strategy.
public Object	removeSessionStorageProperty(String propKey) This function removes the key/value pair stored in sessionStorage.
public Object	setSessionStorageProperty(String propKey, String propValue) This function stores the key/value pair in sessionStorage.

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

addBubbleEventListener, addEventCaptures, addKeyEventListener, addOption, addResizeListener, allElementsRemoved, atLeast, autoCompleteForm, checkMouseOutEvent, clearSubtreeIds, cloneEvent, cloneNode, copyEvent, copyStyle, createDefaultLogWriter, CreateNativeLogWriter, createStyle, createTouchMoveManager, createXmlDocument, disableBrowserContextMenu, dispatchEvent, eatEvent, eatEventCallback, elementFromPagePoint, elementsAdded, elementsRemoved, endDocumentKeyEventCapture, forceCursorChange, getAgent, getAttribute, getAttributeName, getBooleanAttribute, getComponentEvent, getComputedStyle, getCSS2Cursor, getCSSLengthAsInt, GetCssToDomPropertyNameMap, getCursor, getDomDocument, getDomForCSSPropertyName, getDomWindow, getElementById, getElementLeft, getElementPageBounds, getElementPosition, getElementsByName, getElementTop, getEventFromElement, getEventTarget, getEventToElement, getExpandoProperty, getFormElement, getIntAttribute, getKeyCode, getLocalName, getMousePosition, getNodeName, getNodeXml, getOS, getOuterHeight, getOuterWidth, getOverrideStyle, getPlatform, getPreferredKeyEventForRepetition, getPrefix, GetResizeEvents, getStyleProperty, getTableRow, getTableRowCells, getTableRows, getTextContent, getVersion, getWindowClientHeight, getWindowClientWidth, getWindowHeight, getWindowWidth, guessOS, guessVersion, installKeyboardBlocker, isAttributeSpecified, isChromeEvent, isClipped, isDisabledOptionSupported, isElementHTML, isEqualIcon, isEventInElement, isFunctionKey, isInlineDialogRepositioningOnScroll, isLeftButton, isLeftButtonClick, isMouseEvent, isSessionStorageEnabled, mapNativeToComponentEventType, modifyIdsInDomSubTree, parseXML, pointInElementBounds, pointInElementChrome, pointInElementOrChildBounds, prepareStretchedChild, preventDefault, preventDefaultCallback, removeBubbleEventListener, removeEventCaptures, removeIdsFromDomSubTree, removeKeyEventListener, removeResizeListener, removeStyleProperty, replaceNode, repositionStretchedElement, resizeStretchedChild, resizeStretchedElement, scrollToPos, setAttribute, setButtonTextContent, setCssFloat, setCursor, setExpandoProperty, setImageSource, setImageTooltip, setOpacity, setOuterHeight, setOuterWidth, setTableRowHeight, setTextContent, showBusyCursor, startDocumentKeyEventCapture, startMouseEventCapture, stopMouseEventCapture, stopPropagation

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

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

Field Detail

_MODIFIER_DISPLAY_NAMES

private static Object _MODIFIER_DISPLAY_NAMES

Overrides:

AdfAgent._MODIFIER_DISPLAY_NAMES

_REDISTRIBUTE_BUBBLE_EVENTS

private static Object _REDISTRIBUTE_BUBBLE_EVENTS

_REDISTRIBUTE_CAPTURE_EVENTS

private static Object _REDISTRIBUTE_CAPTURE_EVENTS

Constructor Detail

AdfSafariAgent

public AdfSafariAgent(Object version,
Object domWindow)

SafariAdfAgent AdfAgent capabilities.

Parameters:

version
domWindow

Method Detail

addEventBubbles

public Object addEventBubbles(Object node,
Object listener)

Override to add focus and blur as capture events.

Parameters:

node
listener

Return:

Object

Overrides:

AdfAgent.addEventBubbles(Object, Object)

_addEventListeners

private Object _addEventListeners(Node node,
Array<String> eventTypes,
Function listener,
Boolean capture)

Add the listener to the Element or Document for all of the specified eventTypes using the specified capture strategy.

Parameters:

node	-	Element or Document to add listener to
eventTypes	-	Array of DOM event types to register listener for
listener	-	Event listener to register on node
capture	-	true to add the listener using event capture

Return:

Object

CreateDefaultLogWriter

protected Object CreateDefaultLogWriter(Object nativeLogWriter)

Creates and returns the default AdfLogWriter to use for this AdfPage. Subclassers should override CreateDefaultLogWriter instead

Parameters:

nativeLogWriter

Return:

Object

Overrides:

AdfAgent.createDefaultLogWriter()

CreateUIInputEvent

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

Parameters:

component
type
nativeEvent

Return:

Object

Overrides:

AdfAgent.CreateUIInputEvent(Object, Object, 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)

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)

execScript

public Object execScript(Window ownerWindow,
String scriptText)

Executes a script.

Parameters:

ownerWindow	-	the DOM Window
scriptText	-	the script text

Return:

Object

Overrides:

AdfAgent.execScript(Object, Object)

getBoxSizing

public String getBoxSizing(HTMLElement element,
CSSStyleDeclaration currentStyle)

Returns the box model associated with an element (http://www.w3.org/TR/css3-ui/#box-sizing)

Parameters:

element	-	The element to check
currentStyle	-	the current style that can be optionally passed in Default value = null

Return:

String - the box sizing, either "content-box" or "border-box"

Overrides:

AdfAgent.getBoxSizing(HTMLElement, CSSStyleDeclaration)

getBrowserViewportScrollLeft

public Number getBrowserViewportScrollLeft()

Return:

Number - returns the starting position on the canvas of the viewport

Overrides:

AdfAgent.getBrowserViewportScrollLeft()

getBrowserViewportScrollTop

public Number getBrowserViewportScrollTop()

Return:

Number - returns the top position on the canvas the viewport begins

Overrides:

AdfAgent.getBrowserViewportScrollTop()

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>)

getModifierDisplayName

public Object getModifierDisplayName(Object modifier)

Returns the appropriate platform-specific translated display name for a AdfKeyStroke modifier.

Parameters:

modifier

Return:

Object

Overrides:

AdfAgent.getModifierDisplayName(Object)

getSessionStorageProperty

public String getSessionStorageProperty(String propKey)

This function returns the value for a given key stored in sessionStorage. sessionStorage is an instance to save information in client session. This is based on DOM Storage mechanism, a means through which string key/value pairs can be securely stored and later retrieved for use.

Parameters:

propKey

-

key used to retrieve the value in storage

Return:

String - value of the property stored with key propKey

Overrides:

AdfAgent.getSessionStorageProperty(String)

getWindowScrollHeight

public Object getWindowScrollHeight(Object domWindow)

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

Parameters:

domWindow

Return:

Object

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)

Init

protected Object Init(Object version,
Object domWindow)

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

Parameters:

version
domWindow

Return:

Object

Overrides:

AdfObject.Init()

InitClass

protected Object InitClass()

Return:

Object

Overrides:

AdfAgent.InitClass()

removeEventBubbles

public Object removeEventBubbles(Object node,
Object listener)

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

Parameters:

node
listener

Return:

Object

Overrides:

AdfAgent.removeEventBubbles(Object, Object)

_removeEventListeners

private Object _removeEventListeners(Node node,
Array<String> eventTypes,
Function listener,
Boolean capture)

Remove the listener from the Element or Document for all of the specified eventTypes using the specified capture strategy.

Parameters:

node	-	Element or Document to add listener to
eventTypes	-	Array of DOM event types to register listener for
listener	-	Event listener to deregister on element
capture	-	true to remove a the listener added using event capture

Return:

Object

removeSessionStorageProperty

public Object removeSessionStorageProperty(String propKey)

This function removes the key/value pair stored in sessionStorage. sessionStorage is an instance to save information in client session. This is based on DOM Storage mechanism, a means through which string key/value pairs can be securely stored and later retrieved for use.

Parameters:

propKey

-

key used to remove the value from storage

Return:

Object

Overrides:

AdfAgent.removeSessionStorageProperty(String)

setSessionStorageProperty

public Object setSessionStorageProperty(String propKey,
String propValue)

This function stores the key/value pair in sessionStorage. sessionStorage is an instance to save information in client session. This is based on DOM Storage mechanism, a means through which string key/value pairs can be securely stored and later retrieved for use.

Parameters:

propKey	-	this key will be used to store the key/value in storage
propValue	-	value to be stored.

Return:

Object

Overrides:

AdfAgent.setSessionStorageProperty(String, String)

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