JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlToolbarPeer

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfUIPeer
               |
               +--oracle.adf.view.js.laf.rich.AdfRichUIPeer
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlToolbarPeer

public class AdfDhtmlToolbarPeer
extends AdfRichUIPeer

_childContainers

private Object _childContainers

_isOverflowSupported

private Object _isOverflowSupported

_isSingleTabstop

private Object _isSingleTabstop

_overflowContainer

private Object _overflowContainer

_SUB_ID_MAP

private static Object _SUB_ID_MAP

toolbar component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [start_overflow_indicator --> soi] - toolbar start overflow indicator 2. [end_overflow_indicator --> eoi] - toolbar end overflow indicator 3. [start_overflow_container --> soc] - toolbar start overflow container 4. [end_overflow_container --> eoc] - toolbar end overflow container 5. [item[#] --> an item, corresponding to the #, on the toolbar (mapped programmatically)]

AdfDhtmlToolbarPeer

public AdfDhtmlToolbarPeer()

Peer Implementation for toolbar

_canMoveFocus

private boolean _canMoveFocus()

Can we move focus, for roving tab index case.

Return:

boolean - can we move focus

ChildVisibilityChanged

protected Object ChildVisibilityChanged(Object childComponent,
                                        Object childDomElement,
                                        Object childVisible)

Called when the visibility of a child component changes if the peer has overridden needsChildVisibilityChanges to return true. The peer can use the child's component, domElement, and new visibility parameters to determine whether it needs to handle the visibility change rather than letting the default implementation of hiding or showing the child. If the peer will handle the change (often by marking itself as needing to be redrawn, it should perform whatever work is necessary and return true from this method.

Overrides of this method should be aware that when this method is called, the child component's peer may no longer be bound to the child component (for example, if both the child and parent component peers are the same instance).

Overrides of this method should use the childDomElement parameter to determine whether the passed in childComponent is actually a direct descendant of the parent component.

Parameters:

childComponent
childDomElement
childVisible

Return:

Object

Overrides:

AdfRichUIPeer.ChildVisibilityChanged(Object, Object, Object)

ComponentRemoved

protected Object ComponentRemoved(AdfUIComponent component)

Handles the removal of a component.

Parameters:

component

-

The component that was removed.

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

_createOverflowElement

private Object _createOverflowElement(Object element)

Create and return a single html overflow element for the provided element data.

Parameters:

element

Return:

Object

GetBestMatchSubId

protected Object GetBestMatchSubId(HTMLElement childElement)

Returns the best match subId for the given domElement. This can be enhanced further to return programmatically determined subIds. WARNING - You must make sure to bind the component to the peer before calling this function.

Parameters:

childElement

-

the child DOM element

Return:

Object

See also:

AdfRichUIPeer.GetSubIdDomElement(Object)

Overrides:

AdfRichUIPeer.GetBestMatchSubId(Object)

getDescendantComponents

public AdfUIComponent getDescendantComponents(AdfUIComponent component,
                                              Array<AdfUIComponent> children)

Returns an array of descendant (child) components for this component. Overwritten to include items in overflow as well.

Parameters:

component	-	this component
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:

AdfUIComponent - array of child components, may be empty

Overrides:

AdfUIPeer.getDescendantComponents(AdfUIComponent, Array<AdfUIComponent>)

GetMinimumWidth

protected Number GetMinimumWidth()

Returns the minimum width of a toolbar. Called by toolbox peer. NOTE: we might want to promote this method up to AdfRichUIPeer but holding off, since we want to be conservative about exposing new public APIs

Return:

Number - The minimum width.

GetPreferredWidth

protected Number GetPreferredWidth()

Calculates the preferred width of a toolbar. This is the width of the toolbar when it doesn't have overflow or stretching. This is used by the toolbox for overflowing purposes. NOTE: we might want to promote this method up to AdfRichUIPeer but holding off, since we want to be conservative about exposing new public APIs

Return:

Number - The preferred width.

_getStretchElement

private HTMLElement _getStretchElement()

Finds the DOM element for the stretched component.

Return:

HTMLElement - The element

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(String subElementId)

Returns the dom element for a given subElementId for toolbar component.

Parameters:

subElementId

-

the id of the child dom element or component

Return:

HTMLElement - the DOM within the component related to scopedId

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

_handleArrowKeys

private Object _handleArrowKeys(Object keyCode,
                                Object componentEvent)

Handler for arrow key events.

Parameters:

keyCode	-	the keyCode
componentEvent	-	the component event

Return:

Object

HandleComponentFocus

protected Object HandleComponentFocus(Object componentEvent)

Handle component focus.

Parameters:

componentEvent

-

the component event invoked by focus

Return:

Object

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

Component keyboard key down event handler

Parameters:

componentEvent

-

the component event invoked by key down

Return:

Object

HandleComponentKeyPress

protected Object HandleComponentKeyPress(Object componentEvent)

Component keyboard key press event handler

Parameters:

componentEvent

-

the component event invoked by key press

Return:

Object

InitDomElement

protected Object InitDomElement(Object component,
                                Object domElement)

Initialize the associated domElement when the peer is created. Stateless peers are not bound at the time that this method is called.

Parameters:

component
domElement

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

InitSubclass

protected static Object InitSubclass()

Return:

Object

_moveHighlightToNextItem

private Object _moveHighlightToNextItem(Object componentEvent)

Moves the highlight (selection) to the next (right) item.

Parameters:

componentEvent

Return:

Object

_moveHighlightToPreviousItem

private Object _moveHighlightToPreviousItem(Object componentEvent)

Moves the highlight (selection) to the previous (left) item.

Parameters:

componentEvent

Return:

Object

needsChildVisibilityChanges

public Object needsChildVisibilityChanges(Object component)

Test whether the peer wants to be notified if the visibility of one of its children changes. If a peer overrides this method to return true, the peer's ChildVisibilityChanged method will be called.

The peer is not bound when this method is called. Peers with complicated logic to determine whether they need to be informed of child visibility changes should return true from this method and place their logic inside of their ChildVisibilityChanged override.

Parameters:

component

Return:

Object

Overrides:

AdfRichUIPeer.needsChildVisibilityChanges(AdfUIComponent)

needsResizeNotify

public Object needsResizeNotify(Object component)

We need resize notification.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.needsResizeNotify(Object)

__preferredSizeChangeNotify

Object __preferredSizeChangeNotify(AdfUIComponent component)

Notification that the components internal preferred sizes have changed. This is needed for toolbars and toolboxes that used cached size values, and need to be notified when sizes change due to delayed image delivery. This is a temporary method and fix for bug 9035962, to be replaced by er 9491549 fix.

Parameters:

component

-

the associated component (not necessarily bound) identified as having a preferred size change.

Return:

Object

resetActiveDescendant

public Object resetActiveDescendant()

For a single tabstop toolbar, reset the active descendant to the first focusable child. This needs to occur when a child that was the active descendant enters a state (like disabled) where they no longer support focus.

Return:

Object

ResizeNotify

protected Object ResizeNotify(Object oldWidth,
                              Object oldHeight,
                              Object newWidth,
                              Object newHeight)

Resize notification callback - we perform geometry management here

Parameters:

oldWidth
oldHeight
newWidth
newHeight

Return:

Object

Overrides:

AdfUIPeer.resizeNotify(Object, Object, Object, Object, Object)

_reStretch

private Object _reStretch()

If there is a stretch element in the toolbar, reapply it to it's maximum size

Return:

Object

SimulateMouseOnDescendant

protected Object SimulateMouseOnDescendant(AdfUIComponent targetComponent,
                                           HTMLElement domElement,
                                           Object mouseEvent)

Override to see if descendant is in overflow. If so, open overflow popup before the simulated mouse event is processed.

Parameters:

targetComponent	-	the component receiving the mouseEvent.
domElement	-	the particular dom element receiving the mouseEvent
mouseEvent	-	javascript object containing a sparse set of mouse event name value pairs.

Return:

Object

Overrides:

AdfRichUIPeer.SimulateMouseOnDescendant(AdfUIComponent, HTMLElement, Object)

_unStretch

private Object _unStretch()

If there is a stretch element in the toolbar, remove its assigned width.

Return:

Object

_updateActiveDescendant

private Object _updateActiveDescendant(HTMLElement newActiveDescendant)

Update the set active descendant to a new child element

Parameters:

newActiveDescendant

-

The new child element to set as the active descendant. Cannot be null.

Return:

Object