dojox/widget/ColorPicker.js

• Provides:

  • dojox.widget.ColorPicker

• Requires:

  • dijit.form._FormWidget in common
  • dojo.dnd.move in common
  • dojo.fx in common
  • dojox.color in common
  • dojo.i18n in common

• dojox.widget.ColorPicker

  • type

    Function

  • chains:
    • dijit.form._FormWidget: (prototype)
    • dijit.form._FormWidget: (call)
  • summary

    a HSV color picker - similar to Photoshop picker

  • description

    Provides an interactive HSV ColorPicker similar to
    PhotoShop's color selction tool. This is an enhanced
    version of the default dijit.ColorPalette, though provides
    no accessibility.

  • example

    	var picker = new dojox.widget.ColorPicker({
    		// a couple of example toggles:
    		animatePoint:false,
    		showHsv: false,
    		webSafe: false,
    		showRgb: false
    	});

  • example

    	<!-- markup: -->
    	<div dojoType="dojox.widget.ColorPicker"></div>

• dojox.widget.ColorPicker.showRgb

  • type

    Boolean

  • summary

    show/update RGB input nodes

• dojox.widget.ColorPicker.showHsv

  • type

    Boolean

  • summary

    show/update HSV input nodes

• dojox.widget.ColorPicker.showHex

  • type

    Boolean

  • summary

    show/update Hex value field

• dojox.widget.ColorPicker.webSafe

  • type

    Boolean

  • summary

    deprecated? or just use a toggle to show/hide that node, too?

• dojox.widget.ColorPicker.animatePoint

  • type

    Boolean

  • summary

    toggle to use slideTo (true) or just place the cursor (false) on click

• dojox.widget.ColorPicker.slideDuration

  • type

    Integer

  • summary

    time in ms picker node will slide to next location (non-dragging) when animatePoint=true

• dojox.widget.ColorPicker.liveUpdate

  • type

    Boolean

  • summary

    Set to true to fire onChange in an indeterminate way

• dojox.widget.ColorPicker.PICKER_HUE_H

  • type

    int

  • summary

    Height of the hue picker, used to calculate positions

• dojox.widget.ColorPicker.PICKER_SAT_VAL_H

  • type

    int

  • summary

    Height of the 2d picker, used to calculate positions

• dojox.widget.ColorPicker.PICKER_SAT_VAL_W

  • type

    int

  • summary

    Width of the 2d picker, used to calculate positions

• dojox.widget.ColorPicker.PICKER_HUE_SELECTOR_H

  • type

    int

  • summary

    Height of the hue selector DOM node, used to calc offsets so that selection
    is center of the image node.

• dojox.widget.ColorPicker.PICKER_SAT_SELECTOR_H

  • type

    int

  • summary

    Height of the saturation selector DOM node, used to calc offsets so that selection
    is center of the image node.

• dojox.widget.ColorPicker.PICKER_SAT_SELECTOR_W

  • type

    int

  • summary

    Width of the saturation selector DOM node, used to calc offsets so that selection
    is center of the image node.

• dojox.widget.ColorPicker.value

  • type

    String

  • summary

    Default color for this component. Only hex values are accepted as incoming/returned
    values. Adjust this value with <code>.attr</code>, eg: dijit.byId(&quot;myPicker&quot;).attr(&quot;value&quot;, &quot;#ededed&quot;);
    to cause the points to adjust and the values to reflect the current color.

• dojox.widget.ColorPicker._underlay

  • type

    Object

• dojox.widget.ColorPicker._hueUnderlay

  • type

    Object

• dojox.widget.ColorPicker._pickerPointer

  • type

    Object

• dojox.widget.ColorPicker._huePickerPointer

  • type

    Object

• dojox.widget.ColorPicker._huePickerPointerAlly

  • type

    Object

• dojox.widget.ColorPicker.templateString

  • type

    Object

• dojox.widget.ColorPicker.postMixInProperties

  • type

    Function

• dojox.widget.ColorPicker._uId

  • type

    Object

• dojox.widget.ColorPicker.postCreate

  • summary

    As quickly as we can, set up ie6 alpha-filter support for our
    underlay.  we don't do image handles (done in css), just the 'core'
    of this widget: the underlay.

  • type

    Function

• dojox.widget.ColorPicker.colorUnderlay.style.filter

  • type

    String

• dojox.widget.ColorPicker.colorUnderlay.src

  • type

    Object

• dojox.widget.ColorPicker.rgbNode.style.visibility

  • type

    String

• dojox.widget.ColorPicker.hsvNode.style.visibility

  • type

    String

• dojox.widget.ColorPicker.hexNode.style.visibility

  • type

    String

• dojox.widget.ColorPicker.safePreviewNode.style.visibility

  • type

    String

• dojox.widget.ColorPicker.startup

  • type

    Function

• dojox.widget.ColorPicker._started

  • type

    Object

• dojox.widget.ColorPicker._mover

  • type

    Object

• dojox.widget.ColorPicker._hueMover

  • type

    Object

• dojox.widget.ColorPicker._subs

  • type

    Array

• dojox.widget.ColorPicker._keyListeners

  • type

    Array

• dojox.widget.ColorPicker._setValueAttr

  • parameters:
    • value
  • type

    Function

• dojox.widget.ColorPicker.setColor

  • parameters:
    • color: (typeof String)
    • force
  • summary

    Set a color on a picker. Usually used to set
    initial color as an alternative to passing defaultColor option
    to the constructor.

  • type

    Function

• dojox.widget.ColorPicker._setTimer

  • parameters:
    • mover: (typeof d.dnd.Mover)
  • type

    Function

• dojox.widget.ColorPicker._timer

  • type

    Object

• dojox.widget.ColorPicker._clearTimer

  • parameters:
    • mover: (typeof d.dnd.Mover)
  • type

    Function

• dojox.widget.ColorPicker._setHue

  • parameters:
    • h: (typeof Decimal)

      0..360

  • summary

    Sets a natural color background for the
    underlay image against closest hue value (full saturation)

  • type

    Function

• dojox.widget.ColorPicker._updateHueCursorNode

  • parameters:
    • count: (typeof -1)

      means stop, anything else is just how many times it was called.

    • node: (typeof The)

      node generating the event.

    • e: (typeof The)

      event.

  • summary

    Function used by the typematic code to handle cursor position and update
    via keyboard.

  • type

    Function

• dojox.widget.ColorPicker._updateCursorNode

  • parameters:
    • count: (typeof -1)

      means stop, anything else is just how many times it was called.

    • node: (typeof The)

      node generating the event.

    • e: (typeof The)

      event.

  • summary

    Function used by the typematic code to handle cursor position and update
    via keyboard.

  • type

    Function

• dojox.widget.ColorPicker._updateColor

  • summary

    update the previewNode color, and input values [optional]

  • type

    Function

• dojox.widget.ColorPicker._colorInputChange

  • parameters:
    • e
  • summary

    updates picker position and inputs
    according to rgb, hex or hsv input changes

  • type

    Function

• dojox.widget.ColorPicker._updateValue

  • parameters:
    • col: (typeof dojox.color.Color)
    • fireChange: (typeof Boolean)
  • summary

    updates the value of the widget
    can cancel reverse onChange by specifying second param

  • type

    Function

• dojox.widget.ColorPicker.valueNode.value

• dojox.widget.ColorPicker._updatePickerLocations

  • parameters:
    • col: (typeof dojox.color.Color)
  • summary

    update handles on the pickers acording to color values

  • type

    Function

• dojox.widget.ColorPicker._updateColorInputs

  • parameters:
    • col: (typeof dojox.color.Color)
  • summary

    updates color inputs that were changed through other inputs
    or by clicking on the picker

  • type

    Function

• dojox.widget.ColorPicker.Rval.value

• dojox.widget.ColorPicker.Gval.value

• dojox.widget.ColorPicker.Bval.value

• dojox.widget.ColorPicker.Hval.value

  • type

    Object

• dojox.widget.ColorPicker.Sval.value

  • type

    Object

• dojox.widget.ColorPicker.Vval.value

  • type

    Object

• dojox.widget.ColorPicker.hexCode.value

• dojox.widget.ColorPicker.previewNode.style.backgroundColor

• dojox.widget.ColorPicker.safePreviewNode.style.backgroundColor

  • type

    Object

• dojox.widget.ColorPicker._setHuePoint

  • parameters:
    • evt: (typeof Event)
  • summary

    set the hue picker handle on relative y coordinates

  • type

    Function

• dojox.widget.ColorPicker._setPoint

  • parameters:
    • evt: (typeof Event)
  • summary

    set our picker point based on relative x/y coordinates
    evt.preventDefault();

  • type

    Function

• dojox.widget.ColorPicker._handleKey

  • parameters:
    • e: (typeof Event)
  • type

    Function

• dojox.widget.ColorPicker.focus

  • summary

    Put focus on this widget, only if focus isn't set on it already.

  • type

    Function

• dojox.widget.ColorPicker._stopDrag

  • parameters:
    • e
  • summary

    Function to hald the mouse down default
    to disable draggong of images out of the color
    picker.

  • type

    Function

• dojox.widget.ColorPicker.destroy

  • summary

    Over-ride to clean up subscriptions, etc.

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object