JavaScript API Reference for Oracle ADF Faces

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

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

Direct Known Subclasses:

AdfDhtmlRegionPeer

public class AdfDhtmlPanelBoxPeer
extends AdfRichUIPeer

DISCLOSURE_SUB_ID

public static Object DISCLOSURE_SUB_ID

_DRAG_RECOGNIZER

private static Object _DRAG_RECOGNIZER

Overrides:

AdfUIPeer._DRAG_RECOGNIZER

_ignoreUpAndDownArrowKey

private Object _ignoreUpAndDownArrowKey

_INNER_MAXIMIZE_PEER

private static Object _INNER_MAXIMIZE_PEER

_INNER_SD_PEER

private static Object _INNER_SD_PEER

MAXIMIZE_SUB_ID

public static Object MAXIMIZE_SUB_ID

_SUB_ID_MAP

private static Object _SUB_ID_MAP

panelBox component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [disclosure_icon --> _afrDscl] - the disclosure icon 2. [content --> content] - panelBox content 3. [title] - the title (mapped programmatically) Note that "title" does not have a corresponding ID to map to. Instead it is determined programmatically in AdfDhtmlPanelBoxPeer.GetSubIdDomElement().

AdfDhtmlPanelBoxPeer

public AdfDhtmlPanelBoxPeer()

_animateUndisclosure

private Object _animateUndisclosure(Object event)

Parameters:

event

Return:

Object

_checkAnimateDisclosure

private Object _checkAnimateDisclosure(Object component,
                                       Object contentDom)

Check to see if animation of the disclosure is needed and do so

Parameters:

component
contentDom

Return:

Object

ComponentDisclosedChanged

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

Parameters:

component
domElement
newValue
oldValue

Return:

Object

ComponentMaximizedChanged

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

Parameters:

component
domElement
newValue
oldValue

Return:

Object

CreateDisclosurePeer

protected Object CreateDisclosurePeer(Object component)

Hook point for subclasses (like the RegionPeer) to override the inner disclosure peer creation

Parameters:

component

Return:

Object

CreateMaximizePeer

protected Object CreateMaximizePeer(Object component)

Hook point for subclasses (like the RegionPeer) to override the inner maximize peer creation

Parameters:

component

Return:

Object

DispatchUncanceledComponentEvent

protected Object DispatchUncanceledComponentEvent(Object event)

Override to catch disclosure events that are about to be sent to the server. In the undisclosure case, we want to perform the entire animation

Parameters:

event

Return:

Object

Overrides:

AdfUIPeer.DispatchUncanceledComponentEvent(Object)

GetAnimationDuration

protected Object GetAnimationDuration()

Return the animation duration. Override if needed.

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)

GetContentDomElement

protected Object GetContentDomElement(Object rootElement)

Returns the DOM element used for the panelBox content. The optional rootElement allows this to be called from InitDomElement.

Parameters:

rootElement

Return:

Object

getDefaultDragRecognizer

public Object getDefaultDragRecognizer(Object component)

Override to use our special DragRecognizer

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.getDefaultDragRecognizer(AdfUIComponent)

GetSubIdDomElement

protected Object GetSubIdDomElement(Object subElementId)

Returns the DOM element identified by the passed in subId.

Parameters:

subElementId

Return:

Object - the DOM element

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

_handleAfterDiscloseAnimate

private static Object _handleAfterDiscloseAnimate(Object params)

Parameters:

params

Return:

Object

_handleAfterUndiscloseAnimate

private Object _handleAfterUndiscloseAnimate(Object event,
                                             Object disclosedHeight)

Called after we have finished the undisclosure animation

Parameters:

event
disclosedHeight

Return:

Object

_handleAfterUndiscloseAnimateStub

private static Object _handleAfterUndiscloseAnimateStub(Object params)

Callback stub from animation code for setting up the peer before calling into it

Parameters:

params

Return:

Object

__handleClientSideDisclosure

Object __handleClientSideDisclosure(Object disclosed)

Parameters:

disclosed

Return:

Object

__handleClientSideMaximize

Object __handleClientSideMaximize(Object rootDom,
                                   Object contentDom,
                                   Object maximized)

Parameters:

rootDom
contentDom
maximized

Return:

Object

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Handles component-level clicks

Parameters:

componentEvent

Return:

Object

HandleComponentDisclosure

protected Object HandleComponentDisclosure(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentKeyUp

protected Object HandleComponentKeyUp(AdfUIInputEvent componentEvent)

Handles component-level key ups.

Parameters:

componentEvent

-

the key up component event

Return:

Object

HandleComponentMaximize

protected Object HandleComponentMaximize(Object componentEvent)

Parameters:

componentEvent

Return:

Object

Init

protected Object Init(Object component)

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

Parameters:

component

Return:

Object

Overrides:

AdfObject.Init()

InitDomElement

protected Object InitDomElement(Object component,
                                Object rootElement)

Override to see if we need to animate the disclosure of the component

Parameters:

component
rootElement

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

initialize

public Object initialize(Object component)

Initializes a peer instance about to be returned by AdfLookAndFeel.getPeer(). Non-framework code should never need to call this method

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.initialize(AdfUIComponent)

InitSubclass

protected static Object InitSubclass()

Registers component on click handler

Return:

Object

__isEventForHeaderControls

Object __isEventForHeaderControls(Object nativeEvent)

Hook point for drag peer to call to make sure that clicks on the control peers don't start drags

Parameters:

nativeEvent

Return:

Object