JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlSelectBooleanCheckboxPeer

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.laf.dhtml.rich.subids.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

_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

AdfDhtmlSelectBooleanCheckboxPeer

public AdfDhtmlSelectBooleanCheckboxPeer()

Peer for the selectBooleanCheckbox component

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)

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

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

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

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:

AdfDhtmlEditableValuePeer.InitDomElement(Object, Object)

InitSubclass

protected static Object InitSubclass()

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.InitSubclass()

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