dijit/_editor/_Plugin.js

• Provides:

  • dijit._editor._Plugin

• Requires:

  • dijit._Widget in common
  • dijit.form.Button in common

• dijit._editor._Plugin

  • type

    Function

  • parameters:
    • args: (typeof Object)
    • node: (typeof DomNode)

• dijit._editor._Plugin.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)
    • node: (typeof DomNode)

• dijit._editor._Plugin.editor

  • tags: const
  • type

    dijit.Editor

  • summary

    Points to the parent editor

• dijit._editor._Plugin.iconClassPrefix

  • tags: const
  • type

    String

  • summary

    The CSS class name for the button node is formed from <code>iconClassPrefix</code> and <code>command</code>

• dijit._editor._Plugin.button

  • optional
  • type

    dijit._Widget

  • summary

    Pointer to <code>dijit.form.Button</code> or other widget (ex: <code>dijit.form.FilteringSelect</code>)
    that is added to the toolbar to control this plugin.
    If not specified, will be created on initialization according to <code>buttonClass</code>

• dijit._editor._Plugin.command

  • type

    String

  • summary

    String like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command.
    Passed to editor.execCommand() if <code>useDefaultCommand</code> is true.

• dijit._editor._Plugin.useDefaultCommand

  • type

    Boolean

  • summary

    If true, this plugin executes by calling Editor.execCommand() with the argument specified in <code>command</code>.

• dijit._editor._Plugin.buttonClass

  • alias - dijit.form.Button
  • type

    Widget

  • summary

    Class
    Class of widget (ex: dijit.form.Button or dijit.form.FilteringSelect)
    that is added to the toolbar to control this plugin.
    This is used to instantiate the button, unless <code>button</code> itself is specified directly.

• dijit._editor._Plugin.disabled

  • type

    Boolean

  • summary

    Flag to indicate if this plugin has been disabled and should do nothing
    helps control button state, among other things.  Set via the setter api.

• dijit._editor._Plugin.getLabel

  • parameters:
    • key: (typeof String)
  • returns

    String

  • summary

    Returns the label to use for the button

  • tags:
  • type

    Function

• dijit._editor._Plugin._initButton

  • summary

    Initialize the button or other widget that will control this plugin.
    This code only works for plugins controlling built-in commands in the editor.

  • tags: extension
  • type

    Function

• dijit._editor._Plugin.destroy

  • summary

    Destroy this plugin

  • type

    Function

• dijit._editor._Plugin.connect

  • parameters:
    • o
    • f
    • tf
  • summary

    Make a dojo.connect() that is automatically disconnected when this plugin is destroyed.
    Similar to <code>dijit._Widget.connect</code>.

  • tags:
  • type

    Function

• dijit._editor._Plugin.updateState

  • summary

    Change state of the plugin to respond to events in the editor.

  • description

    This is called on meaningful events in the editor, such as change of selection
    or caret position (but not simple typing of alphanumeric keys).   It gives the
    plugin a chance to update the CSS of its button.
    
    For example, the "bold" plugin will highlight/unhighlight the bold button depending on whether the
    characters next to the caret are bold or not.
    
    Only makes sense when `useDefaultCommand` is true, as it calls Editor.queryCommandEnabled(`command`).

  • type

    Function

• dijit._editor._Plugin.enabled

• dijit._editor._Plugin.checked

• dijit._editor._Plugin.setEditor

  • parameters:
    • editor: (typeof dijit.Editor)
  • summary

    Tell the plugin which Editor it is associated with.

  • type

    Function

• dijit._editor._Plugin.button.domNode.style.display

  • type

    String

• dijit._editor._Plugin.setToolbar

  • parameters:
    • toolbar: (typeof dijit.Toolbar)
  • summary

    Tell the plugin to add it's controller widget (often a button)
    to the toolbar.  Does nothing if there is no controller widget.

  • type

    Function

• dijit._editor._Plugin.set

  • parameters:
    • name: (typeof attribute)

      The property to set.

    • value: (typeof anything)

      The value to set in the property.

  • summary

    Set a property on a plugin

  • description

    Sets named properties on a plugin which may potentially be handled by a
    setter in the plugin.
    For example, if the plugin has a properties "foo"
    and "bar" and a method named "_setFooAttr", calling:
    	plugin.set("foo", "Howdy!");
    would be equivalent to writing:
    	plugin._setFooAttr("Howdy!");
    and:
    	plugin.set("bar", 3);
    would be equivalent to writing:
    	plugin.bar = 3;
    
    set() may also be called with a hash of name/value pairs, ex:
    	plugin.set({
    		foo: "Howdy",
    		bar: 3
    	})
    This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

  • type

    Function

• dijit._editor._Plugin.get

  • parameters:
    • name: (typeof The)

      property to get.

  • summary

    Get a property from a plugin.

  • description

    Get a named property from a plugin. The property may
    potentially be retrieved via a getter method. If no getter is defined, this
    just retrieves the object's property.
    For example, if the plugin has a properties "foo"
    and "bar" and a method named "_getFooAttr", calling:
    	plugin.get("foo");
    would be equivalent to writing:
    	plugin._getFooAttr();
    and:
    	plugin.get("bar");
    would be equivalent to writing:
    	plugin.bar;

  • type

    Function

• dijit._editor._Plugin._setDisabledAttr

  • parameters:
    • disabled
  • summary

    Function to set the plugin state and call updateState to make sure the
    button is updated appropriately.

  • type

    Function

• dijit._editor._Plugin._getAttrNames

  • parameters:
    • name
  • summary

    Helper function for get() and set().
    Caches attribute name values so we don't do the string ops every time.

  • tags:
  • type

    Function

• dijit._editor._Plugin._attrPairNames

  • type

    Object

• dijit._editor._Plugin._set

  • parameters:
    • name: (typeof String)
    • value: (typeof anything)
  • summary

    Helper function to set new value for specified attribute

  • type

    Function

• dijit._editor._Plugin.params

  • type

    Object

• dijit._editor._Plugin._connects

  • type

    Array

• dijit._editor

  • type

    Object

• dijit

  • type

    Object