JavaScript API Reference for Oracle ADF Faces

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	_SUB_ID_MAP selectBooleanCheckBox component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.
private static Object	_TRCB
private static Object	_TRCB_ID

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

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 String	GetComponentText(Object component, Object domElement) Optimized text getter
static HTMLElement	__getInlineEditableTextElement(HTMLElement domElement)
protected Object	GetInlineEditor(Event event) Override to return an inline editor that edits the inputText's label property
protected Object	GetSubIdDomElement(Object subElementId) This function returns the dom element of the child element for the provided component; associated with the sub id.
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()
protected Object	SetDisplayValue(Object component, Object domElement, Object newValue) Set the display value.

Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer

autoSubmit, BindToComponent, ComponentChanged, __componentLabelChanged, ComponentSubmittedValueChanged, disableBrowserAutoComplete, Focus, GetComponentLabel, GetComponentSubmittedValue, GetComponentValue, GetContentNode, GetContentNodeId, GetDisplayValue, GetNoteWindowAlignmentHint, GetNoteWindowAlignmentNode, GetValidatorHints, HandleComponentFocus, HandleComponentKeyUp, HideNoteWindow, IsInitialized, IsNoteWindowVisible, LazyInitialize, MessageNotify, MessageShow, ShouldShowHint, ShowNoteWindow, ShowNoteWindowMouseOver, StashOldValue, Validate, ValidateAndStashNewValue, ValidateIfStashedOldValue, VetoShowNoteWindow, WasSubmitted

Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlValuePeer

ComponentValueChanged, getConvertedObject, getConvertedValue, getFormatHint, 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, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, getFirstAncestorComponent, getInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, hideAllPopups, hidePopup, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, messageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, PopupClosed, processPushData, ProcessPushData, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, 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

_SUB_ID_MAP

private static Object _SUB_ID_MAP

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

_TRCB

private static Object _TRCB

_TRCB_ID

private static Object _TRCB_ID

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

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)

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)

GetSubIdDomElement

protected Object GetSubIdDomElement(Object subElementId)

This function returns the dom element of the child element for the provided component; associated with the sub id.

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

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)

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