dojox/editor/plugins/NormalizeIndentOutdent.js

• Provides:

  • dojox.editor.plugins.NormalizeIndentOutdent

• Requires:

  • dijit._editor.selection in common
  • dijit._editor._Plugin in common

• dojox.editor.plugins.NormalizeIndentOutdent

  • type

    Function

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

    This plugin provides improved indent and outdent handling to
    the editor.  It tries to generate valid HTML, as well as be
    consistent about how it indents and outdents lists and blocks/elements.

• dojox.editor.plugins.NormalizeIndentOutdent.indentBy

  • tags: public
  • type

    number

  • summary

    The amount to indent by.  Valid values are 1+.  This is combined with
    the indentUnits parameter to determine how much to indent or outdent
    by for regular text.  It does not affect lists.

• dojox.editor.plugins.NormalizeIndentOutdent.indentUnits

  • tags: public
  • type

    String

  • summary

    The units to apply to the indent amount.  Usually 'px', but can also
    be em.

• dojox.editor.plugins.NormalizeIndentOutdent.setEditor

  • parameters:
    • editor: (typeof Object)

      The editor to configure for this plugin to use.

  • summary

    Over-ride for the setting of the editor.

  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent.editor

• dojox.editor.plugins.NormalizeIndentOutdent.setEditor.editor

  • type

    Object

  • summary

    The editor to configure for this plugin to use.

• dojox.editor.plugins.NormalizeIndentOutdent._queryCommandEnabled

  • parameters:
    • command: (typeof The)

      command passed in to check enablement.

  • summary

    An over-ride for the editor's query command enabled,
    so that we can prevent indents, etc, on bad elements
    or positions (like first element in a list).

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._indentImpl

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

    Improved implementation of indent, generates correct indent for
    ul/ol

  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._indentElement

  • parameters:
    • node: (typeof The)

      node who's content to indent.

  • returns

    Return the node that was indented.

  • summary

    Function to indent a block type tag.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._outdentElement

  • parameters:
    • node: (typeof The)

      node who's content to outdent.

  • summary

    Function to outdent a block type tag.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._outdentImpl

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

    Improved implementation of outdent, generates correct indent for
    ul/ol and other elements.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._indentList

  • parameters:
    • listItem: (typeof The)

      list item to indent.

  • summary

    Internal function to handle indenting a list element.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._outdentList

  • parameters:
    • listItem: (typeof The)

      list item to outdent.

  • summary

    Internal function to handle outdenting a list element.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._isEmpty

  • parameters:
    • node: (typeof The)

      node to check.

  • summary

    Internal function to determine if a node is 'empty'
    Eg, contains only blank text.  Used to determine if
    an empty list element should be removed or not.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._isIndentableElement

  • parameters:
    • tag: (typeof The)

      tag to check

  • summary

    Internal function to detect what element types
    are indent-controllable by us.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._convertIndent

  • parameters:
    • indent: (typeof The)

      indent amount to convert.

  • summary

    Function to convert the current indent style to
    the units we're using by some heuristic.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._isLtr

  • summary

    Function to detect if the editor body is in RTL or LTR.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent.editor.document.body

• dojox.editor.plugins.NormalizeIndentOutdent._isInlineFormat

  • parameters:
    • tag: (typeof The)

      tag to examine

  • summary

    Function to determine if the current tag is an inline
    element that does formatting, as we don't want to
    break/indent around it, as it can screw up text.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._getTagName

  • parameters:
    • node: (typeof The)

      node to look at.

  • summary

    Internal function to get the tag name of an element
    if any.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._isRootInline

  • parameters:
    • node: (typeof The)

      node to start at.

  • summary

    This functions tests whether an indicated node is in root as inline
    or rooted inline elements in the page.

  • tags:
  • type

    Function

• dojox.editor.plugins.NormalizeIndentOutdent._isTextElement

  • parameters:
    • node: (typeof The)

      node to check.

  • summary

    Helper function to check for text nodes.

  • tags:
  • type

    Function

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object