Code Samples: HtmlEditor

The following list of commands is presented in alphabetical order. The commands may be mixed case or whatever makes your code more readable.

command	value	explanation / behavior
backcolor	????	This command will set the background color of the document.
bold	none	If there is no selection, the insertion point will set bold for subsequently typed characters. If there is a selection and all of the characters are already bold, the bold will be removed. Otherwise, all selected characters will become bold.
contentReadOnly	true false	This command will make the editor readonly (true) or editable (false). Anticipated usage is for temporarily disabling input while something else is occurring elsewhere in the web page.
copy	none	If there is a selection, this command will copy the selection to the clipboard. If there isn't a selection, nothing will happen. note: this command won't work without setting a pref or using signed JS. See: http://www.mozilla.org/editor/midasdemo/securityprefs.html note: the shortcut key will automatically trigger this command (typically accel-C) with or without the signed JS or any code on the page to handle it.
createlink	url (href)	This command will not do anything if no selection is made. If there is a selection, a link will be inserted around the selection with the url parameter as the href of the link.
cut	none	If there is a selection, this command will copy the selection to the clipboard and remove the selection from the edit control. If there isn't a selection, nothing will happen. note: this command won't work without setting a pref or using signed JS. See: http://www.mozilla.org/editor/midasdemo/securityprefs.html note: the shortcut key will automatically trigger this command (typically accel-X) with or without the signed JS or any code on the page to handle it.
decreasefontsize	none	This command will add a <small> tag around selection or at insertion point.
delete	none	This command will delete all text and objects that are selected.
fontname	????	This command will set the fontface for a selection or at the insertion point if there is no selection.
fontsize	????	This command will set the fontsize for a selection or at the insertion point if there is no selection.
forecolor	????	This command will set the text color of the selection or at the insertion point.
formatblock	<h1> <h2> <h3> <h4> <h5> <h6> <pre> <address> <p> p [this list may not be complete]
heading	<h1> <h2> <h3> <h4> <h5> <h6>
hilitecolor	????	This command will set the hilite color of the selection or at the insertion point. It only works with usecss enabled.
increasefontsize	none	This command will add a <big> tag around selection or at insertion point.
indent	none	Indent the block where the caret is located.
inserthorizontalrule	none	This command will insert a horizontal rule (line) at the insertion point. Does it delete the selection?
inserthtml	valid html string	This command will insert the given html into the <body> in place of the current selection or at the caret location.
insertimage	url (src)	This command will insert an image (referenced by url) at the insertion point. Does it delete the selection?
insertorderedlist	none
insertunorderedlist	none
insertparagraph	none
italic	none	If there is no selection, the insertion point will set italic for subsequently typed characters. If there is a selection and all of the characters are already italic, the italic will be removed. Otherwise, all selected characters will become italic.
justifycenter	none
justifyfull	none
justifyleft	none
justifyright	none
outdent	none	Outdent the block where the caret is located. If the block is not indented prior to calling outdent, nothing will happen. note: is an error thrown if no outdenting is done?
paste	none	This command will paste the contents of the clipboard at the location of the caret. If there is a selection, it will be deleted prior to the insertion of the clipboard's contents. note: this command won't work without setting a pref or using signed JS. user_pref("capability.policy.policynames", "allowclipboard"); user_pref("capability.policy.allowclipboard.Clipboard.paste", "allAccess"); See: http://www.mozilla.org/editor/midasdemo/securityprefs.html note: the shortcut key will automatically trigger this command (typically accel-V) with or without the signed JS or any code on the page to handle it.
redo	none	This command will redo the previous undo action. If undo was not the most recent action, this command will have no effect. note: the shortcut key will automatically trigger this command (typically accel-shift-Z)
removeformat	none
selectall	none	This command will select all of the contents within the editable area. note: the shortcut key will automatically trigger this command (typically accel-A)
strikethrough	none	If there is no selection, the insertion point will set strikethrough for subsequently typed characters. If there is a selection and all of the characters are already striked, the strikethrough will be removed. Otherwise, all selected characters will have a line drawn through them.
styleWithCSS	true false	This command is used for toggling the format of generated content. By default (at least today), this is true. An example of the differences is that the "bold" command will generate <b> if the styleWithCSS command is false and generate css style attribute if the styleWithCSS command is true.
subscript	none	If there is no selection, the insertion point will set subscript for subsequently typed characters. If there is a selection and all of the characters are already subscripted, the subscript will be removed. Otherwise, all selected characters will be drawn slightly lower than normal text.
superscript	none	If there is no selection, the insertion point will set superscript for subsequently typed characters. If there is a selection and all of the characters are already superscripted, the superscript will be removed. Otherwise, all selected characters will be drawn slightly higher than normal text.
underline	none	If there is no selection, the insertion point will set underline for subsequently typed characters. If there is a selection and all of the characters are already underlined, the underline will be removed. Otherwise, all selected characters will become underlined.
undo	none	This command will undo the previous action. If no action has occurred in the document, then this command will have no effect. note: the shortcut key will automatically trigger this command (typically accel-Z)
unlink	none

I am using ExtJS and I have a htmleditor in my form. I would like to add a custom button to that element (for example after all other buttons like alignments, font weights, ...). This button should basically insert a standard template in the htmlfield. Being this template html, the behaviour of the button should be like this

Switch to HTML mode (like when pressing Source button)
Insert something
Switch back to WYSIWYG mode (like when pressing the Source button again)

Ext.ns('Ext.ux.form.HtmlEditor');

Ext.ux.form.HtmlEditor.HR = Ext.extend(Ext.util.Observable, {
    init: function(cmp){
        this.cmp = cmp;
        this.cmp.on('render', this.onRender, this);
    },
    onRender: function(){
        this.cmp.getToolbar().addButton([{
            iconCls: 'x-edit-custom', //your iconCls here
            handler: function(){
                this.cmp.insertAtCursor('<hr>');
            },
            scope: this,
            tooltip: 'horizontal ruler',
            overflowText: 'horizontal ruler'
        }]);
    }
});

var w = new Ext.Window({
    width: 550,
    layout: 'fit',
    items: [{
        xtype: 'htmleditor',
        plugins: [new Ext.ux.form.HtmlEditor.HR()]
    }]
});
w.show();

But I really recommend you to see the project HtmlEditor.Plugins at google code. There you can find a lot more about adding custom buttons, for instance, how to enable/disable the buttons when something is selected, put separators, etc.
https://docs.google.com/file/d/0B5nZNPW48dpFb0hJVmpVUEphZGc/edit?usp=sharing

Pages

Sunday, May 5, 2013

ExtJS: HtmlEditor command list

ExtJS: add button to htmleditor