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

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

Direct Known Subclasses:
  AdfDhtmlSelectBooleanRadioPeer

    public class AdfDhtmlSelectBooleanCheckboxPeer
    extends AdfDhtmlEditableValuePeer

Peer for the selectBooleanCheckbox component

## Field Summary
`private static Object` | `_inlineEditor`
`private static Object` | `_SELECT_BOOLEAN_VALUE_KEY`
`private static Object` | `_TRCB`
`private static Object` | `_TRCB_ID`
`private Object` | `_updateLabelIdsOnContentNode`

### 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` | `AdfDhtmlSelectBooleanCheckboxPeer()` Peer for the selectBooleanCheckbox component

## Method Summary
`protected Object` | `ComponentTextChanged(Object component, Object domElement, Object newValue, Object oldValue)` Add optimized setter for the text property that sets the text of the label element
`protected Object` | `GetBestMatchSubId(Object domElement)` Returns the best match subId for the given domElement.
`protected String` | `GetComponentText(Object component, Object domElement)` Optimized text getter
`static HTMLElement` | `__getInlineEditableTextElement(HTMLElement domElement)` This is no longer used by the peer, but is apparently called by AdfDhtmlSelectBooleanTextEditor.
`protected Object` | `GetInlineEditor(Event event)` Override to return an inline editor that edits the inputText's label property
`protected Object` | `GetItemTextStyleClass()` This returns the item text style class.
`static HTMLElement` | `__getLabelTextElement(HTMLElement domElement, Object cssClass)`
`protected Object` | `GetLabelTextStyleClass()` This returns the label text style class.
`public Object` | `getLastSubmittedValue(Object component)` Returns the value that was submitted in the last request to the server..
`protected Object` | `GetReadOnlyComponentText(Object component)` Get the component item text when rendered as readOnly.
`protected Object` | `GetSubIdDomElement(Object subElementId)` selectBooleanCheckBox component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.
`protected Object` | `GetSubmittedValue(Object component, Object domElement)` Returns the submittedValue by getting the value of the checked Checkbox button of the selectBooleanCheckbox.
`protected Object` | `HandleComponentClick(Object componentEvent)` Handles component-level click events.
`protected Object` | `HandleComponentMouseOver(Object componentEvent)`
`protected Object` | `InitDomElement(Object component, Object domElement)` Initialize the associated domElement when the peer is created.
`protected static Object` | `InitSubclass()`
`public Object` | `isTristateDeterminateUnchecked(Object component)` Returns true if the checkbox is in tri-state mode and is in unchecked state but not indeterminate/null state
`protected Object` | `NeedsSpuriousDirtyValueTracking()` Override of AdfDhtmlEditableValuePeer.NeedsSpuriousDirtyValueTracking() that enables spurious dirty value tracking.
`protected Object` | `SetDisplayValue(Object component, Object domElement, Object newValue)` Set the display value.
`private Object` | `_updateLabelIdsOnContentNode(Object component, Object domElement)`

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
`autoSubmit, BindToComponent, ComponentChanged, __componentLabelChanged, ComponentSubmittedValueChanged, disableBrowserAutoComplete, Focus, GetComponentLabel, GetComponentSubmittedValue, GetComponentValue, getContentNode, GetContentNode, GetContentNodeId, getContentNodeText, GetDisplayValue, GetLabelElement, GetLabelText, getMarkDirtyFlag, GetNoteWindowAlignmentHint, GetNoteWindowAlignmentNode, GetValidatorHints, HandleComponentFocus, HandleComponentKeyUp, HideNoteWindow, IsInitialized, IsNoteWindowVisible, __isSpuriousDirtyValue, LazyInitialize, MessageNotify, MessageShow, __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, getConvertedObject, getConvertedValue, getFormatHint, GetFormattedDisplayValue, GetNullDefault, isEmpty, 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, 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

### _inlineEditor

`private static Object _inlineEditor`

### _SELECT_BOOLEAN_VALUE_KEY

`private static Object _SELECT_BOOLEAN_VALUE_KEY`

### _TRCB

`private static Object _TRCB`

### _TRCB_ID

`private static Object _TRCB_ID`

### _updateLabelIdsOnContentNode

`private Object _updateLabelIdsOnContentNode`

## Constructor Detail

### AdfDhtmlSelectBooleanCheckboxPeer

`public AdfDhtmlSelectBooleanCheckboxPeer()`
  Peer for the selectBooleanCheckbox component

## Method Detail

### ComponentTextChanged

`protected Object ComponentTextChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)`
  Add optimized setter for the text property that sets the text of the label element
  Parameters:

    `component` | - | the SelectBookCheckbox component
    `domElement` | - | Root DOM element of this peer
    `newValue` | - | the new text
    `oldValue` | - | the old text

  Return:
    `Object`

### GetBestMatchSubId

`protected Object GetBestMatchSubId(Object domElement)`
  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:

    `domElement` |  |

  Return:
    `Object`
  See also:
    `AdfRichUIPeer.GetSubIdDomElement(Object)`
  Overrides:
    `AdfRichUIPeer.GetBestMatchSubId(Object)`

### GetComponentText

`protected String GetComponentText(Object component,
Object domElement)`
  Optimized text getter

  Parameters:

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

  Return:
    `String` - text

### __getInlineEditableTextElement

`static HTMLElement __getInlineEditableTextElement(HTMLElement domElement)`
  This is no longer used by the peer, but is apparently called by AdfDhtmlSelectBooleanTextEditor. Since this is called without a component, we need to check for both selectBooleanCheckbox and selectBooleanRadio style classes to ensure that we return the correct label for both components. Ultimately, __getLabelTextElement() should be called instead of this function.
  Parameters:

    `domElement` | - | component's root DOM element

  Return:
    `HTMLElement` - the DOM Element that is a parent of the text attribute text Node, if any

### GetInlineEditor

`protected Object GetInlineEditor(Event event)`
  Override to return an inline editor that edits the inputText's label property
  Parameters:

    `event` | - | DOM Event that triggered the inline edit

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.getInlineEditor(AdfUIComponent, Object)`

### GetItemTextStyleClass

`protected Object GetItemTextStyleClass()`
  This returns the item text style class. This should be overridden by child classes so that they return their own item text style class.
  Return:
    `Object`

### __getLabelTextElement

`static HTMLElement __getLabelTextElement(HTMLElement domElement,
Object cssClass)`
  Parameters:

    `domElement` | - | component's root DOM element
    `cssClass` |  |

  Return:
    `HTMLElement` - the DOM Element the label element that contains the css class.

### GetLabelTextStyleClass

`protected Object GetLabelTextStyleClass()`
  This returns the label text style class. This should be overridden by child classes so that they return their own label text style class.
  Return:
    `Object`

### getLastSubmittedValue

`public Object getLastSubmittedValue(Object component)`
  Returns the value that was submitted in the last request to the server..
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.getLastSubmittedValue(Object)`

### GetReadOnlyComponentText

`protected Object GetReadOnlyComponentText(Object component)`
  Get the component item text when rendered as readOnly. The text attribute is written out as plain html text with a leading NBSP; character when in readOnly mode. This function returns just the text rendered without the leading NBSP;
  Parameters:

    `component` |  |

  Return:
    `Object`

### GetSubIdDomElement

`protected Object GetSubIdDomElement(Object subElementId)`
  selectBooleanCheckBox component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [content --> content] - selectBooleanCheckBox content 2. [label --> label] - selectBooleanCheckBox label 3. [text --> item text (mapped programmatically)] - selectBooleanCheckBox item text
  Parameters:

    `subElementId` |  |

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.getSubIdDomElement(Object, Object)`

### GetSubmittedValue

`protected Object GetSubmittedValue(Object component,
Object domElement)`
  Returns the submittedValue by getting the value of the checked Checkbox button of the selectBooleanCheckbox.
  Parameters:

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

  Return:
    `Object` - boolean . true if the Checkbox is checked; false if not.
  Overrides:
    `AdfDhtmlEditableValuePeer.GetSubmittedValue(Object, Object)`

### HandleComponentClick

`protected Object HandleComponentClick(Object componentEvent)`
  Handles component-level click events. This gets called when a Checkbox is clicked on, and it will validate the value of the checked Checkbox.
  Parameters:

    `componentEvent` | - | The event on the component

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.HandleComponentClick(Object)`

### HandleComponentMouseOver

`protected Object HandleComponentMouseOver(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  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)`

### InitSubclass

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

### isTristateDeterminateUnchecked

`public Object isTristateDeterminateUnchecked(Object component)`
  Returns true if the checkbox is in tri-state mode and is in unchecked state but not indeterminate/null state
  Parameters:

    `component` |  |

  Return:
    `Object`

### NeedsSpuriousDirtyValueTracking

`protected Object NeedsSpuriousDirtyValueTracking()`
  Override of AdfDhtmlEditableValuePeer.NeedsSpuriousDirtyValueTracking() that enables spurious dirty value tracking. We need to enable spurious handling for AdfDhtmlSelectBooleanCheckboxPeer (and by extension, AdfDhtmlSelectBooleanRadioPeer) in order to work around the fact that Selenium RC fails to deliver any DOM events (no click or change events) in response to calls to Selenium.check() and Selenium.uncheck().
  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.NeedsSpuriousDirtyValueTracking()`

### SetDisplayValue

`protected Object SetDisplayValue(Object component,
Object domElement,
Object newValue)`
  Set the display value. For selectBooleanCheckbox this means checking the CheckboxButton with a value equal to `newValue`.. In readOnly mode, this means setting the text content to the newValue. Called from ComponentSubmittedValueChanged
  Parameters:

    `component` | - | Component that this peer will be associated with
    `domElement` | - | Root DOM element of this peer
    `newValue` | - | The new value of the component. This value has already been converted?? TODO Gab: work out whether newValue should be a string or a boolean when Gab puts in place the BooleanConverter or whatever she is going to do to get the value lifecycle to work with selectBooleans.

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

### _updateLabelIdsOnContentNode

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

    `component` |  |
    `domElement` |  |

  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.