dojox/editor/plugins/TextColor.js

• Provides:

  • dojox.editor.plugins.TextColor

• Requires:

  • dijit.TooltipDialog in common
  • dijit.form.Button in common
  • dijit._editor._Plugin in common
  • dojox.widget.ColorPicker in common
  • dojo.i18n in common

• dojox.editor.plugins._TextColorDropDown

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    A smple widget that uses/creates a dropdown with a dojox.widget.ColorPicker.  Also provides
    passthroughs to the value of the color picker and convenient hook points.

  • tags:

• dojox.editor.plugins._TextColorDropDown.templateString

  • type

    String

  • summary

    The template used to create the ColorPicker.

• dojox.editor.plugins._TextColorDropDown.widgetsInTemplate

  • type

    Boolean

  • summary

    Flag denoting widgets are contained in the template.

• dojox.editor.plugins._TextColorDropDown.constructor

  • constructor - constructor
  • type

    Function

  • summary

    Constructor over-ride so that the translated strings are mixsed in so
    the template fills out.

• dojox.editor.plugins._TextColorDropDown.startup

  • summary

    Over-ride of startup to do the basic connect setups and such.

  • type

    Function

• dojox.editor.plugins._TextColorDropDown._setValueAttr

  • parameters:
    • value: (typeof String)

      The value to set in the color picker

    • priorityChange: (typeof Value)

      to indicate whether or not to trigger an onChange event.

  • summary

    Passthrough function for the color picker value.

  • type

    Function

• dojox.editor.plugins._TextColorDropDown._getValueAttr

  • summary

    Passthrough function for the color picker value.

  • type

    Function

• dojox.editor.plugins._TextColorDropDown.onChange

  • parameters:
    • value: (typeof String)

      The value from the color picker.

  • summary

    Hook point to get the value when the color picker value is selected.

  • type

    Function

• dojox.editor.plugins._TextColorDropDown.onCancel

  • summary

    Hook point to get when the dialog is canceled.

  • type

    Function

• dojox.editor.plugins.TextColor

  • type

    Function

  • chains:
    • dijit._editor._Plugin: (prototype)
    • dijit._editor._Plugin: (call)
  • summary

    This plugin provides dropdown color pickers for setting text color and background color
    and makes use of the nicer-looking (though not entirely accessible), dojox.widget.ColorPicker.

  • description

    The commands provided by this plugin are:
    * foreColor - sets the text color
    * hiliteColor - sets the background color

• dojox.editor.plugins.TextColor.buttonClass

  • alias - dijit.form.DropDownButton

• dojox.editor.plugins.TextColor.useDefaultCommand

  • type

    Boolean

  • summary

    False as we do not use the default editor command/click behavior.

• dojox.editor.plugins.TextColor.constructor

  • constructor - constructor
  • type

    Function

• dojox.editor.plugins.TextColor.updateState

  • summary

    Overrides _Plugin.updateState().  This updates the ColorPalette
    to show the color of the currently selected text.

  • tags:
  • type

    Function

• dojox.editor.plugins.TextColor.editor

• dojox.editor.plugins.TextColor.command

• dojox.editor.plugins.TextColor.destroy

  • summary

    Over-ride cleanup function.

  • type

    Function

• dojox.editor.plugins.TextColor._picker

  • type

    Object

• dojox.editor.plugins.TextColor.dropDown

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object