JavaScript API Reference for Oracle ADF Faces

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

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

public class AdfDhtmlInputNumberSpinboxPeer
extends AdfDhtmlInputNumberSpinboxBasePeer

_currentSpinMode

private static Object _currentSpinMode

_DEC

private static Object _DEC

_DEC_ID

private static Object _DEC_ID

_INC

private static Object _INC

_INC_ID

private static Object _INC_ID

_SUB_ID_MAP

private static Object _SUB_ID_MAP

inputNumberSpinbox component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [content --> content] - inputNumberSpinbox content 2. [increment --> increment] - inputNumberSpinbox increment icon 3. [decrement --> decrement] - inputNumberSpinbox decrement icon 4. [label --> label] - inputNumberSpinbox label If a subId is not contained in the map below, it's corresponding DOM is located programmatically in AdfDhtmlInputNumberSpinboxPeer.GetSubIdDomElement().

_timerId

private static Object _timerId

AdfDhtmlInputNumberSpinboxPeer

public AdfDhtmlInputNumberSpinboxPeer()

AdfDhtmlInputNumberSpinboxPeer a subclass of AdfDhtmlInputNumberSpinboxBasePeer

ComponentDisabledChanged

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

Parameters:

component
domElement
newValue
oldValue

Return:

Object

_getAnchor

private Object _getAnchor(Object node)

Get the anchor, used by the increment/decrement buttons. When using Icons, there is another DOM structure, so that we need to get the A element.

Parameters:

node

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:

AdfDhtmlValuePeer.GetBestMatchSubId(Object)

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

_getMax

private Object _getMax(Object component)

Function to calculate the maximum value on the client

Parameters:

component

Return:

Object

_getMin

private Object _getMin(Object component)

Function to calculate the minimum value on the client

Parameters:

component

Return:

Object

_getSpinboxValue

private Object _getSpinboxValue(Object component)

Helper function, that gets the visibleValue of the InputNumberSpinbox component and returns it. If a converter is attached to the component, the converted value will be returned.

Parameters:

component

Return:

Object

GetStepSize

protected Object GetStepSize(Object component)

Method to calculate the stepsize to increase or decrease the value of the Spinbox. Default implementation just returns the stepSize from the client side Spinbox component

Parameters:

component

Return:

Object

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(String subElementId)

Returns the dom element for a given subElementId.

Parameters:

subElementId

-

the id of the child dom element or component

Return:

HTMLElement - the DOM within the component related to scopedId

Overrides:

AdfDhtmlValuePeer.GetSubIdDomElement(Object)

_handleButtonClicks

private Object _handleButtonClicks(Object component,
                                   Object value,
                                   Object increase)

Controller function that handles the click of the +/- button and increases (or decreases) the value. This function is called by the _manipulateValue function.

Parameters:

component	-	the client InputNumberSpinbox component
value	-	the current value of the InputNumberSpinbox component
increase

Return:

Object

HandleComponentBlur

protected Object HandleComponentBlur(Object componentEvent)

We need to update the buttons on blur just in case the value changed

Parameters:

componentEvent

Return:

Object

Overrides:

AdfDhtmlInputBasePeer.HandleComponentBlur(Object)

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

component on click event handler used to decrease or increase the current number value

Parameters:

componentEvent

-

the event invoked by on click

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.HandleComponentClick(Object)

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

component key down event handler used to decrease or increase the current number value.

Parameters:

componentEvent

-

the event invoked by key down

Return:

Object

HandleComponentKeyPress

protected Object HandleComponentKeyPress(Object componentEvent)

Component keyboard key press event handler

Parameters:

componentEvent

-

the component event invoked by key press

Return:

Object

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

This mouse down event handler initializes the auto spin function for the spinbox, when doing a "mouse down" at the increase or decrease button. This function also creates a callback for the _initRepeat function to manage to real auto spin mechanismn.

Parameters:

componentEvent

-

the component event invoked by mouse down

Return:

Object

HandleComponentMouseOut

protected Object HandleComponentMouseOut(Object componentEvent)

This component mouse out event handler is needed to stop the timer of the auto spin, when moving the mouse away from the decrease/increas button.

Parameters:

componentEvent

-

the component event invoked by mouse out

Return:

Object

HandleComponentMouseUp

protected Object HandleComponentMouseUp(Object componentEvent)

component mouse out event handler.

Parameters:

componentEvent

-

the component event invoked by mouse out

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:

AdfDhtmlEditableValuePeer.InitDomElement(Object, Object)

_initRepeat

private Object _initRepeat()

Callback function, started by an interval. This function removes itself from the interval and starts a new one, which will only removed, by the mouseup event. That one calls a function de- or increase the spinbox by a 100 ms interval.

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.InitSubclass()

_isActionButton

private Object _isActionButton(Object element)

helper function which checks if the given element is a decrease or increase button. In case of increase it returns 'inc' and in case of a decrease button 'dec' is returned. Otherwise, this function returns null.

Parameters:

element

Return:

Object

_manipulateValue

private Object _manipulateValue(Object incrementor)

Function that is called, when the +/- buttons of the Spinbox are clicked. It first gets the visible value and pushes this to the _handleButtonClicks controller function. This function also calls the _setVisibleValue to set the new visible value and update the CSS styles for the +/ buttons, like adding p_AFDisabled when the minimum or the maximum has reached.

Parameters:

incrementor

-

true when the increase button was clicked and false when decrease button was clicked

Return:

Object

_repeatSpinbox

private Object _repeatSpinbox()

Controller for the main increment or decrement function. This method is called by the AdfObject.createCallback method.

Return:

Object

See also:

AdfObject.createCallback(Object)

_setVisibleValue

private Object _setVisibleValue(Object component,
                                Object newValue)

Function to set the new visible value of the InputNumberSpinbox component. This function calls the _updateButtons function to ensure that the propper CSS classes are applied to the +/- buttons.

Parameters:

component
newValue

Return:

Object

_updateButtons

private Object _updateButtons(Object domElement,
                              Object atMax,
                              Object atMin)

Helper function that is used to set the CSS style for the disabled and enabled states of the increase and decrease buttons. To set these style, this function uses the max/min parameters.

Parameters:

domElement	-	the rootDomElement of the spinbox, only used as param, when called by InitDomElement.
atMax	-	is the current value>=max
atMin	-	is the current value<=min

Return:

Object