dijit/_editor/plugins/FontChoice.js

• Provides:

  • dijit._editor.plugins.FontChoice

• Requires:

  • dijit._editor._Plugin in common
  • dijit._editor.range in common
  • dijit._editor.selection in common
  • dijit.form.FilteringSelect in common
  • dojo.data.ItemFileReadStore in common
  • dojo.i18n in common

• dijit._editor.plugins._FontDropDown

  • type

    Function

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

    Base class for widgets that contains a label (like "Font:")
    and a FilteringSelect drop down to pick a value.
    Used as Toolbar entry.

• dijit._editor.plugins._FontDropDown.label

  • tags: public
  • type

    String

  • summary

    The label to apply to this particular FontDropDown.

• dijit._editor.plugins._FontDropDown.widgetsInTemplate

  • tags: public
  • type

    boolean

  • summary

    Over-ride denoting the template has widgets to parse.

• dijit._editor.plugins._FontDropDown.plainText

  • tags: public
  • type

    boolean

  • summary

    Flag to indicate that the returned label should be plain text
    instead of an example.

• dijit._editor.plugins._FontDropDown.templateString

  • tags: public
  • type

    String

  • summary

    The template used to construct the labeled dropdown.

• dijit._editor.plugins._FontDropDown.postMixInProperties

  • summary

    Over-ride to set specific properties.

  • type

    Function

• dijit._editor.plugins._FontDropDown.strings

  • type

    Object

• dijit._editor.plugins._FontDropDown.id

  • type

    Object

• dijit._editor.plugins._FontDropDown.selectId

  • type

    String

• dijit._editor.plugins._FontDropDown.postCreate

  • summary

    Over-ride for the default postCreate action
    This establishes the filtering selects and the like.

  • type

    Function

• dijit._editor.plugins._FontDropDown.select.store

  • type

    Object

• dijit._editor.plugins._FontDropDown.disabled

  • type

    Object

• dijit._editor.plugins._FontDropDown._setValueAttr

  • parameters:
    • value: (typeof Object|String)

      The value to set in the select.

    • priorityChange: (typeof Optional)

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

  • summary

    Over-ride for the default action of setting the
    widget value, maps the input to known values

  • type

    Function

• dijit._editor.plugins._FontDropDown.select._lastValueReported

  • type

    Object

• dijit._editor.plugins._FontDropDown._getValueAttr

  • summary

    Allow retreiving the value from the composite select on
    call to button.get("value");

  • type

    Function

• dijit._editor.plugins._FontDropDown.focus

  • summary

    Over-ride for focus control of this widget.  Delegates focus down to the
    filtering select.

  • type

    Function

• dijit._editor.plugins._FontDropDown._setDisabledAttr

  • parameters:
    • value
  • summary

    Over-ride for the button's 'disabled' attribute so that it can be
    disabled programmatically.

  • type

    Function

• dijit._editor.plugins._FontNameDropDown

  • type

    Function

  • chains:
    • dijit._editor.plugins._FontDropDown: (prototype)
    • dijit._editor.plugins._FontDropDown: (call)
  • summary

    Dropdown to select a font; goes in editor toolbar.

• dijit._editor.plugins._FontNameDropDown.generic

  • type

    Boolean

  • summary

    Use generic (web standard) font names

• dijit._editor.plugins._FontNameDropDown.command

  • tags: public
  • type

    String

  • summary

    The editor 'command' implemented by this plugin.

• dijit._editor.plugins._FontNameDropDown.postMixInProperties

  • summary

    Over-ride for the default posr mixin control

  • type

    Function

• dijit._editor.plugins._FontNameDropDown.values

  • type

    Array

• dijit._editor.plugins._FontNameDropDown.getLabel

  • parameters:
    • value: (typeof String)

      The 'insert value' associated with a name

    • name: (typeof String)

      The text name of the value

  • summary

    Function used to generate the labels of the format dropdown
    will return a formatted, or plain label based on the value
    of the plainText option.

  • type

    Function

• dijit._editor.plugins._FontNameDropDown._setValueAttr

  • parameters:
    • value
    • priorityChange
  • summary

    Over-ride for the default action of setting the
    widget value, maps the input to known values

  • type

    Function

• dijit._editor.plugins._FontSizeDropDown

  • type

    Function

  • chains:
    • dijit._editor.plugins._FontDropDown: (prototype)
    • dijit._editor.plugins._FontDropDown: (call)
  • summary

    Dropdown to select a font size; goes in editor toolbar.

• dijit._editor.plugins._FontSizeDropDown.command

  • tags: public
  • type

    String

  • summary

    The editor 'command' implemented by this plugin.

• dijit._editor.plugins._FontSizeDropDown.values

  • tags: public
  • type

    Number[]

  • summary

    The HTML font size values supported by this plugin
    
    
    sizes according to the old HTML FONT SIZE

• dijit._editor.plugins._FontSizeDropDown.getLabel

  • parameters:
    • value: (typeof String)

      The 'insert value' associated with a name

    • name: (typeof String)

      The text name of the value

  • summary

    Function used to generate the labels of the format dropdown
    will return a formatted, or plain label based on the value
    of the plainText option.
    We're stuck using the deprecated FONT tag to correspond
    with the size measurements used by the editor

  • type

    Function

• dijit._editor.plugins._FontSizeDropDown._setValueAttr

  • parameters:
    • value
    • priorityChange
  • summary

    Over-ride for the default action of setting the
    widget value, maps the input to known values

  • type

    Function

• dijit._editor.plugins._FormatBlockDropDown

  • type

    Function

  • chains:
    • dijit._editor.plugins._FontDropDown: (prototype)
    • dijit._editor.plugins._FontDropDown: (call)
  • summary

    Dropdown to select a format (like paragraph or heading); goes in editor toolbar.

• dijit._editor.plugins._FormatBlockDropDown.command

  • tags: public
  • type

    String

  • summary

    The editor 'command' implemented by this plugin.

• dijit._editor.plugins._FormatBlockDropDown.values

  • tags: public
  • type

    Array

  • summary

    The HTML format tags supported by this plugin

• dijit._editor.plugins._FormatBlockDropDown.postCreate

  • type

    Function

• dijit._editor.plugins._FormatBlockDropDown.getLabel

  • parameters:
    • value: (typeof String)

      The 'insert value' associated with a name

    • name: (typeof String)

      The text name of the value

  • summary

    Function used to generate the labels of the format dropdown
    will return a formatted, or plain label based on the value
    of the plainText option.

  • type

    Function

• dijit._editor.plugins._FormatBlockDropDown._execCommand

  • parameters:
    • editor
    • command
    • choice
  • summary

    Over-ride for default exec-command label.
    Allows us to treat 'none' as special.

  • type

    Function

• dijit._editor.plugins._FormatBlockDropDown._removeFormat

  • parameters:
    • editor
    • node: (typeof The)

      block format node to remove (and leave the contents behind)

  • summary

    function to remove the block format node.

  • type

    Function

• dijit._editor.plugins.FontChoice

  • type

    Function

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

    This plugin provides three drop downs for setting style in the editor
    (font, font size, and format block), as controlled by command.

  • description

    The commands provided by this plugin are:
    
    * fontName
    		Provides a drop down to select from a list of font names
    * fontSize
    		Provides a drop down to select from a list of font sizes
    * formatBlock
    		Provides a drop down to select from a list of block styles
    
    
    which can easily be added to an editor by including one or more of the above commands
    in the `plugins` attribute as follows:
    
    	plugins="['fontName','fontSize',...]"
    
    It is possible to override the default dropdown list by providing an Array for the `custom` property when
    instantiating this plugin, e.g.
    
    	plugins="[{name:'dijit._editor.plugins.FontChoice', command:'fontName', custom:['Verdana','Myriad','Garamond']},...]"
    
    Alternatively, for `fontName` only, `generic:true` may be specified to provide a dropdown with
    [CSS generic font families](http://www.w3.org/TR/REC-CSS2/fonts.html#generic-font-families)
    
    Note that the editor is often unable to properly handle font styling information defined outside
    the context of the current editor instance, such as pre-populated HTML.

• dijit._editor.plugins.FontChoice.useDefaultCommand

  • tags:
  • type

    booleam

  • summary

    Override _Plugin.useDefaultCommand...
    processing is handled by this plugin, not by dijit.Editor.

• dijit._editor.plugins.FontChoice._initButton

  • summary

    Overrides _Plugin._initButton(), to initialize the FilteringSelect+label in toolbar,
    rather than a simple button.

  • tags:
  • type

    Function

• dijit._editor.plugins.FontChoice.params

• dijit._editor.plugins.FontChoice.params.values

• dijit._editor.plugins.FontChoice.editor

• dijit._editor.plugins.FontChoice.button

  • type

    Object

• dijit._editor.plugins.FontChoice.updateState

  • summary

    Overrides _Plugin.updateState().  This controls updating the menu
    options to the right values on state changes in the document (that trigger a
    test of the actions.)
    It set value of drop down in toolbar to reflect font/font size/format block
    of text at current caret position.

  • tags:
  • type

    Function

• dijit._editor.plugins.FontChoice.command

• dijit._editor.plugins

  • type

    Object

• dijit._editor

  • type

    Object

• dijit

  • type

    Object