dojox/editor/plugins/EntityPalette.js

• Provides:

  • dojox.editor.plugins.EntityPalette

• Requires:

  • dijit._Widget in common
  • dijit._Templated in common
  • dijit._PaletteMixin in common
  • dojo.i18n in common

• dojox.editor.plugins.EntityPalette

  • type

    Function

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

    A keyboard accessible HTML entity-picking widget (for inserting symbol characters)

  • description

    Grid showing various entities, so the user can pick a certain entity.
    Can be used standalone, or as a popup.

  • example

    	<div dojoType="dojox.editor.plugins.EntityPalette"></div>

  • example

    	var picker = new dojox.editor.plugins.EntityPalette({ },srcNode);
    	picker.startup();

• dojox.editor.plugins.EntityPalette.templateString

  • tags:
  • type

    String

  • summary

    The basic template used to render the palette.
    Should generally be over-ridden to define different classes.

• dojox.editor.plugins.EntityPalette.baseClass

  • type

    String

• dojox.editor.plugins.EntityPalette.showPreview

  • tags: public
  • type

    Boolean

  • summary

    Whether the preview pane will be displayed, to show details about the selected entity.

• dojox.editor.plugins.EntityPalette.showCode

  • tags: public
  • type

    boolean

  • summary

    Show the character code for the entity.

• dojox.editor.plugins.EntityPalette.showEntityName

  • type

    bool

• dojox.editor.plugins.EntityPalette.palette

  • tags: public
  • type

    String

  • summary

    The symbol pallete to display.  The only current one is 'latin'.

• dojox.editor.plugins.EntityPalette.dyeClass

  • type

    String

• dojox.editor.plugins.EntityPalette.paletteClass

  • type

    String

• dojox.editor.plugins.EntityPalette.cellClass

  • type

    String

• dojox.editor.plugins.EntityPalette.postMixInProperties

  • type

    Function

• dojox.editor.plugins.EntityPalette._palette

• dojox.editor.plugins.EntityPalette.buildRendering

  • type

    Function

• dojox.editor.plugins.EntityPalette._onCellMouseEnter

  • parameters:
    • e: (typeof The)

      event.

  • summary

    Simple function to handle updating the display at the bottom of
    the palette.

  • tags:
  • type

    Function

• dojox.editor.plugins.EntityPalette.postCreate

  • type

    Function

• dojox.editor.plugins.EntityPalette._setCurrent

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

    Called when a entity is hovered or focused.

  • description

    Removes highlight of the old entity, and highlights
    the new entity.

  • tags:
  • type

    Function

• dojox.editor.plugins.EntityPalette._displayDetails

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

    Display the details of the currently focused entity in the preview pane

  • type

    Function

• dojox.editor.plugins.EntityPalette.previewNode.innerHTML

  • type

    String

• dojox.editor.plugins.EntityPalette.codeNode.innerHTML

  • type

    String

• dojox.editor.plugins.EntityPalette.entityNode.innerHTML

  • type

    String

• dojox.editor.plugins.EntityPalette.descNode.innerHTML

  • type

    String

• dojox.editor.plugins.LatinEntity

  • type

    Function

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

    Represents a character.
    Initialized using an alias for the character (like cent) rather
    than with the character itself.

• dojox.editor.plugins.LatinEntity.constructor

  • constructor - constructor
  • type

    Function

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

    Construct JS object representing an entity (associated w/a cell
    in the palette)
    value: String
    alias name: 'cent', 'pound' ..

• dojox.editor.plugins.LatinEntity.getValue

  • summary

    Returns HTML representing the character, like &

  • type

    Function

• dojox.editor.plugins.LatinEntity.fillCell

  • parameters:
    • cell: (typeof DOMNode)
  • type

    Function

• dojox.editor.plugins.LatinEntity._alias

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object