JavaScript API Reference for Oracle ADF Faces

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

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

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.AdfDhtmlSelectOnePeer
                                       |
                                       +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlSelectOneListbasePeer
                                             |
                                             +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlSelectOneChoicePeer

public class AdfDhtmlSelectOneChoicePeer
extends AdfDhtmlSelectOneListbasePeer

Renders a selectOneChoice for DHTML

Field Summary

private static Object	_COMPACT
private static Object	_DROPDOWN_ID
private static Object	_HIGHLIGHTED_STYLE_CLASS
private static Object	_POPUP_ID
private static Object	_POPUP_PANEL_ID
private static Object	_POPUP_WRAPPER_ID
private static Object	_SPACER_ID
private static Object	_SUB_ID_MAP selectOneChoice component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.
private static Object	_TEMP_OPTION_KEY
private static Object	_TEXT_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

AdfDhtmlSelectOneChoicePeer() Renders a selectOneChoice for DHTML

Method Summary

protected Object	AddEmptyOption(Object component, Object domElement)
protected Object	ComponentDisabledChanged(Object component, Object domElement, Object newValue, Object oldValue)
protected Object	FindItemElementWithValue(Object component, Object itemValue)
protected Object	GetComponentMode(Object component) Protected property getter for mode property.
protected Object	GetComponentSelectItems(Object component, Object domElement)
private Object	_getFocusElement(Object component)
protected Object	GetInlineEditor(Event event) Override to return an inline editor that edits the component's label property
protected Object	GetItemElements(Object component)
protected Object	GetItemElementsParent(Object component) Returns the parent of the item elements so that the item elements can be traversed
protected Object	GetNoteWindowAlignmentNode(Object component, Object rootNode) Returns the node for which to align the note help window
protected Object	HandleComponentClick(Object componentEvent) component mouse click event handler.
protected Object	HandleComponentFocus(Object componentEvent)
protected Object	HandleComponentKeyDown(Object componentEvent)
protected Object	HandleComponentMouseDown(Object componentEvent) component mouse down event handler to popup the option list.
protected Object	HandleComponentMouseOut(Object componentEvent)
protected Object	HandleComponentMouseOver(Object componentEvent)
protected Object	HandleDomChange(Object component, Object domEvent) DOM change event event handler
protected static Object	InitSubclass()
private Object	_isCompact(Object component)
protected Object	LazyInitialize(Object component, Object domElement) We need to initialize the 'value' property before the user makes any changes so that we're not going to the peer for the 'value' property in the component.setProperty method.
public Object	needsFocusTargetStyleClass() Test if the peer needs the :focus-target stype class injected for click-to-edit.
protected Object	PopupClosed(Object component, Object contentDom, Object popupId) Call back method called when the popup option list is closed.
private Object	_returnToDropDown(Object component)
protected Object	SetDisplayValue(Object component, Object domElement, Object newValue) start:
private Object	_showPopupPanel(Object component)

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

GetFirstEnabledItem, GetNextEnabledItem, GetPreviousEnabledItem, GetSubmittedValue, IsItemEnabled, SelectItemElement

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

GetSubIdDomElement

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, GetValidatorHints, HandleComponentKeyUp, HideNoteWindow, InitDomElement, IsInitialized, IsNoteWindowVisible, 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, 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

_COMPACT

private static Object _COMPACT

_DROPDOWN_ID

private static Object _DROPDOWN_ID

_HIGHLIGHTED_STYLE_CLASS

private static Object _HIGHLIGHTED_STYLE_CLASS

_POPUP_ID

private static Object _POPUP_ID

_POPUP_PANEL_ID

private static Object _POPUP_PANEL_ID

_POPUP_WRAPPER_ID

private static Object _POPUP_WRAPPER_ID

_SPACER_ID

private static Object _SPACER_ID

_SUB_ID_MAP

private static Object _SUB_ID_MAP

selectOneChoice component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [content --> content] - selectOneChoice content 2. [label --> label] - selectOneChoice label 3. [item[(value)] --> item] - selectOneChoice item (selectItem, by rendered value) 4. [dropdown --> drop (compact mode only)] - selectOneChoice compact mode dropdown

_TEMP_OPTION_KEY

private static Object _TEMP_OPTION_KEY

_TEXT_ID

private static Object _TEXT_ID

Constructor Detail

AdfDhtmlSelectOneChoicePeer

public AdfDhtmlSelectOneChoicePeer()

Renders a selectOneChoice for DHTML

Method Detail

AddEmptyOption

protected Object AddEmptyOption(Object component,
Object domElement)

Parameters:

component
domElement

Return:

Object

ComponentDisabledChanged

protected Object ComponentDisabledChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)

Parameters:

component
domElement
newValue
oldValue

Return:

Object

FindItemElementWithValue

protected Object FindItemElementWithValue(Object component,
Object itemValue)

Parameters:

component
itemValue

Return:

Object

Overrides:

AdfDhtmlSelectOneListbasePeer.FindItemElementWithValue(Object, Object)

GetComponentMode

protected Object GetComponentMode(Object component)

Protected property getter for mode property. It is implemented to avoid subclass unable to get mode property issue.

Parameters:

component

Return:

Object

GetComponentSelectItems

protected Object GetComponentSelectItems(Object component,
Object domElement)

Parameters:

component
domElement

Return:

Object

Overrides:

AdfDhtmlSelectOneListbasePeer.GetComponentSelectItems(Object, Object)

_getFocusElement

private Object _getFocusElement(Object component)

Parameters:

component

Return:

Object - the DOM element of the drop down icon in compact mode TODO This will change once we have skinning/icons on the client, since with skinning we can't guarantee this is an img element.

GetInlineEditor

protected Object GetInlineEditor(Event event)

Override to return an inline editor that edits the component's label property

Parameters:

event

-

DOM Event that triggered the inline edit

Return:

Object

Overrides:

AdfRichUIPeer.getInlineEditor(AdfUIComponent, Object)

GetItemElements

protected Object GetItemElements(Object component)

Parameters:

component

Return:

Object

Overrides:

AdfDhtmlSelectOneListbasePeer.GetItemElements(Object)

GetItemElementsParent

protected Object GetItemElementsParent(Object component)

Returns the parent of the item elements so that the item elements can be traversed

Parameters:

component

Return:

Object

Overrides:

AdfDhtmlSelectOneListbasePeer.GetItemElementsParent(Object)

GetNoteWindowAlignmentNode

protected Object GetNoteWindowAlignmentNode(Object component,
Object rootNode)

Returns the node for which to align the note help window

Parameters:

component
rootNode

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.GetNoteWindowAlignmentNode(Object, Object)

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

component mouse click event handler.

Parameters:

componentEvent

-

the component event invoked by mouse click

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.HandleComponentClick(Object)

HandleComponentFocus

protected Object HandleComponentFocus(Object componentEvent)

Parameters:

componentEvent

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.HandleComponentFocus(Object)

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

Parameters:

componentEvent

-

Key Press event - Implement keyboard support for selectOneChoice

Return:

Object

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

component mouse down event handler to popup the option list.

Parameters:

componentEvent

-

the component event invoked by mouse down

Return:

Object

HandleComponentMouseOut

protected Object HandleComponentMouseOut(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseOver

protected Object HandleComponentMouseOver(Object componentEvent)

Parameters:

componentEvent

Return:

Object

Overrides:

AdfDhtmlSelectOnePeer.HandleComponentMouseOver(Object)

HandleDomChange

protected Object HandleDomChange(Object component,
Object domEvent)

DOM change event event handler

Parameters:

component
domEvent

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

Overrides:

AdfDhtmlValuePeer.InitSubclass()

_isCompact

private Object _isCompact(Object component)

Parameters:

component

Return:

Object - whether the compact property is set to true.

LazyInitialize

protected Object LazyInitialize(Object component,
Object domElement)

We need to initialize the 'value' property before the user makes any changes so that we're not going to the peer for the 'value' property in the component.setProperty method. See explanation below. Background: 1. In component.setProperty if the old and new value of a property are equal the setProperty method returns without setting anything. This is to avoid unnecessary propertyChangeEvents. 2. We do not send down the 'value' property from the server, so the 'value' property starts out undefined. If a property is undefined then calls to get the current value will go to the peer. So initally calls to getValue() go to the peer's GetComponentValue() Issue: - Mostly component.setProperty will only be called after the user makes a change, and if the property is currently undefined the peer's property getter will be called for the 'old' value. The peer will then return the current value, which is the new changed value. - That means the 'old' value is the same as the new value, and so the property is not set (see point 1 above). - Therefore we need to initialize the 'value' property before the user makes any changes so that we're not going to the peer for the 'value' property in the component.setProperty method.

Parameters:

component
domElement

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.LazyInitialize(Object, Object)

needsFocusTargetStyleClass

public Object needsFocusTargetStyleClass()

Test if the peer needs the :focus-target stype class injected for click-to-edit. Rather then inject this for all UI components, we're only going to inject it for peers that need it due to an IE7/rtl bug when injecting style classes onto dom elements. Default is false (don't inject the style).

Return:

Object

Overrides:

AdfRichUIPeer.needsFocusTargetStyleClass()

PopupClosed

protected Object PopupClosed(Object component,
Object contentDom,
Object popupId)

Call back method called when the popup option list is closed. This is used to do clean up after close

Parameters:

component
contentDom
popupId

Return:

Object

Overrides:

AdfRichUIPeer.PopupClosed(AdfUIComponent, HTMLElement, String)

_returnToDropDown

private Object _returnToDropDown(Object component)

Parameters:

component

Return:

Object

SetDisplayValue

protected Object SetDisplayValue(Object component,
Object domElement,
Object newValue)

start: The public ver which calls the protected one , also binds the component to the peer before calling the protected version, which is smart.

Parameters:

component
domElement
newValue

Return:

Object

Overrides:

AdfDhtmlValuePeer.setDisplayValue(Object, Object)

_showPopupPanel

private Object _showPopupPanel(Object component)

Parameters:

component

Return:

Object

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