OracleJavaScript API Reference for Oracle ADF Faces

 

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

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

Warning:

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

public class AdfDhtmlInputColorPeer
extends AdfDhtmlInputBasePeer



Field Summary

private static Object
_colorFormat
private static Object
_GLYPH_ID
 static Object
__LAST_USED_COLOR
private static Object
_POPUP_CHOOSECOLOR_ID
private static Object
_POPUP_WRAPPER_ID
private static Object
_SUB_ID_MAP
inputColor component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.
private static Object
_SWATCH_ID


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


Method Summary

protected Object
ComponentValueChanged(Object component, Object domElement, Object newValue, Object oldValue)
value property change handler.
private static Object
_convertToColorString(Object colorObj)
private Object
_delegatePopupChooseColorGetter(Object inputColor, Object propertyName)
This is used to delegate a chooseColor related property getter call to the popup chooseColor.
protected Object
GetComponentColorData(Object component, Object domElement)
colorData property getter.
protected Object
GetComponentCustomColorData(Object component, Object domElement)
customColorData property getter.
protected Object
GetComponentDefaultColor(Object component, Object domElement)
defaultColor property getter.
protected Object
GetComponentLastUsedColor(Object component, Object domElement)
lastUsedColor property getter.
protected Object
GetComponentWidth(Object component, Object domElement)
width property getter.
protected Object
GetInlineEditor(Event event)
Override to return an inline editor that edits the AdfDhtmlInputColorPeer's label property
protected Object
GetNoteWindowAlignmentNode(Object component, Object rootNode)
Returns the node for which to align the note help window
private Object
_getPopupChooseColor(Object inputColor)
private Object
_getRuntimeChooseColorId(Object thisComponent)
private Object
_handleColorPopup(Object component, Object componentEvent, Object bShow)
Show/hide color popup
protected Object
HandleComponentClick(Object componentEvent)
component mouse click event handler.
protected Object
HandleComponentFocus(Object componentEvent)
Component focus event handler.
protected Object
HandleComponentKeyDown(Object componentEvent)
component keyboard up event handler.
public Object
handleReturnFromChooseComponent(Object inputColorComponent, Object bHidePopup)
Once a color has been selected from the associated chooseColor, no matter whether the chooseColor is popup type or not, this method is called.
public Object
handleUpdateFromChooseComponent(Object inputColorComponent, Object propertyName, Object newValue)
Call back method called by choose component (directly called by AdfDhtmlInputChooseBindingUtils).
private Object
_hookUpChooseColor(Object clientId)
ChooseColor is associated with inputColor by registering a mapping from chooseColor id to inputColor id.
public Object
initChooseComponentValue(Object inputComponent)
Called to initialize the properties of the associated chooseColor
protected Object
InitDomElement(Object component, Object domElement)
Initialize the associated domElement when the peer is created.
protected static Object
InitSubclass()
private Object
_isChooseColorPopupVisible(Object component)
private Object
_isCompact(Object component)
private Object
_isGlyphElement(Object eventTarget, Object glyphId)
protected Object
PopupClosed(Object component, Object contentDom, Object popupId)
Call back method called when the popup chooseColor is closed.
public Object
returnFocus(Object inputColorComponent)
Hide the popup chooseColor and move focus back to the input field
protected Object
SetDisplayValue(Object component, Object domElement, Object newValue)
set the display string
protected Object
ShouldShowHint(Object component, Object domElement)
Show hint in note window for this component.
private Object
_showPopupChooseColor(Object component, Object popupContentId, Object arrowId)
Popup the chooseColor.
private Object
_updateSwatchDisplay(Object component, Object newValue)
Update the swatch color
protected Object
VetoShowNoteWindow(Object component)


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

GetSubmittedValue, HandleComponentBlur, RunValidation, __simulateBlur, VetoBlurValidation


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

autoSubmit, BindToComponent, __componentLabelChanged, ComponentSubmittedValueChanged, ComponentTextChanged, Focus, GetComponentLabel, GetComponentSubmittedValue, GetComponentValue, GetContentNode, GetContentNodeId, GetDisplayValue, GetNoteWindowAlignmentHint, GetValidatorHints, HandleComponentKeyUp, HideNoteWindow, IsInitialized, IsNoteWindowVisible, LazyInitialize, 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, 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, GetRichResourceURL, getSubIdDomElement, GetSubIdDomElement, hideAllPopups, hidePopup, Init, 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, 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


_colorFormat

private static Object _colorFormat

_GLYPH_ID

private static Object _GLYPH_ID

__LAST_USED_COLOR

static Object __LAST_USED_COLOR

_POPUP_CHOOSECOLOR_ID

private static Object _POPUP_CHOOSECOLOR_ID

_POPUP_WRAPPER_ID

private static Object _POPUP_WRAPPER_ID

_SUB_ID_MAP

private static Object _SUB_ID_MAP

inputColor component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [content --> content] - inputColor content

_SWATCH_ID

private static Object _SWATCH_ID

Constructor Detail


AdfDhtmlInputColorPeer

public AdfDhtmlInputColorPeer()

Method Detail


ComponentValueChanged

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

value property change handler.

Parameters:
component  -  the AdfRichInputColor component
domElement    
newValue    
oldValue    
Return:
Object
Overrides:
AdfDhtmlValuePeer.ComponentValueChanged(Object, Object, Object, Object)

_convertToColorString

private static Object _convertToColorString(Object colorObj)

Parameters:
colorObj  -  the Color object to convert from
Return:
Object - the color string in #RRGGBB format that represent the colorObj.

_delegatePopupChooseColorGetter

private Object _delegatePopupChooseColorGetter(Object inputColor,
                                               Object propertyName)

This is used to delegate a chooseColor related property getter call to the popup chooseColor. When chooseId is NOT null, the chooseColor related property values are sent from the server and no delegation is needed. When chooseId is null, since the property values is available through the popup chooseColor DOM, the property values are not sent from server. So the client side getter of inuptColor must get the property value from the popup chooseColor using this method

Parameters:
inputColor  -  the inputColor component
propertyName    
Return:
Object - the popup chooseColor component in the passed in inputColor

GetComponentColorData

protected Object GetComponentColorData(Object component,
                                       Object domElement)

colorData property getter.

Parameters:
component  -  Component that this peer is associated with
domElement  -  Root DOM element of this peer
Return:
Object - colorData array

GetComponentCustomColorData

protected Object GetComponentCustomColorData(Object component,
                                             Object domElement)

customColorData property getter.

Parameters:
component  -  Component that this peer is associated with
domElement  -  Root DOM element of this peer
Return:
Object - customColorData array

GetComponentDefaultColor

protected Object GetComponentDefaultColor(Object component,
                                          Object domElement)

defaultColor property getter.

Parameters:
component  -  Component that this peer is associated with
domElement  -  Root DOM element of this peer
Return:
Object - the defaulColor property value

GetComponentLastUsedColor

protected Object GetComponentLastUsedColor(Object component,
                                           Object domElement)

lastUsedColor property getter.

Parameters:
component  -  Component that this peer is associated with
domElement  -  Root DOM element of this peer
Return:
Object - the lastUsedColor property value

GetComponentWidth

protected Object GetComponentWidth(Object component,
                                   Object domElement)

width property getter.

Parameters:
component  -  Component that this peer is associated with
domElement  -  Root DOM element of this peer
Return:
Object - the width property value

GetInlineEditor

protected Object GetInlineEditor(Event event)

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

Parameters:
event  -  DOM Event that triggered the inline edit
Return:
Object
Overrides:
AdfRichUIPeer.getInlineEditor(AdfUIComponent, 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)

_getPopupChooseColor

private Object _getPopupChooseColor(Object inputColor)

Parameters:
inputColor  -  the inputColor component
Return:
Object - the popup chooseColor component in the passed in inputColor

_getRuntimeChooseColorId

private Object _getRuntimeChooseColorId(Object thisComponent)

Parameters:
thisComponent    
Return:
Object - if chooseId property is present, return chooseId property. Otherwise return the popup chooseColor id of the popup is present.

_handleColorPopup

private Object _handleColorPopup(Object component,
                                 Object componentEvent,
                                 Object bShow)

Show/hide color popup

Parameters:
component  -  Component that this peer is associated with
componentEvent  -  the component event invoked by key up or mouse down
bShow  -  boolean vale used to show or hide color popup
Return:
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)

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)

component keyboard up event handler.

Parameters:
componentEvent  -  the component event invoked by key up, incuding key up on the custom color dialog
Return:
Object

handleReturnFromChooseComponent

public Object handleReturnFromChooseComponent(Object inputColorComponent,
                                              Object bHidePopup)

Once a color has been selected from the associated chooseColor, no matter whether the chooseColor is popup type or not, this method is called.

Parameters:
inputColorComponent    
bHidePopup    
Return:
Object

handleUpdateFromChooseComponent

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

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

Parameters:
inputColorComponent    
propertyName  -  the name of the property to update.
newValue  -  the new value of the properties.
Return:
Object

_hookUpChooseColor

private Object _hookUpChooseColor(Object clientId)

ChooseColor is associated with inputColor by registering a mapping from chooseColor id to inputColor id. This method does the mapping, and tries to initialize the associated chooseColor if it exists.

Parameters:
clientId    
Return:
Object

initChooseComponentValue

public Object initChooseComponentValue(Object inputComponent)

Called to initialize the properties of the associated chooseColor

Parameters:
inputComponent    
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()

_isChooseColorPopupVisible

private Object _isChooseColorPopupVisible(Object component)

Parameters:
component    
Return:
Object

_isCompact

private Object _isCompact(Object component)

Parameters:
component    
Return:
Object

_isGlyphElement

private Object _isGlyphElement(Object eventTarget,
                               Object glyphId)

Parameters:
eventTarget    
glyphId    
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.

PopupClosed

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

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

Parameters:
component    
contentDom    
popupId    
Return:
Object
Overrides:
AdfRichUIPeer.PopupClosed(AdfUIComponent, HTMLElement, String)

returnFocus

public Object returnFocus(Object inputColorComponent)

Hide the popup chooseColor and move focus back to the input field

Parameters:
inputColorComponent    
Return:
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)

ShouldShowHint

protected Object ShouldShowHint(Object component,
                                Object domElement)

Show hint in note window for this component.

Parameters:
component    
domElement    
Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.ShouldShowHint(Object, Object)

_showPopupChooseColor

private Object _showPopupChooseColor(Object component,
                                     Object popupContentId,
                                     Object arrowId)

Popup the chooseColor. This is called when the drop down icon is clicked.

Parameters:
component    
popupContentId    
arrowId    
Return:
Object

_updateSwatchDisplay

private Object _updateSwatchDisplay(Object component,
                                    Object newValue)

Update the swatch color

Parameters:
component    
newValue    
Return:
Object

VetoShowNoteWindow

protected Object VetoShowNoteWindow(Object component)

Parameters:
component    
Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.VetoShowNoteWindow(Object)

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

 

Generated on 2009.04.27 01:06 UTC
Copyright (c) 1998, 2008, Oracle and/or its affiliates. All rights reserved.