OracleJavaScript API Reference for Oracle ADF Faces

 

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

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

Warning:

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlInputChooseBindingUtils

public class AdfDhtmlInputChooseBindingUtils
extends Object
Utility functions for communication between chooseXXX and inputXXX components. Used by AdfDhtmlChooseDatePeer, AdfDhtmlChooseColorPeer, AdfDhtmlInputColorPeer and AdfDhtmlInputDatePeer. inputXXXX component can be associated to a chooseXXX component so that their values are synchronized. Note: Using this class requires the following: 1. handleReturnFromChooseComponent(inputComponent) method must be implemented by the peer of inputXXX. 2. handleUpdateFromChooseComponent(inputComponent, inputPropertyName, propertyValue) method must be implemented by the peer of inputXXX. 3. handleUpdateFromInputComponent(chooseComponent, propertyName, newValue) needs to be implemented by the choose component.



Field Summary

private static Object
_PROPERTY_NAME


Fields inherited from org.ecmascript.object.Object

constructor, prototype


Constructor Summary

public
AdfDhtmlInputChooseBindingUtils()
Utility functions for communication between chooseXXX and inputXXX components.


Method Summary

public static Object
getChooseId(Object component)
public static Object
getInputComponent(Object chooserId)
Gets the inputXXX component bound to a chooseXXX
private static Object
_getList()
public static Object
registerBinding(Object force, Object chooserId, Object inputId)
Register a binding between an inputXXX and a chooseXXX component.
public static Object
returnToInputComponent(Object chooseComponent, Object hidePopup)
Called by the chooseXXX component to return back to input.
private static Object
_saveList(Object list)
public static Object
updateChooseComponentProperty(Object inputComponent, Object chooseId, Object inputPropertyName, Object choosePropertyName)
Called by the inputXXX component to transfer its property value to the associated chooseXXX.
public static Object
updateInputComponentProperty(Object chooseComponent, Object choosePropertyName, Object inputPropertyName, Object propertyValue)
Called by the chooseXXX component to transfer its property value to the associated inputXXX.


Field Detail


_PROPERTY_NAME

private static Object _PROPERTY_NAME

Constructor Detail


AdfDhtmlInputChooseBindingUtils

public AdfDhtmlInputChooseBindingUtils()

Utility functions for communication between chooseXXX and inputXXX components. Used by AdfDhtmlChooseDatePeer, AdfDhtmlChooseColorPeer, AdfDhtmlInputColorPeer and AdfDhtmlInputDatePeer. inputXXXX component can be associated to a chooseXXX component so that their values are synchronized. Note: Using this class requires the following: 1. handleReturnFromChooseComponent(inputComponent) method must be implemented by the peer of inputXXX. 2. handleUpdateFromChooseComponent(inputComponent, inputPropertyName, propertyValue) method must be implemented by the peer of inputXXX. 3. handleUpdateFromInputComponent(chooseComponent, propertyName, newValue) needs to be implemented by the choose component.

Method Detail


getChooseId

public static Object getChooseId(Object component)

Parameters:
component    
Return:
Object

getInputComponent

public static Object getInputComponent(Object chooserId)

Gets the inputXXX component bound to a chooseXXX

Parameters:
chooserId  -  the Id of the chooseXXX component that is bound to the inputXXX
Return:
Object - the inputXXX component

_getList

private static Object _getList()

Return:
Object

registerBinding

public static Object registerBinding(Object force,
                                     Object chooserId,
                                     Object inputId)

Register a binding between an inputXXX and a chooseXXX component.

Parameters:
force    
chooserId  -  the id of the chooseXXX component to bind with the inputXXX.
inputId  -  the id of the inputXXX component to bind with the chooseXXX.
Return:
Object

returnToInputComponent

public static Object returnToInputComponent(Object chooseComponent,
                                            Object hidePopup)

Called by the chooseXXX component to return back to input. This will invoke handleReturnFromChooseComponent method of inputXXXX component. handleReturnFromChooseComponent method may close the popup and move the focus back to inputXXX.

Parameters:
chooseComponent  -  the chooseXXX component that is bound to the inputXXX component.
hidePopup    
Return:
Object

_saveList

private static Object _saveList(Object list)

Parameters:
list    
Return:
Object

updateChooseComponentProperty

public static Object updateChooseComponentProperty(Object inputComponent,
                                                   Object chooseId,
                                                   Object inputPropertyName,
                                                   Object choosePropertyName)

Called by the inputXXX component to transfer its property value to the associated chooseXXX.

Parameters:
inputComponent  -  the inputXXX component to transfer value from.
chooseId  -  the id of the bound chooseXXX component.
inputPropertyName  -  the name of the inputXXX property to transfer
choosePropertyName  -  the name of the chooseXXX property to transfer
Return:
Object

updateInputComponentProperty

public static Object updateInputComponentProperty(Object chooseComponent,
                                                  Object choosePropertyName,
                                                  Object inputPropertyName,
                                                  Object propertyValue)

Called by the chooseXXX component to transfer its property value to the associated inputXXX. This will call handleUpdateFromChooseComponent on the inputXXX peer.

Parameters:
chooseComponent  -  the chooseXXX component the value is transferred from
choosePropertyName  -  the name of the property in chooseXXX to transfer from.
inputPropertyName  -  the name of the property in inputXXX to transfer.
propertyValue  -  if not passed in, the property value in chooseComponent will be obtained by calling getProperty() on chooseComponent, otherwise the propertyValue will be used to transfer to the inputXXX even if the propertyValue is different than the value in chooseComponent.
Return:
Object

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

 

Generated on 2012.08.25 02:16 UTC
Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.