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

## 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.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlPanelTabbedPeer
             |
             +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPanelDrawerPeer

    public class AdfDhtmlPanelDrawerPeer
    extends AdfDhtmlPanelTabbedPeer

## Field Summary
`private static Object` | `_FLOAT_CLASS`
`private static Object` | `_OPEN_CLASS`
`private static Object` | `_TABS_PARENT`
`private static Object` | `_TEMP_FLOAT_SUBID`
`private static Object` | `_TRACKER_SUBID`

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

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

## Method Summary
`private Object` | `_alignLeft(Object component)` method to determine if the drawer is on the left or right side
`protected Object` | `BindToComponent(Object component, Object domElement)`
`public boolean` | `canHide()` Method used to determine whether the popup can be closed at any given point
`private Object` | `_checkInvalid(Object component)`
`public Object` | `componentRemoved(Object component)`
`protected Object` | `DescendantMessageChanged()` this method can be overridden to call AdfPage.PAGE.getClientIdsWithMessages(rootId) to find out the client ids with messages for this subtree.
`private Object` | `_drawerClosed()` This is used as a callback when the drawer closes
`private Object` | `_drawerOpened()` This is used as a callback when the drawer opened
`private Object` | `_getAlignNodeId(Object component, Object domElement)` get the id of the dom element to align to, this may or may not be the root dom element of the component referred to in the alignId attribute
`private Object` | `_getAutoDismiss(Object component)` whether or not to auto dismiss the drawer
`private Object` | `_getCacheablePopupHints(Object component, Object alignNodeId)`
`public AdfUIComponent` | `getComponentParent(AdfUIComponent component)` Get the parent component.
`private Object` | `_getPopupHints(Object component, Object alignNodeId)` get the hints to use on the popup
`private static AdfUIComponent` | `_getPreceedingCommentBasedPeer(AdfUIComponent component, String clientId)` Checks for a comment-based peer preceeding the provided component.
`private Object` | `_getSize(Object val, Object alignSize)`
`protected Object` | `HandleComponentClick(Object componentEvent)`
`private Object` | `_handleResize()` Callback invoked when the size of the align element changes.
`private Object` | `_initializeDrawer(Object clientId)` initialize the drawer.
`protected static Object` | `InitSubclass()`
`protected Object` | `IsDisclosedTabRequired(Object element)`
`private Object` | `_isPercent(Object val)` whether or not the value is a percent
`protected Object` | `IsVerticalConveyorSupported(Object element)`
`protected Object` | `NewTabSelected(Object component)`
`private Object` | `_percentSize(Object val, Object size)` only call this if you already called isPercent
`private Object` | `_placeHandles(Object component, Object domElement)` place the handles at their initial location
`private Object` | `_remove(Object component)` called when the drawer is removed
`private Object` | `_removeHandlePositioning(Object component, Object domElement)` when the drawer is opened we save off the handle positioning and then remove it from the handle
`private Object` | `_renderClosed(Object component, Object domElement)` close the drawer
`private Object` | `_renderOpen(Object component, Object domElement)` render the drawer opened
`private Object` | `_restoreHandlePositioning(Object component, Object domElement)` when the drawer is closed we restore the handle positioning that was saved in _removeHandlePositioning
`private Object` | `_setDimensionValue(Object component, Object contentElement, Object alignNodeId)` calculate the dimensions of the drawer based on height, width, maximumHeight, maximumWidth attributes
`private Object` | `_setInitialMargins(Object component, Object domElement, Object alignNode, Object alignTop, Object alignLeft, Object isAlignedLeft, Object shadowElement, Object shadowElementHeight, Object shadowElementWidth)` In some cases you're aligning to something that has padding, so offset that with negative margins if necessary.
`private Object` | `_setMargins(Object component, Object domElement)`
`protected Object` | `TabReselected(Object component, Object child)` This method is called when the currently disclosed tab is reselected
`private Object` | `_trackerRemoved()` callback when the tracker component left at the initial dom position is removed.
`protected Object` | `UseInvertedRenderingPosition()` This is needed because when the panelDrawer has position set to "right", it means align the entire drawer on the right, but the tabs are rendered such that the tabs are to the left of the showDetailItem content.

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlPanelTabbedPeer
`GetBestMatchSubId, GetSubIdDomElement`

## Field Detail

### _FLOAT_CLASS

`private static Object _FLOAT_CLASS`

### _OPEN_CLASS

`private static Object _OPEN_CLASS`

### _TABS_PARENT

`private static Object _TABS_PARENT`

### _TEMP_FLOAT_SUBID

`private static Object _TEMP_FLOAT_SUBID`

### _TRACKER_SUBID

`private static Object _TRACKER_SUBID`

## Constructor Detail

### AdfDhtmlPanelDrawerPeer

`public AdfDhtmlPanelDrawerPeer()`

## Method Detail

### _alignLeft

`private Object _alignLeft(Object component)`
  method to determine if the drawer is on the left or right side
  Parameters:

    `component` |  |

  Return:
    `Object` - true if the drawer is on the left, false if it's on the right

### BindToComponent

`protected Object BindToComponent(Object component,
Object domElement)`
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### canHide

`public boolean canHide()`
  Method used to determine whether the popup can be closed at any given point
  Return:
    `boolean` - null - returns false if there are any validation errors in the disclosed tab

### _checkInvalid

`private Object _checkInvalid(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### componentRemoved

`public Object componentRemoved(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### DescendantMessageChanged

`protected Object DescendantMessageChanged()`
  this method can be overridden to call AdfPage.PAGE.getClientIdsWithMessages(rootId) to find out the client ids with messages for this subtree. For each client id returned you can call AdfPage.PAGE.getClientIdsWithMessages(clientId) for the specific messages.
  Return:
    `Object`

### _drawerClosed

`private Object _drawerClosed()`
  This is used as a callback when the drawer closes
  Return:
    `Object`

### _drawerOpened

`private Object _drawerOpened()`
  This is used as a callback when the drawer opened
  Return:
    `Object`

### _getAlignNodeId

`private Object _getAlignNodeId(Object component,
Object domElement)`
  get the id of the dom element to align to, this may or may not be the root dom element of the component referred to in the alignId attribute
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _getAutoDismiss

`private Object _getAutoDismiss(Object component)`
  whether or not to auto dismiss the drawer
  Parameters:

    `component` |  |

  Return:
    `Object`

### _getCacheablePopupHints

`private Object _getCacheablePopupHints(Object component,
Object alignNodeId)`
  Parameters:

    `component` |  |
    `alignNodeId` |  |

  Return:
    `Object`

### getComponentParent

`public AdfUIComponent getComponentParent(AdfUIComponent component)`
  Get the parent component.
  Parameters:

    `component` | - | to determine the parent of

  Return:
    `AdfUIComponent` - the parent of this component in the client component hierarchy.

### _getPopupHints

`private Object _getPopupHints(Object component,
Object alignNodeId)`
  get the hints to use on the popup
  Parameters:

    `component` |  |
    `alignNodeId` |  |

  Return:
    `Object`

### _getPreceedingCommentBasedPeer

`private static AdfUIComponent _getPreceedingCommentBasedPeer(AdfUIComponent component,
String clientId)`
  Checks for a comment-based peer preceeding the provided component.
  Parameters:

    `component` | - | the component to check
    `clientId` | - | clientId clientId to check against

  Return:
    `AdfUIComponent` - the preceeding comment-based peer for the component, if found

### _getSize

`private Object _getSize(Object val,
Object alignSize)`
  Parameters:

    `val` | - | percentage value, like "75%", or fixed value like px or em
    `alignSize` | - | the value of the dimension of the alignNode, if val is a percent the alignSize will be used to determine the size returned.

  Return:
    `Object` - integer value of the dimension

### HandleComponentClick

`protected Object HandleComponentClick(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### _handleResize

`private Object _handleResize()`
  Callback invoked when the size of the align element changes.
  Return:
    `Object`
  See also:
    `AdfAgent.addResizeListener(String, Function)`

### _initializeDrawer

`private Object _initializeDrawer(Object clientId)`
  initialize the drawer.
  Parameters:

    `clientId` |  |

  Return:
    `Object`

### InitSubclass

`protected static Object InitSubclass()`
  Return:
    `Object`

### IsDisclosedTabRequired

`protected Object IsDisclosedTabRequired(Object element)`
  Parameters:

    `element` |  |

  Return:
    `Object` - whether one tab must be disclosed at all times

### _isPercent

`private Object _isPercent(Object val)`
  whether or not the value is a percent
  Parameters:

    `val` |  |

  Return:
    `Object`

### IsVerticalConveyorSupported

`protected Object IsVerticalConveyorSupported(Object element)`
  Parameters:

    `element` |  |

  Return:
    `Object` - true if vertical conveyor belt is supported.

### NewTabSelected

`protected Object NewTabSelected(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### _percentSize

`private Object _percentSize(Object val,
Object size)`
  only call this if you already called isPercent
  Parameters:

    `val` | - | percentage value, like "75%"
    `size` | - | the original size

  Return:
    `Object` - the new size which is a percentage of the original size.

### _placeHandles

`private Object _placeHandles(Object component,
Object domElement)`
  place the handles at their initial location
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _remove

`private Object _remove(Object component)`
  called when the drawer is removed
  Parameters:

    `component` |  |

  Return:
    `Object`

### _removeHandlePositioning

`private Object _removeHandlePositioning(Object component,
Object domElement)`
  when the drawer is opened we save off the handle positioning and then remove it from the handle
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _renderClosed

`private Object _renderClosed(Object component,
Object domElement)`
  close the drawer
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _renderOpen

`private Object _renderOpen(Object component,
Object domElement)`
  render the drawer opened
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _restoreHandlePositioning

`private Object _restoreHandlePositioning(Object component,
Object domElement)`
  when the drawer is closed we restore the handle positioning that was saved in _removeHandlePositioning
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _setDimensionValue

`private Object _setDimensionValue(Object component,
Object contentElement,
Object alignNodeId)`
  calculate the dimensions of the drawer based on height, width, maximumHeight, maximumWidth attributes
  Parameters:

    `component` |  |
    `contentElement` |  |
    `alignNodeId` |  |

  Return:
    `Object`

### _setInitialMargins

`private Object _setInitialMargins(Object component,
Object domElement,
Object alignNode,
Object alignTop,
Object alignLeft,
Object isAlignedLeft,
Object shadowElement,
Object shadowElementHeight,
Object shadowElementWidth)`
  In some cases you're aligning to something that has padding, so offset that with negative margins if necessary. A shadow floating element may have been left as a child of the original dom parent so that other content will still flow around the area where the handles will be rendered. We will adjust the size of the shadowElement in this method.
  Parameters:

    `component` |  |
    `domElement` |  |
    `alignNode` |  |
    `alignTop` |  |
    `alignLeft` |  |
    `isAlignedLeft` |  |
    `shadowElement` |  |
    `shadowElementHeight` |  |
    `shadowElementWidth` |  |

  Return:
    `Object`

### _setMargins

`private Object _setMargins(Object component,
Object domElement)`
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### TabReselected

`protected Object TabReselected(Object component,
Object child)`
  This method is called when the currently disclosed tab is reselected
  Parameters:

    `component` |  |
    `child` |  |

  Return:
    `Object`

### _trackerRemoved

`private Object _trackerRemoved()`
  callback when the tracker component left at the initial dom position is removed.
  Return:
    `Object`

### UseInvertedRenderingPosition

`protected Object UseInvertedRenderingPosition()`
  This is needed because when the panelDrawer has position set to "right", it means align the entire drawer on the right, but the tabs are rendered such that the tabs are to the left of the showDetailItem content. So the position attribute is "right", but for rendering the tabs relative to the showDetailItem content we want it to behave as if it's "left".
  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.