JavaScript API Reference for Oracle ADF Faces

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

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.AdfDhtmlChooseColorPeer

public class AdfDhtmlChooseColorPeer
extends AdfRichUIPeer

_BUTTON_EXPANDO

private static Object _BUTTON_EXPANDO

__COLOR_VALUE

static Object __COLOR_VALUE

_COLOR_VALUE_EXPANDO

private static Object _COLOR_VALUE_EXPANDO

_colorFormat

private static Object _colorFormat

_curSwatchSelectionMap

private static Object _curSwatchSelectionMap

_CUSTOM_COLOR_BTN

private static Object _CUSTOM_COLOR_BTN

_CUSTOM_DLG_DRAG_ID

private static Object _CUSTOM_DLG_DRAG_ID

_CUSTOM_PANEL

private static Object _CUSTOM_PANEL

_CUSTOM_PANEL_WRAPPER_ID

private static Object _CUSTOM_PANEL_WRAPPER_ID

_CUSTOM_ROW_ID

private static Object _CUSTOM_ROW_ID

_DEFAULT_COLOR_BTN

private static Object _DEFAULT_COLOR_BTN

_initCustomPanelHandlerClass

private static Object _initCustomPanelHandlerClass

__LAST_USED_COLOR

static Object __LAST_USED_COLOR

_LAST_USED_COLOR_BTN

private static Object _LAST_USED_COLOR_BTN

_prevSwatchSelectionMap

private static Object _prevSwatchSelectionMap

_SELECTION_NEW_SWATCH_KNOWN

private static Object _SELECTION_NEW_SWATCH_KNOWN

_SELECTION_OLD_SWATCH_KNOWN

private static Object _SELECTION_OLD_SWATCH_KNOWN

_SELECTION_PROCESSED

private static Object _SELECTION_PROCESSED

_SELECTION_SWATCHES_KNOWN

private static Object _SELECTION_SWATCHES_KNOWN

_SELECTION_UNKNOWN

private static Object _SELECTION_UNKNOWN

_selectionStateMap

private static Object _selectionStateMap

_STANDARD_SWATCH_TABLE_ID

private static Object _STANDARD_SWATCH_TABLE_ID

_SWATCH_EXPANDO

private static Object _SWATCH_EXPANDO

AdfDhtmlChooseColorPeer

public AdfDhtmlChooseColorPeer()

ComponentColorValueChanged

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

value property change handler.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer
newValue	-	the color object of new component value
oldValue	-	the color object of old component value

Return:

Object

ComponentCustomColorDataChanged

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

customColorData property change handler.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer
newValue	-	the array of new color objects for custom color data
oldValue	-	the array of old color objects for custom color data

Return:

Object

ComponentDefaultColorChanged

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

defaultColor property change handler.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer
newValue	-	the color object of new default Color
oldValue	-	the color object of old default Color

Return:

Object

ComponentLastUsedColorChanged

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

lastUsedColor property change handler.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer
newValue	-	the color object of new Last Used Color
oldValue	-	the color object of old Last Used Color

Return:

Object

_convertToColorObj

private static Object _convertToColorObj(Object colorString)

Parameters:

colorString

-

the Color string in format #RRGGBB to convert from

Return:

Object - the Color object obtained by calling TrColorConverter.getAsObject() null if colorString is null

_convertToColorString

private static String _convertToColorString(Object colorObj)

Parameters:

colorObj

-

the Color object to convert from

Return:

String - the color string in #RRGGBB format that represent the colorObj.

_findSwatchByColor

private Object _findSwatchByColor(Object component,
                                  Object colorToMatch,
                                  Object selected)

Parameters:

component	-	the chooseColor component
colorToMatch	-	color object to be matched, null if transparent
selected	-	True if the swatch has known/selected state. False if matching the swatch by color, e.g. this happens when users enter color value in text field instead of picking from the grid. This flag is used for the purpose of looking up the right node as well as performance reason.

Return:

Object - color swatch DOM element that matches colorToMatch value null if the matched color is not in the list of custom color data.

_findSwatchFromColorPalette

private Object _findSwatchFromColorPalette(Object component,
                                           Object colorToMatch,
                                           Object selected)

Look up the swatches in color palette

Parameters:

component	-	the chooseColor component
colorToMatch	-	the string of color to be matched
selected	-	True if the swatch has known/selected state. False if matching the swatch by color, e.g. this happens when users enter color value in text field instead of picking from the grid. This flag is used for the purpose of looking up the right node as well as performance reason.

Return:

Object - color swatch DOM element that matches colorToMatch value

_findSwatchFromCustomRow

private Object _findSwatchFromCustomRow(Object component,
                                        Object colorToMatch)

Look up the swatches in custom row

Parameters:

component	-	the chooseColor component
colorToMatch	-	the string of color to match

Return:

Object - color swatch DOM element that matches colorToMatch value null if the matched color is not in the list of custom color data.

_getColorArrayFromSwatchRow

private Array _getColorArrayFromSwatchRow(Object component,
                                          Object rowElement)

Retrieve color values from the color cell of a given color row.

Parameters:

component	-	the AdfRichChooseColor component
rowElement	-	the TR DOM element of the color row

Return:

Array - the array of color strings in form of #RRGGBB (null if transparent)

_getColorFromSwatch

private Object _getColorFromSwatch(Object swatch)

Parameters:

swatch

-

the DOM of a color swatch cell.

Return:

Object - color value in the form of #RRGGBB, null if transparent

GetComponentColorData

protected Array GetComponentColorData(Object component,
                                      Object domElement)

colorData property getter.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer

Return:

Array - the array of color objects (null if transparent). The return value is never null.

GetComponentCustomColorData

protected Array GetComponentCustomColorData(Object component,
                                            Object domElement)

customColorData property getter.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer

Return:

Array - the array of color strings in form of #RRGGBB (null if transparent). The return value is null if custom row is hidden.

GetComponentDefaultColor

protected Object GetComponentDefaultColor(Object component,
                                          Object domElement)

defaultColor property getter.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer

Return:

Object - the default color value in the form of #RRGGBB, null if transparent

GetComponentLastUsedColor

protected Object GetComponentLastUsedColor(Object component,
                                           Object domElement)

lastUsedColor property getter.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer

Return:

Object - the lastUsedColor value in form of #RRGGBB, null if transparent

GetComponentWidth

protected Object GetComponentWidth(Object component,
                                   Object domElement)

width property getter.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer

Return:

Object - the with property value

_getCurrentSelection

private HTMLElement _getCurrentSelection(String clientId)

Get currently selected swatch

Parameters:

clientId

-

the client id of AdfRichChooseColor component

Return:

HTMLElement - DOM element of currently selected swatch

_getCustomColorRowId

private String _getCustomColorRowId(Object component)

Parameters:

component

-

the AdfRichChooseColor component

Return:

String - the custom row id

_getPrevSelection

private HTMLElement _getPrevSelection(String clientId)

Get previously selected swatch

Parameters:

clientId

-

the client id of AdfRichChooseColor component

Return:

HTMLElement - DOM element of previously selected swatch

_getSelectionState

private Number _getSelectionState(String clientId)

Get selection state of selecting swatch.

Parameters:

clientId

-

the client id of AdfRichChooseColor component

Return:

Number - the state of proessing swatch selection (integer value 0 to 4)

_getSwatchRows

private Object _getSwatchRows(Object component)

Returns the array of row elements for the swatch

Parameters:

component

Return:

Object

_handleArrowKeys

private Object _handleArrowKeys(Object element,
                                Object key)

Change focus element as user presses supported keys, such as arrow up/down/right/left.

Parameters:

element	-	the current element with focus
key	-	the pressed key

Return:

Object

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

component mouse click event handler.

Parameters:

componentEvent

-

the component event invoked by mouse click, incuding mouse down on the custom color dialog

Return:

Object

HandleComponentDialog

protected Object HandleComponentDialog(Object componentEvent)

Handles the custom color component dialog This happens even before PopupClosed and is to set component value and hide custom popup and then set the focus to input field if exist.

Parameters:

componentEvent

-

the component event invoked as users close select custom color popup.

Return:

Object

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

component keyboard down event handler - handle arrow keys. This is handled here instead of keyUp, in order to return false and avoid bonus scrolling. See bug 6016042

Parameters:

componentEvent

-

the component event invoked by key down

Return:

Object

HandleComponentKeyUp

protected Object HandleComponentKeyUp(Object componentEvent)

component keyboard up event handler.

Parameters:

componentEvent

-

the component event invoked by key up, incuding key up on the custom color dialog

Return:

Object

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

component mouse down event handler.

Parameters:

componentEvent

-

the component event invoked by mouse down, incuding mouse down on the custom color dialog

Return:

Object

handleUpdateFromInputComponent

public Object handleUpdateFromInputComponent(Object chooseComponent,
                                             Object propertyName,
                                             Object newValue)

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

Parameters:

chooseComponent	-	the choose component to update
propertyName	-	the name of the property to update.
newValue	-	the new value of the properties.

Return:

Object

_initCustomPanelHandlerClass

private static Object _initCustomPanelHandlerClass(Object rgbOriginalColor,
                                                   Object clientId,
                                                   Object callPeer)

Initialized the inner class, _CustomPanelHandler which handles all custom color dialog events and processing

Parameters:

rgbOriginalColor
clientId
callPeer

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()

Initialize static variables, component event handlers, property change handlers, client side getters, specify PPR supressed properties, and initialize inner class _CustomPanelHandler for custom color dialog handling.

Return:

Object

_initSwatchSelectionHandlerClass

private static Object _initSwatchSelectionHandlerClass(Object clientId,
                                                       Object swatchElement)

The inner and internally used class in AdfDhtmlChooseColorPeer. This class has three map objects, _prevSwatchSelectionMap, _curSwatchSelectionMap and _selectionStateMap which are used to keep track of swatch selection in the color palette and processed state. And they all use clientId of chooseColor component as a key in case there are multiple chooseColor components defined in the page.
Initialized the inner class, _SwatchSelectionHandler which stores the information of swatch selection and processing state

Parameters:

clientId
swatchElement

Return:

Object

_insertNewCustomColor

private Object _insertNewCustomColor(Object component,
                                     Object domElement,
                                     Object newColor)

inserts new color value into custom color.

Parameters:

component	-	the AdfRichChooseColor component
domElement	-	Root DOM element of this peer
newColor	-	the new color to add in

Return:

Object

_isCustomDialogOpen

private Object _isCustomDialogOpen()

Returns {Boolean} if the select custom color popup is open

Return:

Object

_isSwatch

private Object _isSwatch(Object element)

Returns {Boolean} if the component is a swatch node

Parameters:

element

Return:

Object

_isSwatchOrTableCell

private Object _isSwatchOrTableCell(Object element)

Returns {Boolean} if the component is a swatch node or the table cell containing swatch This is used when user is clicking on the color table, to allow more leniency in selection

Parameters:

element

Return:

Object

parse0To255

public static Object parse0To255(Object str)

Parameters:

str

-

a decimal string of RGB value

Return:

Object - the integer of value 0 to 255 if str is a valid RGB string null if str doesn not represent not a valid RGB string

parseHexColor

public static Object parseHexColor(Object str)

Parameters:

str

-

a hexdecimal string of color RGB value in RRGGBB format

Return:

Object - the integer of decimal RGB value if str is a valid color string null if str doesn not represent not a valid color string

PopupClosed

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

Handles the custom dialog close event This event is to put the dialog content back to the hidden div inside the component DOM

Parameters:

component	-	the AdfRichChooseColor component
contentDom	-	the HTML content of the DOM node
popupId	-	the id of the popup

Return:

Object

Overrides:

AdfRichUIPeer.PopupClosed(AdfUIComponent, HTMLElement, String)

_selectDOMColorSwatch

private Object _selectDOMColorSwatch(Object newSelectNode,
                                     Object oldSelectNode)

Change the style of the previously selected color cell to unselected, and Change the style of the newly selected color cell to selected

Parameters:

newSelectNode	-	the IMG element of the newly selected cell
oldSelectNode	-	the IMG element of the old selected cell

Return:

Object

_setupSwatchRow

private Object _setupSwatchRow(Object component,
                               Object rowElement,
                               Object colorArray)

Assign colors to the custom swatch cells

Parameters:

component	-	the AdfRichChooseColor component
rowElement	-	the TR DOM element of custom color row
colorArray	-	the array holding new color objects

Return:

Object

_showCustomDialog

private Object _showCustomDialog(AdfUIComponent component)

Pop up the custom color dialog.

Parameters:

component

-

the AdfRichChooseColor component

Return:

Object

_updateButtonSwatch

private Object _updateButtonSwatch(Object buttonSwatchId,
                                   Object newColor)

Change the swatch color in a button

Parameters:

buttonSwatchId	-	the id of the button with swatch
newColor	-	the new Color object used as background color for the swatch on the button

Return:

Object

_updateCurrentSelection

private Object _updateCurrentSelection(Object clientId,
                                       Object swatchElement)

Update swatch node as current selection

Parameters:

clientId	-	the client id of AdfRichChooseColor component
swatchElement	-	swatch DOM element

Return:

Object

_updatePrevSelection

private Object _updatePrevSelection(Object clientId,
                                    Object swatchElement)

Update swatch as previous selection

Parameters:

clientId	-	the client id of AdfRichChooseColor component
swatchElement	-	swatch DOM element

Return:

Object

_updateSelectionState

private Object _updateSelectionState(Object clientId,
                                     Object state)

Update swatch selection state

Parameters:

clientId	-	the client id of AdfRichChooseColor component
state	-	the state of processing swatch selection

Return:

Object