This plugin provides a simple view source capability. When view source mode is enabled, it disables all other buttons/plugins on the RTE. It also binds to the hotkey: CTRL-SHIFT-F11 for toggling ViewSource mode.
Parameter | Type | Description |
---|---|---|
args | Object |
Optional Initial settings for any of the attributes. |
See the dijit/_editor/plugins/ViewSource reference documentation for more information.
Reference to a registered fullscreen plugin so that viewSource knows how to scale.
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
String like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command.
Passed to editor.execCommand() if useDefaultCommand
is true.
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.
The CSS class name for the button node is formed from iconClassPrefix
and command
Boolean flag used to indicate if the source view should be readonly or not. Cannot be changed after initialization of the plugin. Defaults to false.
Boolean flag used to indicate if comment tags should be stripped from the document. Defaults to true.
Boolean flag used to indicate if script tags should be stripped from the document. Defaults to true.
If true, this plugin executes by calling Editor.execCommand() with the argument specified in command
.
Internal function for creating the source view area.
Internal function to perform some filtering on the HTML.
Parameter | Type | Description |
---|---|---|
html | String | The HTML to filter |
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 |
Over-ride for creation of the resize button.
Helper function to set new value for specified attribute
Parameter | Type | Description |
---|---|---|
name | String | |
value | anything |
Function to set the plugin state and call updateState to make sure the button is updated appropriately.
Parameter | Type | Description |
---|---|---|
disabled | undefined |
Function to toggle between the source and RTE views.
Parameter | Type | Description |
---|---|---|
source | boolean | Boolean value indicating if it should be in source mode or not. |
Strips out comments from the HTML used in editor.
Parameter | Type | Description |
---|---|---|
html | String | The HTML to filter |
Strips out iframe tags from the content, to avoid iframe script style injection attacks.
Parameter | Type | Description |
---|---|---|
html | String | The HTML to filter |
Strips out script tags from the HTML used in editor.
Parameter | Type | Description |
---|---|---|
html | String | The HTML to filter |
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.
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 |
Over-ride to remove the node used to correct for IE's zoom bug.
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 the label to use for the button
Parameter | Type | Description |
---|---|---|
key | String |
Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.
The array of specified handles, so you can do for example:
var handle = this.own(on(...))[0];
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. |
Set a property on a plugin
Tell the plugin which Editor it is associated with.
Parameter | Type | Description |
---|---|---|
editor | Object | The editor object to attach the print capability to. |
Internal function to set the caret in the sourceArea to 0x0
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 |
Function to allow programmatic toggling of the view.
Over-ride for button state control for disabled to work.