This plugin provides the basis for an insert anchor dialog for the dijit.Editor
The command provided by this plugin is:
Parameter | Type | Description |
---|---|---|
args | Object |
Optional Initial settings for any of the attributes. |
See the dojox/editor/plugins/InsertAnchor reference documentation for more information.
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.
String used for templating the HTML to insert at the desired point.
The CSS class name for the button node icon.
If true, this plugin executes by calling Editor.execCommand() with the argument specified in command
.
Function to apply a style to inserted anchor tags so that they are obviously anchors.
Internal function used to figure out the full root url (no relatives) for loading images in the styles in the iframe.
Parameter | Type | Description |
---|---|---|
fullUrl | String | The full url to tear down to the base. |
Function to check the input to the dialog is valid and enable/disable set button
Function to check the values in args and 'fix' them up as needed.
Parameter | Type | Description |
---|---|---|
args | Object | Content being set. |
Content being set.
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 getting the values to set in the dropdown.
Parameter | Type | Description |
---|---|---|
a | undefined | The anchor/link to process for data for the dropdown. |
Override _Plugin._initButton() to initialize DropDownButton and TooltipDialog.
A filter to identify the 'a' tags and if they're anchors, remove the class style that shows up in the editor from them.
Parameter | Type | Description |
---|---|---|
node | undefined | The node to search from. |
The node to search from.
A filter to identify the 'a' tags and if they're anchors, apply the right style to them.
Parameter | Type | Description |
---|---|---|
node | undefined | The node to search from. |
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 |
Over-ridable function that connects tag specific events.
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 |
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. |
Over-ridable function for getting the style to apply to the anchor. The default is a dashed border with an anchor symbol.
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
Over-ride for the setting of the editor.
Parameter | Type | Description |
---|---|---|
editor | Object | The editor to configure for this plugin to use. |
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 |
Callback from the dialog when user presses "set" button.
Parameter | Type | Description |
---|---|---|
args | undefined |
Over-ride for button state control for disabled to work.
Handler for close event on the dialog
Function to define a behavior on double clicks on the element type this dialog edits to select it and pop up the editor dialog.
Parameter | Type | Description |
---|---|---|
e | Object | The double-click event. |
Handler for when the dialog is opened. If the caret is currently in a URL then populate the URL's info into the dialog.