API Preview tool | The Dojo Toolkit

dijit/_editor/plugins/NewPage.js

Provides:
- dijit._editor.plugins.NewPage

dijit._editor.plugins.NewPage

type
```
Function
```
chains:
- dijit._editor._Plugin: (prototype)
- dijit._editor._Plugin: (call)

summary

This plugin provides a simple 'new page' calability.  In other
words, set content to some default user defined string.

dijit._editor.plugins.NewPage.content

tags: public
type
```
String
```

summary

The default content to insert into the editor as the new page.
The default is the &lt;br&gt; tag, a single blank line.

dijit._editor.plugins.NewPage._initButton
- type
```
Function
```
- source: [view]
    var strings = dojo.i18n.getLocalization("dijit._editor", "commands"),
     editor = this.editor;
    this.button = new dijit.form.Button({
     label: strings["newPage"],
     dir: editor.dir,
     lang: editor.lang,
     showLabel: false,
     iconClass: this.iconClassPrefix + " " + this.iconClassPrefix + "NewPage",
     tabIndex: "-1",
     onClick: dojo.hitch(this, "_newPage")
    });
- summary
```
Over-ride for creation of the Print button.
```
dijit._editor.plugins.NewPage.setEditor
- type
```
Function
```
- parameters:
  - editor: (typeof dijit.Editor)
```
Object
The editor object to attach the newPage capability to.
```
- source: [view]
  this.editor = editor;
  this._initButton();
- summary
```
Tell the plugin which Editor it is associated with.
```
dijit._editor.plugins.NewPage.updateState
- type
```
Function
```
- source: [view]
  this.button.set("disabled", this.get("disabled"));
- summary
```
Over-ride for button state control for disabled to work.
```
dijit._editor.plugins.NewPage._newPage
- type
```
Function
```
- source: [view]
    this.editor.beginEditing();
    this.editor.set("value", this.content);
    this.editor.endEditing();
    this.editor.focus();
- summary
```
Function to set the content to blank.
```
- tags:
dijit._editor.plugins.NewPage.button
- summary
dijit._editor.plugins.NewPage.editor
- summary

dijit._editor.plugins.NewPage.setEditor.editor

type
```
Object
```

summary

The editor object to attach the newPage capability to.

name
- summary
o.plugin
- summary
dijit._editor.plugins
- type
```
Object
```
- summary
dijit._editor
- type
```
Object
```
- summary
dijit
- type
```
Object
```
- summary