JavaScript API Reference for Oracle ADF Faces

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

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.AdfDhtmlPanelSpringboardPeer

public class AdfDhtmlPanelSpringboardPeer
extends AdfRichUIPeer

_bodyCanvasDiv

private Object _bodyCanvasDiv

_bodyViewportDiv

private Object _bodyViewportDiv

_BUSY_CLASS

private static Object _BUSY_CLASS

_cBeltContainer

private Object _cBeltContainer

_cBeltContent

private Object _cBeltContent

_CLICKABLE_TAB_ITEM

private static Object _CLICKABLE_TAB_ITEM

_CONVEYOR_BELT_CONTAINER_ID

private static Object _CONVEYOR_BELT_CONTAINER_ID

_CONVEYOR_BELT_CONTENT_ID

private static Object _CONVEYOR_BELT_CONTENT_ID

_END_CONVEYOR_BELT_INDICATOR

private static Object _END_CONVEYOR_BELT_INDICATOR

_endCBeltI

private Object _endCBeltI

_EXPANDO_CANVAS_ATTRIBUTE

private static Object _EXPANDO_CANVAS_ATTRIBUTE

_EXPANDO_DISCLOSED_TAB_ID

private static Object _EXPANDO_DISCLOSED_TAB_ID

_EXPANDO_ROWKEY_ATTRIBUTE

private static Object _EXPANDO_ROWKEY_ATTRIBUTE

_FLOW_STYLECLASS

private static Object _FLOW_STYLECLASS

_GRID_CLASS

private static Object _GRID_CLASS

_headerDiv

private Object _headerDiv

_isScreenReaderMode

private Object _isScreenReaderMode

_SELECTED_CLASS

private static Object _SELECTED_CLASS

_SELECTED_POINTER_DIV

private static Object _SELECTED_POINTER_DIV

_selectedPointerDiv

private Object _selectedPointerDiv

_shiftField

private Object _shiftField

_START_CONVEYOR_BELT_INDICATOR

private static Object _START_CONVEYOR_BELT_INDICATOR

_startCBeltI

private Object _startCBeltI

_STRIP_CLASS

private static Object _STRIP_CLASS

_SUB_ID_BODY_DIV

private static Object _SUB_ID_BODY_DIV

_SUB_ID_ITEMS_DIV

private static Object _SUB_ID_ITEMS_DIV

_SUB_ID_MAP

private static Object _SUB_ID_MAP

panelSpringboard component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [items --> tabh] - items in the panelSpringboard component 2. [conveyor_belt_container --> cbc] - conveyor belt container in panelSpringboard component 3. [conveyor_belt --> cbct] - conveyor belt in panelSpringboard component 4. [end_overflow_indicator --> ecbic] - end overflow indicator for panelSpringboard items 5. [start_overflow_indicator --> scbic] - start overflow indicator for panelSpringboard items 6. [selected_pointer --> sbsp] - selected pointer or arrow in panelSpringboard 7. [body_viewport --> tabbvp] - body viewport for panelSpringboard 8. [icon --> icon] - icon in the panelSpringboard item

_TAB_BODY_A

private static Object _TAB_BODY_A

_TAB_BODY_B

private static Object _TAB_BODY_B

_TAB_BODY_C

private static Object _TAB_BODY_C

_TAB_BODY_CANVAS

private static Object _TAB_BODY_CANVAS

_TAB_BODY_VIEWPORT

private static Object _TAB_BODY_VIEWPORT

_TAB_HEADER

private static Object _TAB_HEADER

_TAB_SUB_ID_ABOVE

private static Object _TAB_SUB_ID_ABOVE

_TAB_SUB_ID_ICON

private static Object _TAB_SUB_ID_ICON

AdfDhtmlPanelSpringboardPeer

public AdfDhtmlPanelSpringboardPeer()

_afterToGridAnimationFinal

private Object _afterToGridAnimationFinal()

Return:

Object

_afterToStripAnimationFinal

private Object _afterToStripAnimationFinal()

Return:

Object

_animateBodyCanvas

private Object _animateBodyCanvas(Object oldDisclosedClientId,
                                  Object clickedElement)

When a user clicks on a new item in the strip, the body content slides out of the way and a blank area slides in. Then this blank area is replaced with the new content. This function does this sliding animation. The implementation is we have a "body viewport" div that is the width of the body content div. Its child is a "body canvas" div that holds three positioned divs: left, middle, right. The "body canvas" div slides left or right. The new content gets copied into the left or right div, and when animation is done, the divs get re-positioned. We do not animate the body canvas when in 'flow' mode since 'flow' mode is implemented with a table/tr/tds.

Parameters:

oldDisclosedClientId
clickedElement

Return:

Object

_animateBodyCanvasCallback

private Object _animateBodyCanvasCallback(Object slideAnimDuration,
                                          Object animationItemArray)

Parameters:

slideAnimDuration
animationItemArray

Return:

Object

_animateFromGridToStrip

private Object _animateFromGridToStrip(Object iconElems,
                                       int newWidth)

Position the icon items from the strip layout to the grid layout, animating the transition. This function is also called from the _duringToStripAnimation method if the width changes.

Parameters:

iconElems
newWidth	-	the width of the panelSpringboard. This width is used to calculate the absolute positions of each item in strip layout.

Return:

Object

_animateFromStripToGrid

private Object _animateFromStripToGrid(Object iconElems,
                                       int newWidth,
                                       Object newHeight)

Position the icon items from the strip layout to the grid layout, animating the transition.

Parameters:

iconElems
newWidth	-	the width of the panelSpringboard. This width is used to calculate the absolute positions of each item in grid layout.
newHeight

Return:

Object

_animateSelectedPointerDiv

private Object _animateSelectedPointerDiv(Object position)

Parameters:

position

Return:

Object

_attemptToShowAsMuchElementsAsPossible

private Object _attemptToShowAsMuchElementsAsPossible(Object iconElems)

Parameters:

iconElems

Return:

Object

_bodyCanvasAnimationComplete

private Object _bodyCanvasAnimationComplete(Object context)

Parameters:

context

Return:

Object

_bringDisclosedElementIntoView

private Object _bringDisclosedElementIntoView(Object selectedElementPosition,
                                              Object iconElems)

Parameters:

selectedElementPosition
iconElems

Return:

Object

_changeSelected

private Object _changeSelected(String tabClientId,
                               Boolean isSelected)

Sets/Resets the selected state of the item inside this panelSpringboard.

Parameters:

tabClientId	-	the client id of the showDetailItem component
isSelected	-	if the tab is now in a a selected state

Return:

Object

ComponentDisplayModeChanged

protected Object ComponentDisplayModeChanged(Object component,
                                             Object domElement,
                                             Object newValue,
                                             Object oldValue)

Parameters:

component
domElement
newValue
oldValue

Return:

Object

componentRemoved

public Object componentRemoved(Object component)

Clean up the peer because it's component is being removed.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

_determineGridLayout

private Object _determineGridLayout(Object numItems)

Given the number of items, return an array indicating the grid size: rows and columns. This logic is according to the UI Spec.

Parameters:

numItems

Return:

Object

_discloseClickedComponent

private Object _discloseClickedComponent(Object component,
                                         Object clickedComponent,
                                         Object clickedElement)

Do the things that need to be done when an item is clicked when in strip mode: move the selected pointer div, animate the body canvas, and queue the client disclosure changes.

Parameters:

component
clickedComponent
clickedElement

Return:

Object

_discloseItem

private Object _discloseItem(Object clickedId)

We want to propogate to the server to set the clicked showDetailItem as disclosed, however we want the springboardChangeEvent to go first and in a separate request, this callback is needed so that the disclosure event is sent separately

Parameters:

clickedId

Return:

Object

_displayIcon

private Object _displayIcon(Object target,
                            Object component,
                            Object icon)

Parameters:

target
component
icon

Return:

Object

DomReplaceNotify

protected HTMLElement DomReplaceNotify(HTMLElement domNode)

The following is the various comments about this method, copied from other Peer code. Overidden to track replacement of DOM children such as with optimized rendering. // Handles child dom replacement after ppr activity Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced. TODO jmw optimized rendering question: When does this get called? It is overridden in panelAccordion. Do I need to override it here?

Parameters:

domNode

-

the DOM element involved in the replacement

Return:

HTMLElement - the DOM node which should be the target of a subsequent resize traversal

Overrides:

AdfRichUIPeer.domReplaceNotify(AdfUIComponent, Object)

_duringToGridAnimation

private Object _duringToGridAnimation()

Return:

Object

_duringToStripAnimation

private Object _duringToStripAnimation()

Return:

Object

_findChildFromSubId

private Object _findChildFromSubId(Object target,
                                   Object subId1,
                                   Object subId2)

Parameters:

target
subId1
subId2

Return:

Object

_getCanvasDiv

private Object _getCanvasDiv(Object position)

Loop through the bodyCanvasElement and return the div with the 'position' (left, middle, or right) set on the expando

Parameters:

position

Return:

Object

_getCBeltItemShiftValues

private Object _getCBeltItemShiftValues(Object movePrevious,
                                        Object iconElems)

Parameters:

movePrevious
iconElems

Return:

Object

_getCBeltNavWidth

private Object _getCBeltNavWidth()

Return:

Object

_getChildElements

private Array _getChildElements(ADFDomElement childContainer)

Retrieve valid child elements for the provided container. We ignore the selectedPointerDiv, and only return the items.

Parameters:

childContainer

-

the container of the children

Return:

Array - array of child elements

_getCompleteItemWidth

private Object _getCompleteItemWidth()

Return:

Object

getContainerId

public Object getContainerId(Object aligningElement)

Parameters:

aligningElement

Return:

Object

_getGridItemPositions

private Array<Object> _getGridItemPositions(iconElems iconElems,
                                            int newWidth,
                                            int newHeight)

Return an array of items and their positions for the grid layout.

Parameters:

iconElems	-	to position.
newWidth	-	the width of the panelSpringboard. This width is used to calculate the absolute positions of each item in grid layout.
newHeight	-	the height of the panelSpringboard. This height is used to calculate the absolute positions of each item in grid layout.

Return:

Array<Object> - items an array of items whose properties are:

"element"

the element to animate

"properties"

left and top properties

_getOldDisclosedChildComponent

private Object _getOldDisclosedChildComponent(Object component)

This gets a reference to the currently disclosed child item

Parameters:

component

Return:

Object

_getRowKeyElementFromDomElement

private Object _getRowKeyElementFromDomElement(Object domElement,
                                               Object rootDomElement)

Returns the row key ELEMENT. If necessary, walks up the dom hierarchy to find the element with the AdfDhtmlPanelSpringboardPeer._EXPANDO_ROWKEY_ATTRIBUTE. This is the div that contains the item (the icon and text), and is absolutely positioned in the strip or grid.

Parameters:

domElement
rootDomElement

Return:

Object

_getRowKeyFromDomElement

private Object _getRowKeyFromDomElement(Object currElement)

Before calling this function, call _getRowKeyElementFromDomElement to get the current element with the _EXPANDO_ROWKEY_ATTRIBUTE. Then pass that in to this function to get the value of the _EXPANDO_ROWKEY_ATTRIBUTE.

Parameters:

currElement

Return:

Object

_getStripItemPositions

private Array<Object> _getStripItemPositions(iconElems iconElems,
                                             int newWidth,
                                             Object ignoreNewWidthForOverflow)

Return an array of items and their positions for the strip layout.

Parameters:

iconElems	-	to position
newWidth	-	the width of the panelSpringboard. This width is used to calculate the absolute positions of each item in strip layout.
ignoreNewWidthForOverflow

Return:

Array<Object> - items an array of items in the icon strip whose properties are:

"element"

the element to animate

"properties"

left and top properties

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(Object subElementId)

Returns the dom element for a given subId for the PanelSpringboard component.

Parameters:

subElementId

Return:

HTMLElement - the DOM within the component related to scopedId

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

onclick handler

Parameters:

componentEvent

Return:

Object

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseOut

protected Object HandleComponentMouseOut(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseOver

protected Object HandleComponentMouseOver(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseUp

protected Object HandleComponentMouseUp(Object componentEvent)

Parameters:

componentEvent

Return:

Object

_handleIcon

private Object _handleIcon(Object componentEvent,
                           Object isHover,
                           Object isDepressed)

Parameters:

componentEvent
isHover
isDepressed

Return:

Object

_hasSubIdInId

private Object _hasSubIdInId(Object target,
                             Object subId1,
                             Object subId2)

Parameters:

target
subId1
subId2

Return:

Object

_hideCBelt

private Object _hideCBelt()

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)

_initialPositionCanvasDivs

private Object _initialPositionCanvasDivs(Object newWidth)

set the style's width and left for the canvas divs: right, middle, left set the width of the body-canvas which holds all three canvas divs.

Parameters:

newWidth

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

_isCBeltActivated

private Object _isCBeltActivated()

Return:

Object

_isRTL

private static Object _isRTL()

Return:

Object

_maintainCBeltDisplay

private Object _maintainCBeltDisplay(Object newWidth)

This function is to hide or unhide the conveyorbelt icons with unhiding occuring: 1) more elements navigation: the container's width is smaller than the amount of width beyond the _currCBeltIndex index 2) prev elements navigation: if the _currCBeltIndex is greater than 1

Parameters:

newWidth

-

would be passed if there existed a change in the width [i.e. onResize, otherwise the current width would be used]

Return:

Object

_moveDom

private Object _moveDom(Object sourceElement,
                        Object targetElement)

Parameters:

sourceElement
targetElement

Return:

Object

needsResizeNotify

public Object needsResizeNotify(Object component)

Tests whether the peer requires resize notification. Peers which perform geometry management should override this to return true. When true, resizeNotify() will be called when browser window is resized.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.needsResizeNotify(Object)

NewTabSelected

protected Object NewTabSelected(Object component)

Parameters:

component

Return:

Object

_positionElementIntoOverflow

private Object _positionElementIntoOverflow(Object newWidth,
                                            Object iconElems,
                                            Object selectedElementPosition,
                                            Object selectedPosition)

Parameters:

newWidth
iconElems
selectedElementPosition
selectedPosition

Return:

Object

_positionGridMode

private Object _positionGridMode(Object iconElems,
                                 Object newWidth,
                                 Object newHeight)

panelSpringboard in grid mode renders the icons in a grid, with no contents showing.

Parameters:

iconElems	-	the icon items that will be positioned in a grid
newWidth	-	the width of the panelSpringboard component
newHeight	-	the height of the panelSpringboard component

Return:

Object

_positionStripMode

private Object _positionStripMode(Object iconElems,
                                  Object newWidth)

panelSpringboard in strip mode renders the icons in a strip above the content of the disclosed item. It's very similar to the panelTabbed component, but instead of tabs, it renders a strip of icons.

Parameters:

iconElems	-	the icon items that will be positioned in strip mode
newWidth	-	the width of the panelSpringboard component. This is used to calculate the positions of each icon item.

Return:

Object

_prepareCanvasSideForSlide

private Object _prepareCanvasSideForSlide(Object domElement,
                                          Object showDetailItemElement,
                                          Object position)

Before we start the body sliding animation, we need to set things up, like move the showDetailItemElement and set the busy state.

Parameters:

domElement
showDetailItemElement
position

Return:

Object

_processCbeltTab

private Object _processCbeltTab(Object event)

Parameters:

event

Return:

Object

_queueClientDisclosureChanges

private AdfDisclosureEvent _queueClientDisclosureChanges(AdfRichShowDetailItem oldDisclosed,
                                                         AdfRichShowDetailItem newDisclosed)

Queues a disclosure event for the case where there is a disclosure counterpart component. (panelSpringboard (like panelTabbed) will always deal with disclosure counterpart components.) On client: 1.) Queue the setting of disclosed to false on the previously disclosed panel 2.) If #1 propogates through all listeners and doesn't get cancelled (e.g. from validation) then queue the setting of disclosed to true on the newly disclosed panel On server: 1.) Let the DisclosureEvent for the newly disclosed panel have fun 2.) Queue a DisclosureEvent for the previously disclosed panel(s) to set them to false

Parameters:

oldDisclosed	-	the panel that was disclosed
newDisclosed	-	the panel that the user wants to become disclosed

Return:

AdfDisclosureEvent - event queued

_rearrangeCanvasDivs

private Object _rearrangeCanvasDivs(Object selectedCanvas)

Rearrange the canvas divs so that the most recently selected content is shown in the middle canvas. We do this after body sliding animation and after the 'tostrip' animation.

Parameters:

selectedCanvas

-

. There are three canvas divs, left, middle, right. One of them will contain the selected item's content. This is the selectedCanvas div.

Return:

Object

_removeBusy

private Object _removeBusy(Object rootElement)

Parameters:

rootElement

Return:

Object

ReplaceDomElement

protected Object ReplaceDomElement(HTMLElement newElement,
                                   HTMLElement oldElement)

Replaces the a dom element contained in this peer. We partially replace the body content instead of PPR'ing the entire component. This way we can finish the body sliding animation instead of having the entire component get refreshed before the animation completes.

Parameters:

newElement	-	the new dom element
oldElement	-	the old dom element

Return:

Object

Overrides:

AdfRichUIPeer.replaceDomElement(AdfUIComponent, HTMLElement, HTMLElement)

ResizeNotify

protected void ResizeNotify(Number oldWidth,
                            Number oldHeight,
                            Number newWidth,
                            Number newHeight)

Resize notification callback - we perform geometry management here in strip mode we align the icons and selected pointer.

Parameters:

oldWidth	-	the last known width
oldHeight	-	the last known height
newWidth	-	the new width
newHeight	-	the new height

Return:

void - null

Overrides:

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

_selectedPointerAnimationComplete

private Object _selectedPointerAnimationComplete(Object context)

Parameters:

context

Return:

Object

_setBeltContentHeight

private Object _setBeltContentHeight(Object iconElement)

Parameters:

iconElement

Return:

Object

_setBusy

private Object _setBusy(HTMLElement rootElement,
                        HTMLElement bodyCanvasDiv)

Set busy on the appropriate body div. It will depend upon if we are in flow mode or stretch mode.

Parameters:

rootElement	-	the root dom element of the component
bodyCanvasDiv	-	the body-canvas dom element that holds the body div where we will put the busy style (this is only needed in stretch mode)

Return:

Object

_setOldDisclosedChild

private Object _setOldDisclosedChild(Object newDisclosedId)

This saves a reference to the currently disclosed child item

Parameters:

newDisclosedId

Return:

Object

_setSelectedPointerPosition

private Object _setSelectedPointerPosition()

Set the selected pointer position. One reason this function is called is when we animate from grid to strip mode. We'll need to make sure the selected pointer is positioned to point to the selected item, whereever it ended up after the animation.

Return:

Object

_setToNormalIcon

private Object _setToNormalIcon(Object iconElems)

Parameters:

iconElems

Return:

Object

_shiftConveyor

private Object _shiftConveyor(Object movePrevious)

Parameters:

movePrevious

Return:

Object

_shiftHelper

private Object _shiftHelper(Object properties)

Parameters:

properties

Return:

Object

TabReselected

protected Object TabReselected(Object component)

This method is called when the currently disclosed tab is reselected jmw: copied from panelTabbed. These two methods are empty in panelTabbed as well.

Parameters:

component

Return:

Object