dijit/_PaletteMixin.js

• Provides:

  • dijit._PaletteMixin

• Requires:

  • dijit._CssStateMixin in common

• dijit._PaletteMixin

  • type

    Function

  • chains:
    • dijit._CssStateMixin: (prototype)
    • dijit._CssStateMixin: (call)
  • summary

    A keyboard accessible palette, for picking a color/emoticon/etc.

  • description

    A mixin for a grid showing various entities, so the user can pick a certain entity.

• dijit._PaletteMixin.defaultTimeout

  • type

    Number

  • summary

    Number of milliseconds before a held key or button becomes typematic

• dijit._PaletteMixin.timeoutChangeRate

  • type

    Number

  • summary

    Fraction of time used to change the typematic timer between events
    1.0 means that each typematic event fires at defaultTimeout intervals
    < 1.0 means that each typematic event fires at an increasing faster rate

• dijit._PaletteMixin.value

  • type

    String

  • summary

    Currently selected color/emoticon/etc.

• dijit._PaletteMixin._selectedCell

  • tags:
  • type

    Integer

  • summary

    Index of the currently selected cell. Initially, none selected

• dijit._PaletteMixin._currentFocus

  • tags:
  • type

    DomNode

  • summary

    The currently focused cell (if the palette itself has focus), or otherwise
    the cell to be focused when the palette itself gets focus.
    Different from value, which represents the selected (i.e. clicked) cell.

• dijit._PaletteMixin._xDim

  • tags:
  • type

    Integer

  • summary

    This is the number of cells horizontally across.

• dijit._PaletteMixin._yDim

  • tags:
  • type

    Integer

  • summary

    This is the number of cells vertically down.

• dijit._PaletteMixin.tabIndex

  • type

    String

  • summary

    Widget tab index.

• dijit._PaletteMixin.cellClass

  • tags:
  • type

    String

  • summary

    CSS class applied to each cell in the palette

• dijit._PaletteMixin.dyeClass

  • tags:
  • type

    String

  • summary

    Name of javascript class for Object created for each cell of the palette.
    dyeClass should implements dijit.Dye interface

• dijit._PaletteMixin._preparePalette

  • parameters:
    • choices: (typeof String[][])

      id's for each cell of the palette, used to create Dye JS object for each cell

    • titles: (typeof String[])

      Localized tooltip for each cell

    • dyeClassObj: (typeof Constructor)

      If specified, use this constructor rather than this.dyeClass

  • summary

    Subclass must call _preparePalette() from postCreate(), passing in the tooltip
    for each cell

  • type

    Function

• dijit._PaletteMixin._cells

  • type

    Array

• dijit._PaletteMixin._blankGif

• dijit._PaletteMixin.postCreate

  • type

    Function

• dijit._PaletteMixin.focus

  • summary

    Focus this widget.  Puts focus on the most recently focused cell.

  • type

    Function

• dijit._PaletteMixin._onCellClick

  • parameters:
    • evt: (typeof Event)

      The event.

  • summary

    Handler for click, enter key & space key. Selects the cell.

  • tags:
  • type

    Function

• dijit._PaletteMixin._setCurrent

  • parameters:
    • node: (typeof DomNode)
  • summary

    Sets which node is the focused cell.

  • description

    At any point in time there's exactly one
    cell with tabIndex != -1.   If focus is inside the palette then
    focus is on that cell.
    
    After calling this method, arrow key handlers and mouse click handlers
    should focus the cell in a setTimeout().

  • tags:
  • type

    Function

• dijit._PaletteMixin._setValueAttr

  • parameters:
    • value: (typeof String)

      value of the cell to select

    • priorityChange: (typeof Optional)

      parameter used to tell the select whether or not to fire
      onChange event.

  • summary

    This selects a cell. It triggers the onChange event.

  • tags:
  • type

    Function

• dijit._PaletteMixin.onChange

  • parameters:
    • value: (typeof String)

      Value corresponding to cell.

  • summary

    Callback when a cell is selected.

  • type

    Function

• dijit._PaletteMixin._navigateByKey

  • parameters:
    • increment: (typeof How)

      much the key is navigated.

    • typeCount: (typeof How)

      many times typematic has fired.

  • summary

    This is the callback for typematic.
    It changes the focus and the highlighed cell.

  • tags:
  • type

    Function

• dijit._PaletteMixin._getDye

  • parameters:
    • cell: (typeof DomNode)
  • summary

    Get JS object for given cell DOMNode

  • type

    Function

• dijit.Dye

  • type

    Function

  • parameters:
    • alias: (typeof String)
    • row
    • col
  • summary

    Interface for the JS Object associated with a palette cell (i.e. DOMNode)

• dijit.Dye.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • alias: (typeof String)
    • row
    • col
  • summary

    Initialize according to value or alias like "white"

• dijit.Dye.getValue

  • summary

    Return "value" of cell; meaning of "value" varies by subclass.

  • description

    For example color hex value, emoticon ascii value etc, entity hex value.

  • type

    Function

• dijit.Dye.fillCell

  • parameters:
    • cell: (typeof DomNode)

      The surrounding cell

    • blankGif: (typeof String)

      URL for blank cell image

  • summary

    Add cell DOMNode inner structure

  • type

    Function

• dijit

  • type

    Object