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

## 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.AdfDhtmlValuePeer
                               |
                               +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
                                     |
                                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlSelectManyPeer

Direct Known Subclasses:
  AdfDhtmlSelectManyCheckboxPeer, AdfDhtmlSelectManyChoicePeer, AdfDhtmlSelectManyListboxPeer, AdfDhtmlSelectManyShuttleBasePeer

    public class AdfDhtmlSelectManyPeer
    extends AdfDhtmlEditableValuePeer

## Field Summary
`public static Object` | `HIGHLIGHTED_STYLE`
`private static Object` | `_ITEM_VALUE_EXPANDO`
`private static Object` | `_SELECT_ALL_ID`
`public static Object` | `SELECTED_STYLE`

### Fields inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
`ComponentLabelChanged, ComponentShowRequiredChanged`

### 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` | `AdfDhtmlSelectManyPeer()`

## Method Summary
`protected Object` | `GetCheckboxByEventTarget(Object element, Object componentEvent)` Helper function the get a input checkbox element, that is nexted inside an structure.
`protected Object` | `GetCheckboxes(Object component, Object domElement, Object containerName)` Helper to get an array of input checkbox elements from a given `ul` HTML element (trail or lead)
`protected String` | `GetComponentLabel(Object component, Object domElement)` We need to override this because we have other label children and the default implementation doesn't cope with that.
`protected Object` | `GetComponentSelectItems(Object component, Object domElement)`
`public Object` | `getConvertedObject(Object component, Object value)` overridden from AdfDhtmlValuePeer Can return undefined if converter not successful
`public Object` | `getConvertedValue(Object component, Object submittedValue)` akin to javax.faces.render.Renderer.getConvertedValue()
`protected static Object` | `GetElementByAttributeValue(Object elementArr, Object attrName, Object attrValue)`
`protected Object` | `GetNextItem(Object component, Object domElement, Object item, Object containerName)` Get the next available enabled item
`protected Object` | `GetNullDefault()`
`protected Object` | `GetPreviousItem(Object component, Object domElement, Object item, Object ignoreAllCheckbox, Object containerName)` Get the previous available enabled item
`protected Object` | `GetSelectAllCheckbox(Object component)`
`protected Object` | `GetSelectItemsParentDomElement(Object component)`
`protected Object` | `GetSubmittedValue(Object component, Object domElement)` Returns the submittedValue by getting the value of the input dom node.
`protected Object` | `HandleComponentMouseOver(Object componentEvent)`
`protected static Object` | `InitSubclass()`
`protected Object` | `IsCheckbox(Object element)` Function that checks if a given element is a input element of the type 'checkbox'.
`protected Object` | `SelectRange(Object component, Object domElement, Object newItem, Object oldItem, Object containerName)`
`protected Object` | `UpdateAll(Object component, Object domElement, Object isChecked, Object validate)`
`protected Object` | `UpdateSelectedStyle(Object checkbox)`

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
`autoSubmit, BindToComponent, ComponentChanged, __componentLabelChanged, ComponentSubmittedValueChanged, disableBrowserAutoComplete, Focus, GetComponentSubmittedValue, GetComponentValue, getContentNode, GetContentNode, GetContentNodeId, getContentNodeText, GetDisplayValue, GetLabelElement, GetLabelText, getLastSubmittedValue, getMarkDirtyFlag, GetNoteWindowAlignmentHint, GetNoteWindowAlignmentNode, GetValidatorHints, HandleComponentClick, HandleComponentFocus, HandleComponentKeyUp, HideNoteWindow, InitDomElement, IsInitialized, IsNoteWindowVisible, __isSpuriousDirtyValue, LazyInitialize, MessageNotify, MessageShow, NeedsSpuriousDirtyValueTracking, __resetSpuriousDirtyValue, __restoreDirtyDisplayValue, setLastSubmittedValue, setMarkDirtyFlag, ShouldShowHint, ShowNoteWindow, ShowNoteWindowMouseOver, StashOldValue, StopArrowKeyBubbling, Validate, ValidateAndStashNewValue, ValidateIfStashedOldValue, VetoShowNoteWindow, WasSubmitted`

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlValuePeer
`ComponentValueChanged, GetBestMatchSubId, getFormatHint, GetFormattedDisplayValue, GetSubIdDomElement, isEmpty, setDisplayValue, SetDisplayValue`

### Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, applyDragReadyState, ApplyDragReadyState, applyDragSourceState, ApplyDragSourceState, bind, 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, DispatchUncanceledComponentEvent, domReplaceNotify, DomReplaceNotify, 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, initialize, isAbsoluteLocatorCacheable, isActive, isBusy, isComponentContainedByElement, isInActiveHeirarchy, isInlineSVGIcon, isPopupVisible, messageNotify, 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
`getDefaultDragRecognizer, getParentPeer, Init, 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

### HIGHLIGHTED_STYLE

`public static Object HIGHLIGHTED_STYLE`

### _ITEM_VALUE_EXPANDO

`private static Object _ITEM_VALUE_EXPANDO`

### _SELECT_ALL_ID

`private static Object _SELECT_ALL_ID`

### SELECTED_STYLE

`public static Object SELECTED_STYLE`

## Constructor Detail

### AdfDhtmlSelectManyPeer

`public AdfDhtmlSelectManyPeer()`

## Method Detail

### GetCheckboxByEventTarget

`protected Object GetCheckboxByEventTarget(Object element,
Object componentEvent)`
  Helper function the get a input checkbox element, that is nexted inside an
  structure.
  Parameters:

    `element` |  |
    `componentEvent` |  |

  Return:
    `Object`

### GetCheckboxes

`protected Object GetCheckboxes(Object component,
Object domElement,
Object containerName)`
  Helper to get an array of input checkbox elements from a given `ul` HTML element (trail or lead)
  Parameters:

    `component` | - | the component
    `domElement` | - | the root dom element
    `containerName` | - | the optional name of the container

  Return:
    `Object`

### GetComponentLabel

`protected String GetComponentLabel(Object component,
Object domElement)`
  We need to override this because we have other label children and the default implementation doesn't cope with that.
  Parameters:

    `component` | - | Component that this peer will be associated with
    `domElement` | - | Root DOM element of this peer

  Return:
    `String` - label
  Overrides:
    `AdfDhtmlEditableValuePeer.GetComponentLabel(Object, Object)`

### GetComponentSelectItems

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

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### getConvertedObject

`public Object getConvertedObject(Object component,
Object value)`
  overridden from AdfDhtmlValuePeer Can return undefined if converter not successful
  Parameters:

    `component` |  |
    `value` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.getConvertedObject(Object, Object)`

### getConvertedValue

`public Object getConvertedValue(Object component,
Object submittedValue)`
  akin to javax.faces.render.Renderer.getConvertedValue()
  Parameters:

    `component` |  |
    `submittedValue` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.getConvertedValue(Object, Object)`

### GetElementByAttributeValue

`protected static Object GetElementByAttributeValue(Object elementArr,
Object attrName,
Object attrValue)`
  Parameters:

    `elementArr` |  |
    `attrName` |  |
    `attrValue` |  |

  Return:
    `Object`

### GetNextItem

`protected Object GetNextItem(Object component,
Object domElement,
Object item,
Object containerName)`
  Get the next available enabled item
  Parameters:

    `component` | - | the component
    `domElement` | - | the root dom element
    `item` | - | the current tabStop item
    `containerName` | - | the optional name of the desired container to get the previous tab stop

  Return:
    `Object` - the next enabled item, or the current if there are no more next enabled items

### GetNullDefault

`protected Object GetNullDefault()`
  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.GetNullDefault()`

### GetPreviousItem

`protected Object GetPreviousItem(Object component,
Object domElement,
Object item,
Object ignoreAllCheckbox,
Object containerName)`
  Get the previous available enabled item
  Parameters:

    `component` | - | the component
    `domElement` | - | the root dom element
    `item` | - | the current tabStop item
    `ignoreAllCheckbox` | - | should the ALL checkbox element be ignored
    `containerName` | - | the optional name of the desired container to get the previous tab stop

  Return:
    `Object` - the prev enabled item, or the current if there are no more prev enabled items

### GetSelectAllCheckbox

`protected Object GetSelectAllCheckbox(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### GetSelectItemsParentDomElement

`protected Object GetSelectItemsParentDomElement(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### GetSubmittedValue

`protected Object GetSubmittedValue(Object component,
Object domElement)`
  Returns the submittedValue by getting the value of the input dom node.
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.GetSubmittedValue(Object, Object)`

### HandleComponentMouseOver

`protected Object HandleComponentMouseOver(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### InitSubclass

`protected static Object InitSubclass()`
  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.InitSubclass()`

### IsCheckbox

`protected Object IsCheckbox(Object element)`
  Function that checks if a given element is a input element of the type 'checkbox'.
  Parameters:

    `element` |  |

  Return:
    `Object`

### SelectRange

`protected Object SelectRange(Object component,
Object domElement,
Object newItem,
Object oldItem,
Object containerName)`
  Parameters:

    `component` |  |
    `domElement` |  |
    `newItem` |  |
    `oldItem` |  |
    `containerName` |  |

  Return:
    `Object`

### UpdateAll

`protected Object UpdateAll(Object component,
Object domElement,
Object isChecked,
Object validate)`
  Parameters:

    `component` |  |
    `domElement` |  |
    `isChecked` |  |
    `validate` |  |

  Return:
    `Object`

### UpdateSelectedStyle

`protected Object UpdateSelectedStyle(Object checkbox)`
  Parameters:

    `checkbox` |  |

  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.