dojox/editor/plugins/ShowBlockNodes.js

• Provides:

  • dojox.editor.plugins.ShowBlockNodes

• Requires:

  • dijit._editor._Plugin in common
  • dijit.form.Button in common
  • dojo.i18n in common

• dojox.editor.plugins.ShowBlockNodes

  • type

    Function

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

    This plugin provides ShowBlockNodes cabability to the editor.  When
    clicked, the document in the editor will apply a class to specific
    block nodes to make them visible in the layout.  This info is not
    exposed/extracted when the editor value is obtained, it is purely for help
    while working on the page.

• dojox.editor.plugins.ShowBlockNodes.useDefaultCommand

  • type

    bool

• dojox.editor.plugins.ShowBlockNodes.iconClassPrefix

  • tags: const
  • type

    String

  • summary

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

• dojox.editor.plugins.ShowBlockNodes._styled

  • type

    Object

• dojox.editor.plugins.ShowBlockNodes._initButton

  • summary

    Over-ride for creation of the preview button.

  • type

    Function

• dojox.editor.plugins.ShowBlockNodes.button

  • type

    Object

• dojox.editor.plugins.ShowBlockNodes.updateState

  • summary

    Over-ride for button state control for disabled to work.

  • type

    Function

• dojox.editor.plugins.ShowBlockNodes.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.ShowBlockNodes.editor

• dojox.editor.plugins.ShowBlockNodes.setEditor.editor

  • type

    Object

  • summary

    The editor to configure for this plugin to use.

• dojox.editor.plugins.ShowBlockNodes.toggle

  • summary

    Function to allow programmatic toggling of the view.

  • type

    Function

• dojox.editor.plugins.ShowBlockNodes._showBlocks

  • parameters:
    • show
  • summary

    Function to trigger printing of the editor document

  • tags:
  • type

    Function

• dojox.editor.plugins.ShowBlockNodes.editor.document

• dojox.editor.plugins.ShowBlockNodes._calcBaseUrl

  • parameters:
    • fullUrl: (typeof String)

      The full url to tear down to the base.

  • returns

    String

  • summary

    Internal function used to figure out the full root url (no relatives)
    for loading images in the styles in the iframe.

  • tags:
  • type

    Function

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object