dojox/editor/plugins/PageBreak.js

• Provides:

  • dojox.editor.plugins.PageBreak

• Requires:

  • dijit._editor.html in common
  • dijit._editor._Plugin in common
  • dojo.i18n in common

• dojox.editor.plugins.PageBreak

  • type

    Function

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

    This plugin provides a simple CSS page break plugin that
    lets you insert browser pring recognizable page breaks in
    the document.
    This plugin registers the hotkey command: CTRL-SHIFT-ENTER

• dojox.editor.plugins.PageBreak.useDefaultCommand

  • type

    bool

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

  • tags:
  • type

    Array

  • summary

    The nodes that should not allow page breaks to be inserted into them.

• dojox.editor.plugins.PageBreak._pbContent

  • tags:
  • type

    String

  • summary

    The markup used for the pagebreak insert.

• dojox.editor.plugins.PageBreak._initButton

  • summary

    Over-ride for creation of the resize button.

  • type

    Function

• dojox.editor.plugins.PageBreak.editor

• dojox.editor.plugins.PageBreak.button

  • type

    Object

• dojox.editor.plugins.PageBreak.updateState

  • summary

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

  • type

    Function

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

  • type

    Object

  • summary

    The editor to configure for this plugin to use.

• dojox.editor.plugins.PageBreak._style

  • summary

    Internal function for inserting dynamic css.  This was originally
    in an editor.onLoadDeferred, but I ran into issues in Chrome with
    the tag being ignored.  Having it done at insert worked better.

  • tags:
  • type

    Function

• dojox.editor.plugins.PageBreak._styled

  • type

    Object

• dojox.editor.plugins.PageBreak.editor.document

• dojox.editor.plugins.PageBreak._insertPageBreak

  • summary

    Function to insert a CSS page break at the current point in the document

  • tags:
  • type

    Function

• dojox.editor.plugins.PageBreak._allowBreak

  • summary

    Internal function to see if we should allow a page break at the document
    location.

  • tags:
  • type

    Function

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object