# JavaScript API Reference for Oracle ADF Faces

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

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

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

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

## Field Summary
`public static Object` | `DISCLOSURE_SUB_ID`
`private static Object` | `_DRAG_RECOGNIZER`
`private Object` | `_ignoreUpAndDownArrowKey`
`private static Object` | `_INNER_MAXIMIZE_PEER`
`private static Object` | `_INNER_SD_PEER`
`public static Object` | `MAXIMIZE_SUB_ID`
`private static Object` | `_SUB_ID_MAP` panelBox component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.

### Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, CreateSubId, DISABLED_STYLECLASS, DRAG_READY_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS, SELECTED_STYLECLASS`

### Fields inherited from oracle.adf.view.js.base.AdfObject
`constructor, superclass`

### Fields inherited from org.ecmascript.object.Object
`prototype`

## Constructor Summary
`public` | `AdfDhtmlPanelBoxPeer()`

## Method Summary
`private Object` | `_animateUndisclosure(Object event)`
`private Object` | `_checkAnimateDisclosure(Object component, Object contentDom)` Check to see if animation of the disclosure is needed and do so
`protected Object` | `ComponentDisclosedChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`protected Object` | `ComponentMaximizedChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`protected Object` | `CreateDisclosurePeer(Object component)` Hook point for subclasses (like the RegionPeer) to override the inner disclosure peer creation
`protected Object` | `CreateMaximizePeer(Object component)` Hook point for subclasses (like the RegionPeer) to override the inner maximize peer creation
`protected Object` | `DispatchUncanceledComponentEvent(Object event)` Override to catch disclosure events that are about to be sent to the server.
`protected Object` | `GetAnimationDuration()` Return the animation duration.
`protected Object` | `GetBestMatchSubId(HTMLElement childElement)` Returns the best match subId for the given domElement.
`protected Object` | `GetContentDomElement(Object rootElement)` Returns the DOM element used for the panelBox content.
`public Object` | `getDefaultDragRecognizer(Object component)` Override to use our special DragRecognizer
`protected Object` | `GetSubIdDomElement(Object subElementId)` Returns the DOM element identified by the passed in subId.
`private static Object` | `_handleAfterDiscloseAnimate(Object params)`
`private Object` | `_handleAfterUndiscloseAnimate(Object event, Object disclosedHeight)` Called after we have finished the undisclosure animation
`private static Object` | `_handleAfterUndiscloseAnimateStub(Object params)` Callback stub from animation code for setting up the peer before calling into it
`Object` | `__handleClientSideDisclosure(Object disclosed)`
`Object` | `__handleClientSideMaximize(Object rootDom, Object contentDom, Object maximized)`
`protected Object` | `HandleComponentClick(Object componentEvent)` Handles component-level clicks
`protected Object` | `HandleComponentDisclosure(Object componentEvent)`
`protected Object` | `HandleComponentKeyUp(AdfUIInputEvent componentEvent)` Handles component-level key ups.
`protected Object` | `HandleComponentMaximize(Object componentEvent)`
`protected Object` | `Init(Object component)` Initializes the instance.
`protected Object` | `InitDomElement(Object component, Object rootElement)` Override to see if we need to animate the disclosure of the component
`public Object` | `initialize(Object component)` Initializes a peer instance about to be returned by AdfLookAndFeel.getPeer().
`protected static Object` | `InitSubclass()` Registers component on click handler
`Object` | `__isEventForHeaderControls(Object nativeEvent)` Hook point for drag peer to call to make sure that clicks on the control peers don't start drags

### Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, applyDragReadyState, ApplyDragReadyState, applyDragSourceState, ApplyDragSourceState, bind, BindToComponent, cancelAllPopups, cancelPopup, ChildVisibilityChanged, clearDragReadyState, ClearDragReadyState, clearDragSourceState, ClearDragSourceState, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, domReplaceNotify, DomReplaceNotify, focus, Focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDomRootNodes, GetDomRootNodes, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, GetElementToReplaceWithSVG, getFallbackDomElement, GetFallbackDomElement, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, hideAllPopups, hidePopup, InitClass, isAbsoluteLocatorCacheable, isActive, isBusy, isComponentContainedByElement, isInActiveHeirarchy, isInlineSVGIcon, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, PopupClosed, processPushData, ProcessPushData, registerADSAccessibility, RegisterADSAccessibility, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, simulateMouse, SimulateMouseOnDescendant, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, UpdateMessageType, visitChildren`

### Methods inherited from oracle.adf.view.js.base.AdfUIPeer
`getParentPeer, initiateDrag, isVisible, needsResizeNotify`

### Methods inherited from oracle.adf.view.js.base.AdfObject
`adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, exportPrototypeSymbol, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString`

## Field Detail

### 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().

## Constructor Detail

### AdfDhtmlPanelBoxPeer

`public AdfDhtmlPanelBoxPeer()`

## Method Detail

### _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`

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

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.