dojox/editor/plugins/PageBreak (version 1.10)

dijit/_editor/_Plugin

Summary

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

Usage

var foo = new PageBreak(args);
dijit/_editor/_Plugin
Parameter Type Description
args Object
Optional

Initial settings for any of the attributes.

See the dojox/editor/plugins/PageBreak reference documentation for more information.

Property Summary

  • _pbContentThe markup used for the pagebreak insert.
  • _unbreakableNodesThe nodes that should not allow page breaks to be inserted into them.
  • buttonPointer to dijit/form/Button or other widget (ex: dijit/form/FilteringSelect) that is added to the toolbar to control this plugin.
  • commandString like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command.
  • disabledFlag to indicate if this plugin has been disabled and should do nothing helps control button state, among other things.
  • editorPoints to the parent editor
  • iconClassPrefixThe CSS class name for the button node is formed from iconClassPrefix and command
  • useDefaultCommand

Method Summary

  • _allowBreak() Internal function to see if we should allow a page break at the document location.
  • _getAttrNames(name) Helper function for get() and set().
  • _initButton() Over-ride for creation of the resize button.
  • _insertPageBreak() Function to insert a CSS page break at the current point in the document
  • _set(name,value) Helper function to set new value for specified attribute
  • _setDisabledAttr(disabled) Function to set the plugin state and call updateState to make sure the button is updated appropriately.
  • _style() Internal function for inserting dynamic css.
  • buttonClass() Class of widget (ex: dijit.form.Button or dijit/form/FilteringSelect) that is added to the toolbar to control this plugin.
  • connect(o,f,tf) Deprecated.
  • destroy()
  • get(name) Get a property from a plugin.
  • getLabel(key) Returns the label to use for the button
  • own() Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.
  • set(name,value) Set a property on a plugin
  • setEditor(editor) Over-ride for the setting of the editor.
  • setToolbar(toolbar) Tell the plugin to add it's controller widget (often a button) to the toolbar.
  • updateState() Over-ride for button state control for disabled to work.

Properties

_pbContent
Defined by: dojox/editor/plugins/PageBreak

The markup used for the pagebreak insert.

_unbreakableNodes
Defined by: dojox/editor/plugins/PageBreak

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

button
Defined by: dijit/_editor/_Plugin

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

command
Defined by: dijit/_editor/_Plugin

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

disabled
Defined by: dijit/_editor/_Plugin

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.

editor
Defined by: dijit/_editor/_Plugin

Points to the parent editor

iconClassPrefix
Defined by: dojox/editor/plugins/PageBreak

The CSS class name for the button node is formed from iconClassPrefix and command

useDefaultCommand
Defined by: dojox/editor/plugins/PageBreak

Methods

_allowBreak()
Defined by dojox/editor/plugins/PageBreak

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

Returns:boolean
_getAttrNames(name)
Defined by dijit/_editor/_Plugin

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

Parameter Type Description
name undefined
Returns:undefined | object
_initButton()
Defined by dojox/editor/plugins/PageBreak

Over-ride for creation of the resize button.

_insertPageBreak()
Defined by dojox/editor/plugins/PageBreak

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

_set(name,value)
Defined by dijit/_editor/_Plugin

Helper function to set new value for specified attribute

Parameter Type Description
name String
value anything
_setDisabledAttr(disabled)
Defined by dijit/_editor/_Plugin

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

Parameter Type Description
disabled undefined
_style()
Defined by dojox/editor/plugins/PageBreak

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.

buttonClass()
Defined by dijit/_editor/_Plugin

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 button itself is specified directly.

connect(o,f,tf)
Defined by dijit/_editor/_Plugin

Deprecated. Use this.own() with dojo/on or dojo/aspect.instead.

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

Parameter Type Description
o undefined
f undefined
tf undefined
destroy()
Defined by dijit/_editor/_Plugin
get(name)
Defined by dijit/_editor/_Plugin

Get a property from a plugin.

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;
Parameter Type Description
name undefined

The property to get.
Returns:undefined
getLabel(key)
Defined by dijit/_editor/_Plugin

Returns the label to use for the button

Parameter Type Description
key String
Returns:undefined
own()
Defined by dijit/Destroyable

Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.

Returns:any | undefined

The array of specified handles, so you can do for example: 

var handle = this.own(on(...))[0];
set(name,value)
Defined by dijit/_editor/_Plugin

Set a property on a plugin

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)

Parameter Type Description
name attribute

The property to set.
value anything

The value to set in the property.
Returns:function | string

Set a property on a plugin

setEditor(editor)
Defined by dojox/editor/plugins/PageBreak

Over-ride for the setting of the editor.

Parameter Type Description
editor Object

The editor to configure for this plugin to use.
setToolbar(toolbar)
Defined by dijit/_editor/_Plugin

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

Parameter Type Description
toolbar dijit/Toolbar
updateState()
Defined by dojox/editor/plugins/PageBreak

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

Error in the documentation? Can’t find what you are looking for? Let us know!