JavaScript API Reference for Oracle ADF Faces

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

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

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.AdfDhtmlInputBasePeer
                                       |
                                       +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlInputDatePeer

public class AdfDhtmlInputDatePeer
extends AdfDhtmlInputBasePeer

Peer for the inputDate

Field Summary

private static Object	_CHILD_EXPANDO
private static Object	_CHOOSEDATE_ID
private static Object	_GLYPH_ID
public static Object	ISO_STANDARD_CONVERTER
private static Object	_MAX_ATTR
private static Object	_MAX_ISO_ATTR
private static Object	_MIN_ATTR
private static Object	_MIN_ISO_ATTR
private static Object	_POPUP_ID
private static Object	_TIMEZONE_DISPID_ID
private static Object	_TIMEZONE_DISPNAME_ID
private static Object	_TIMEZONE_ID
private static Object	_UPDATE_FROM_CHOOSEDATE_ATTR

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

ComponentLabelChanged

Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_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

AdfDhtmlInputDatePeer() Peer for the inputDate

Method Summary

protected Object	ComponentValueChanged(Object component, Object domElement, Object newValue, Object oldValue) value property change handler.
private Object	_createClientSideValidators(Object component, Object domElement) Helper function, to create the client side validators, that are used for the attribute driven validation.
protected Object	GetComponentMaxValue(Object component, Object domElement)
protected Object	GetComponentMinValue(Object component, Object domElement)
private Object	_getGlyph(Object component) Returns the glyph for this component, if it exists.
protected Object	GetInlineEditor(Event event) Override to return an inline editor that edits the inputDate's label property
private Object	_getPopup(Object component) Returns the popup corresponding to this component, if it exists.
private String	_getPopupId(Object component) ID for the popup corresponding to this inputDate.
private Object	_getRuntimeChooseDateId(Object thisComponent)
protected Object	HandleComponentClick(Object componentEvent)
protected Object	HandleComponentDialog(Object componentEvent)
protected Object	HandleComponentFocus(Object componentEvent) Component focus event handler.
protected Object	HandleComponentKeyDown(Object componentEvent)
protected Object	HandleComponentValueChange(Object componentEvent)
public Object	handleReturnFromChooseComponent(Object inputComponent, Object hidePopup)
public Object	handleUpdateFromChooseComponent(Object inputComponent, Object propertyName, Object newValue) Call back method called by choose component (directly called by AdfDhtmlInputChooseBindingUtils).
private Object	_hidePopup(Object inputComponent)
private Object	_hookUpChooseDate(Object clientId) ChooseDate is associated with inputDate by registering a mapping from chooseDate id to inputDate id.
protected Object	InitDomElement(Object component, Object domElement) Initialize the associated domElement when the peer is created.
protected static Object	InitSubclass()
private Object	_isChooserSuppressed()
private Object	_isGlyphElement(Object eventTarget, Object glyphId)
private Object	_isPopupVisible(Object component) Whether there is a popup for this component, and if it is visible.
protected Object	IsSecret(Object component)
protected Object	LazyInitialize(Object component, Object domElement) LazyInitialize implementation that calls its super funcation and creates the client side validators lazily.
protected Object	SetDisplayValue(Object component, Object domElement, Object newValue) set the display string
Object	__trace(Object txt) Tracer method
protected Object	VetoShowNoteWindow(Object component)

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

GetSubmittedValue, HandleComponentBlur, RunValidation, ShouldShowHint, __simulateBlur, VetoBlurValidation

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, HandleComponentKeyUp, HideNoteWindow, IsInitialized, IsNoteWindowVisible, MessageNotify, MessageShow, ShowNoteWindow, ShowNoteWindowMouseOver, StashOldValue, Validate, ValidateAndStashNewValue, ValidateIfStashedOldValue, WasSubmitted

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

getConvertedObject, getConvertedValue, getFormatHint, GetNullDefault, isEmpty

Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, cancelAllPopups, cancelPopup, ChildVisibilityChanged, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, CreateDraggableNode, createPeerClass, createSubId, CreateSubId, DefaultInitClass, DispatchComponentEvent, 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, GetSubIdDomElement, hideAllPopups, hidePopup, Init, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, messageShow, needsChildVisibilityChanges, 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, initiateDrag, isVisible, needsResizeNotify

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString

Field Detail

_CHILD_EXPANDO

private static Object _CHILD_EXPANDO

_CHOOSEDATE_ID

private static Object _CHOOSEDATE_ID

_GLYPH_ID

private static Object _GLYPH_ID

ISO_STANDARD_CONVERTER

public static Object ISO_STANDARD_CONVERTER

_MAX_ATTR

private static Object _MAX_ATTR

_MAX_ISO_ATTR

private static Object _MAX_ISO_ATTR

_MIN_ATTR

private static Object _MIN_ATTR

_MIN_ISO_ATTR

private static Object _MIN_ISO_ATTR

_POPUP_ID

private static Object _POPUP_ID

_TIMEZONE_DISPID_ID

private static Object _TIMEZONE_DISPID_ID

_TIMEZONE_DISPNAME_ID

private static Object _TIMEZONE_DISPNAME_ID

_TIMEZONE_ID

private static Object _TIMEZONE_ID

_UPDATE_FROM_CHOOSEDATE_ATTR

private static Object _UPDATE_FROM_CHOOSEDATE_ATTR

Constructor Detail

AdfDhtmlInputDatePeer

public AdfDhtmlInputDatePeer()

Peer for the inputDate

Method Detail

ComponentValueChanged

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

value property change handler.

Parameters:

component	-	the AdfRichInputDate component
domElement
newValue
oldValue

Return:

Object

Overrides:

AdfDhtmlValuePeer.ComponentValueChanged(Object, Object, Object, Object)

_createClientSideValidators

private Object _createClientSideValidators(Object component,
Object domElement)

Helper function, to create the client side validators, that are used for the attribute driven validation.

Parameters:

component
domElement

Return:

Object

GetComponentMaxValue

protected Object GetComponentMaxValue(Object component,
Object domElement)

Parameters:

component
domElement

Return:

Object

GetComponentMinValue

protected Object GetComponentMinValue(Object component,
Object domElement)

Parameters:

component
domElement

Return:

Object

_getGlyph

private Object _getGlyph(Object component)

Returns the glyph for this component, if it exists.

Parameters:

component

Return:

Object - Glyph DOM element. May be null, e.g. chooseId points to embedded date-picker in the page.

GetInlineEditor

protected Object GetInlineEditor(Event event)

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

Parameters:

event

-

DOM Event that triggered the inline edit

Return:

Object

Overrides:

AdfRichUIPeer.getInlineEditor(AdfUIComponent, Object)

_getPopup

private Object _getPopup(Object component)

Returns the popup corresponding to this component, if it exists. for testing visibility, but remember to test if it is null.

Parameters:

component

Return:

Object - popup This can be null, e.g. if the inputDate has a chooseID so that it points to an embedded date-picker in the page. If testing for popup visibility, use _isPopupVisible() which calls this method.

_getPopupId

private String _getPopupId(Object component)

ID for the popup corresponding to this inputDate. Available if chooseID is not explicitly specified.

Parameters:

component

-

InputDate component to find the popup ID for

Return:

String - Element ID of the popup

_getRuntimeChooseDateId

private Object _getRuntimeChooseDateId(Object thisComponent)

Parameters:

thisComponent

-

the inputComponent to get the chooseDate id from

Return:

Object - If chooseId property is present, return chooseId property. Otherwise return the popup chooseDate id if the popup is present.

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Parameters:

componentEvent

-

Mouse click event Handles mouse click events on component, including: - Determines if note window should be displayed (true if clicking in the input field and popup not open) - Determines if the popup window should be shown (true if clicking on glyph)

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.HandleComponentClick(Object)

HandleComponentDialog

protected Object HandleComponentDialog(Object componentEvent)

Parameters:

componentEvent

-

Dialog selection event - If OK was pressed in chooseDate dialog, stores its value and hides the dialog

Return:

Object

HandleComponentFocus

protected Object HandleComponentFocus(Object componentEvent)

Component focus event handler. This gets called when the field gains focus

Parameters:

componentEvent

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.HandleComponentFocus(Object)

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

Parameters:

componentEvent

-

Key Up event Implements keyboard handling for the InputDate peer, e.g. Esc cancels the dialog

Return:

Object

HandleComponentValueChange

protected Object HandleComponentValueChange(Object componentEvent)

Parameters:

componentEvent

-

ValueChangeEvent from a child within the InputDate This occurs when a change has occured in a child component of the chooseDate. The only one we know about is the SelectOneChoice (timezone), when screen reader mode is enabled. Check if that is the source, and update the hidden field for timezoneID.

Return:

Object

handleReturnFromChooseComponent

public Object handleReturnFromChooseComponent(Object inputComponent,
Object hidePopup)

Parameters:

inputComponent	-	Input Date component being updated
hidePopup	-	Whether to close the chooseDate popup (if open) Once a date has been selected from the associated chooseDate, no matter whether the chooseDate is popup type or not, this method is called.

Return:

Object

handleUpdateFromChooseComponent

public Object handleUpdateFromChooseComponent(Object inputComponent,
Object propertyName,
Object newValue)

Call back method called by choose component (directly called by AdfDhtmlInputChooseBindingUtils).

Parameters:

inputComponent	-	the input component to update
propertyName	-	the name of the property to update.
newValue	-	the new value of the property.

Return:

Object

_hidePopup

private Object _hidePopup(Object inputComponent)

Parameters:

inputComponent

-

Client component for the inputDate Checks if the popup is open and hides it if so.

Return:

Object

_hookUpChooseDate

private Object _hookUpChooseDate(Object clientId)

ChooseDate is associated with inputDate by registering a mapping from chooseDate id to inputDate id. This method dose the mapping

Parameters:

clientId

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	-	Component that this peer will be associated with
domElement	-	Root DOM element of this peer

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

InitSubclass

protected static Object InitSubclass()

Return:

Object

Overrides:

AdfDhtmlValuePeer.InitSubclass()

_isChooserSuppressed

private Object _isChooserSuppressed()

Return:

Object - true if this InputDate has a chooser, but it is suppressed, e.g. because of screen reader mode

_isGlyphElement

private Object _isGlyphElement(Object eventTarget,
Object glyphId)

Parameters:

eventTarget	-	Event through which selection was made, e.g. click
glyphId	-	Client ID of the glyph

Return:

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

_isPopupVisible

private Object _isPopupVisible(Object component)

Whether there is a popup for this component, and if it is visible.

Parameters:

component

-

InputDate component to find the popup for

Return:

Object - true if the popup exists and is visible

IsSecret

protected Object IsSecret(Object component)

Parameters:

component

-

InputDate component Returns false, contents of inputDate do not require masking

Return:

Object

LazyInitialize

protected Object LazyInitialize(Object component,
Object domElement)

LazyInitialize implementation that calls its super funcation and creates the client side validators lazily.

Parameters:

component
domElement

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.LazyInitialize(Object, Object)

SetDisplayValue

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

set the display string

Parameters:

component
domElement
newValue	-	new string to be displayed

Return:

Object

Overrides:

AdfDhtmlValuePeer.SetDisplayValue(Object, Object, Object)

__trace

Object __trace(Object txt)

Tracer method

Parameters:

txt

Return:

Object

VetoShowNoteWindow

protected Object VetoShowNoteWindow(Object component)

Parameters:

component

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.VetoShowNoteWindow(Object)

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