Class HTMLArea

Object
   |
   +--HTMLArea

class HTMLArea

This is the main AreaEdit class the manages the HTML Editors functions. If this is not a supported browser the textarea is left untouched.
Defined in htmlarea.js

See:

- HTMLArea.Config
- generate()

Field Detail

__htmlarea_id_num

Object __htmlarea_id_num

_customUndo

Object _customUndo

_editMode

Object _editMode

_htmlArea

Object _htmlArea

_mdoc

Object _mdoc

_notifyListeners

Object _notifyListeners

_textArea

Object _textArea

_timerToolbar

Object _timerToolbar

_timerUndo

Object _timerUndo

_undoPos

Object _undoPos

_undoQueue

Object _undoQueue

config

Object config

ddt

Object ddt

doctype

Object doctype

panels

<private> Object panels

plugins

Object plugins

_addClasses

<static> Object _addClasses

_blockTags

<static> Object _blockTags

blockTags

_closingTags

<static> Object _closingTags

closing tags

_lc_catalog

<static> Object _lc_catalog

_object

<static> Object _object

variable used to pass the object to the popup editor window.

_paraContainerTags

<static> Object _paraContainerTags

paragraph container tags

_removeClasses

<static> Object _removeClasses

_scripts

<static> Object _scripts

list of scripts to load during init()

addClass

<static> Object addClass

Alias these for convenience

agt

<static> Object agt

is_gecko

<static> Object is_gecko

is_ie

<static> Object is_ie

is_mac

<static> Object is_mac

is_mac_ie

<static> Object is_mac_ie

is_opera

<static> Object is_opera

is_win_ie

<static> Object is_win_ie

last_on

<static> Object last_on

maxloadattempts

<static> Object maxloadattempts

number of times to attempt loading something from the server

plugin_loadattempts

<static> Object plugin_loadattempts

list of plugin load attempts used to avoid endless loops when trying to load plugins with syntax errors.

RE_body

<static> Object RE_body

RE_doctype

<static> Object RE_doctype

RE_email

<static> Object RE_email

RE_head

<static> Object RE_head

RE_Specials

<static> Object RE_Specials

RE_tagName

<static> Object RE_tagName

RE_url

<static> Object RE_url

removeClass

<static> Object removeClass

uniq_count

<static> Object uniq_count

uniq_count

HTMLArea

HTMLArea(textarea, config)

Creates a new HTMLArea object but does not cause it to be displayed.

See:
- HTMLArea.Config
- generate()

_activeElement

Object _activeElement(sel)

_activeElement() Returns the selected element, if any. That is, the element that you have last selected in the "path" at the bottom of the editor, or a "control" (eg image)

Returns:
null | element

_addToolbar

void _addToolbar()

_addToolbar()

_ancestorsWithClasses

Object _ancestorsWithClasses(sel, tag, classes)

_clearFonts

void _clearFonts()

_clearFonts()

_comboSelected

void _comboSelected(el, txt)

_comboSelected() el is reference to the SELECT object txt is the name of the select field, as in config.toolbar

_createImplicitBlock

void _createImplicitBlock(type)

_createImplicitBlock()

_createLink

void _createLink(link)

_createLink() built-in Link handler.

_createRange

Object _createRange(sel)

_createRange() returns a range for the current selection

_createStatusBar

void _createStatusBar()

_createStatusBar()

_createToolbar

void _createToolbar()

Creates the toolbar and appends it to the _htmlarea

_createToolbar1

void _createToolbar1(editor, toolbar, tb_objects)

separate from previous createToolBar to allow dynamic change of toolbar

_editorEvent

Object _editorEvent(ev)

_editorEvent() A generic event handler for things that happen in the IFRAME's document. This function also handles key bindings.

_fillStylist

Object _fillStylist()

Fill the stylist panel with styles that may be applied to the current selection. Styles are supplied in the css_style property of the HTMLArea.Config object, which is in the format { '.className' : 'Description' } classes that are defined on a specific tag (eg 'a.email_link') are only shown in the panel when an element of that type is selected. classes that are defined with selectors/psuedoclasses (eg 'a.email_link:hover') are never shown (if you have an 'a.email_link' without the pseudoclass it will be shown of course) multiple classes (eg 'a.email_link.staff_member') are shown as a single class, and applied to the element as multiple classes (class="email_link staff_member") you may click a class name in the stylist panel to add it, and click again to remove it you may add multiple classes to any element spans will be added where no single _and_entire_ element is selected

_formatBlock

Object _formatBlock(block_format)

_formatBlock()

_fullScreen

void _fullScreen()

fullScreen makes an editor take up the full window space (and resizes when the browser is resized) the principle is the same as the "popupwindow" functionality in the original htmlArea, except this one doesn't popup a window (it just uses to positioning hackery) so it's much more reliable and much faster to switch between

_getAncestorBlock

Object _getAncestorBlock(sel)

_getAncestorBlock()

_getAncestorsClassNames

Object _getAncestorsClassNames(sel)

_getFirstAncestor

Object _getFirstAncestor(sel, types)

_getFirstAncestor() Returns the deepest ancestor of the selection that is of the current type

_getSelection

Object _getSelection()

_getSelection() returns the current selection object

_insertImage

void _insertImage(image)

_insertImage() Called when the user clicks on "InsertImage" button. If an image is already there, it will just modify it's properties.

_insertTable

void _insertTable()

_insertTable() Called when the user clicks the Insert Table button

_popupDialog

void _popupDialog(url, action, init)

_popupDialog() modal dialogs for Mozilla (for IE we're using the showModalDialog() call). receives an URL to the popup dialog and a function that receives one value; this function will get called after the dialog is closed, with the return value of the dialog.

_selectionEmpty

Object _selectionEmpty(sel)

_selectionEmpty()

_setConfig

void _setConfig(config)

_setConfig()

_splitBlock

void _splitBlock()

_splitBlock()

_stylistAddClasses

void _stylistAddClasses(el, tag, classes)

Add the given classes (space seperated list) to the currently selected element (will add a span if none selected)

_stylistRemoveClasses

void _stylistRemoveClasses(classes, from)

Remove the given classes (space seperated list) from the given elements (array of elements)

_stylistRemoveClassesFull

void _stylistRemoveClassesFull(el, classes)

_superClean

Object _superClean(opts, obj)

superClean combines HTMLTidy, Word Cleaning and font stripping into a single function it works a bit differently in how it asks for parameters

_toggleBorders

Object _toggleBorders()

_toggleBorders() Use some CSS trickery to toggle borders on tables

_undoTakeSnapshot

void _undoTakeSnapshot()

takes an undo snapshot takes a snapshot of the current text (for undo)

_wordClean

void _wordClean()

wordclean - clean out MS Word tags?

activateEditor

void activateEditor()

activateEditor

addPanel

Object addPanel(side)

addPanel

convertNode

Object convertNode(el, newTagName)

convertNode()

deactivateEditor

void deactivateEditor()

deactivateEditor()

debugTree

void debugTree()

debugTree

Deprecated

disableToolbar

void disableToolbar(except)

disableToolbar()

dom_checkBackspace

void dom_checkBackspace()

dom_checkBackspace()

dom_checkInsertP

void dom_checkInsertP()

dom_checkInsertP() The idea here is 1. See if we are in a block element 2. If we are not, then wrap the current "block" of text into a paragraph 3. Now that we have a block element, select all the text between the insertion point and just AFTER the end of the block eg

The quick |brown fox jumped over the lazy dog.

| --------------------------------------- 4. Extract that from the document, making

The quick

and a document fragment with

brown fox jumped over the lazy dog.

5. Reinsert it just after the block element

The quick

brown fox jumped over the lazy dog.

Along the way, allow inserting blank paragraphs, which will look like

enableToolbar

void enableToolbar()

enableToolbar()

execCommand

Object execCommand(cmdID, UI, param)

execCommand() the execCommand function (intercepts some commands and replaces them with our own implementation)

fixRelativeLinks

Object fixRelativeLinks(html)

fixRelativeLinks() applies some optional regex's to html source.

See:
- HTML.Config

focusEditor

Object focusEditor()

focusEditor() focuses the iframe window. returns a reference to the editor document.

forceRedraw

void forceRedraw()

forceRedraw()

generate

Object generate()

Completes the setup of the HTMLArea object and replaces the textarea with it.

See:
- HTMLArea

getAllAncestors

Object getAllAncestors()

getAllAncestors() Returns an array with all the ancestor nodes of the selection.

getInnerHTML

Object getInnerHTML()

getInnerHTML() retrieve the HTML (fastest version, but uses innerHTML)

getInnerSize

Object getInnerSize()

Size of the htmlArea according to the available space Width and Height include toolbar!

getParentElement

Object getParentElement(sel)

getParentElement() Returns the deepest node that contains both endpoints of the selection.

getSelectedHTML

Object getSelectedHTML()

Retrieve the selected block

hasSelectedText

Object hasSelectedText()

hasSelectedText() Return true if we have some selection

hidePanel

void hidePanel(panel)

hidePanel

hidePanels

void hidePanels(sides)

hidePanels

ie_checkBackspace

Object ie_checkBackspace()

ie_checkBackspace()

imgURL

Object imgURL(file, plugin)

imgURL()

initIframe

Object initIframe()

initFrame

See:
- HTMLArea.prototype.generate()

insertHTML

void insertHTML(html)

insertHTML() Call this function to insert HTML code at the current position. It deletes the selection, if any.

insertNodeAtSelection

Object insertNodeAtSelection(toBeInserted)

insertNodeAtSelection() Returns a node after which we can insert other nodes, in the current selection. The selection is removed. It splits a text node, if needed.

inwardHtml

Object inwardHtml(html)

inwardHtml() process HTML links and other special replacements.

inwardSpecialReplacements

Object inwardSpecialReplacements(html)

inwardSpecialReplacements()

notifyOf

void notifyOf(ev, args)

notifyOf()

notifyOn

void notifyOn(ev, fn)

notifyOn()

outwardHtml

Object outwardHtml(html)

outwardHTML() based on HTML.config.linkReplacementMode setting. fullyqualified or absolute.

outwardSpecialReplacements

Object outwardSpecialReplacements(html)

outwardSpecialreplacements()

popupURL

Object popupURL(file)

popupURL()

redo

void redo()

redo()

registerPanel

void registerPanel(side, object)

registerPanel()

registerPlugin

Object registerPlugin()

registerPlugin() Create the specified plugin and register it with this HTMLArea instance. return the plugin created to allow refresh when necessary

registerPlugin2

Object registerPlugin2(plugin, args)

registerPlugin2 this is the variant of registerPlugin where the plugin arguments are already packed in an array. Externally, it should be only used in the full-screen editor code, in order to initialize plugins with the same parameters as in the opener window.

registerPlugins

void registerPlugins(plugin_names)

registerPlugins()

removePanel

void removePanel(panel)

removePanel

scrollToElement

void scrollToElement(e)

scrollToElement()

selectNodeContents

void selectNodeContents(node, pos)

selectNodeContents() Selects the contents inside the given node

setDoctype

void setDoctype(doctype)

setDoctype() sets the given doctype (useful when config.fullPage is true)

setFullHTML

Object setFullHTML(html)

setFullHTML()

setHTML

Object setHTML(html)

setHTML() completely change the HTML inside

setInnerSize

void setInnerSize(width, height)

setInnerSize

setMode

Object setMode(mode)

Switches editor mode; parameter can be "textmode" or "wysiwyg". If no parameter was passed this function toggles between modes.

showPanel

void showPanel(panel)

showPanel

showPanels

void showPanels(sides)

showPanels

stripBaseURL

Object stripBaseURL(string)

stripBaseUrl()

surroundHTML

void surroundHTML(startTag, endTag)

surroundHTML Call this function to surround the existing HTML code in the selection with your tags. FIXME: buggy! This function will be deprecated "soon".

switchElementTag

Object switchElementTag(el, tag)

Change the tag of an element

undo

void undo()

undo()

updateToolbar

void updateToolbar(noStatus)

updates enabled/disable/active state of the toolbar elements

_addClass

<static> void _addClass(el, className)

_addClass()

_addEvent

<static> void _addEvent(el, evname, func)

_addEvent()

_addEvents

<static> void _addEvents(el, evs, func)

_addEvents()

_colorToRgb

<static> Object _colorToRgb(v)

_colorToRgb() returns hexadecimal color representation from a number or a rgb-style color.

_ddt

<static> void _ddt( file, line, msg )

ddt shorthand for startup code A number of functions are called prior to HTMLArea object construction. This is a shorthand to clean up the calls in all these methods.

See:
- ddtpreproc.php

_getback

<static> void _getback(url, handler)

_getback()

_geturlcontent

<static> Object _geturlcontent(url)

_geturlcontent()

_hasClass

<static> Object _hasClass(el, className)

_hasClass()

_lc

<static> Object _lc(string, context)

Return a localised string.

Parameters:
string - English language string
context - Case sensitive context name, eg 'HTMLArea' (default), 'TableOperations'...

_loadback

<static> void _loadback(src, callback)

_loadback() load a script file in the "background" and when finished invoked a provided callback.

_loadlang

<static> Object _loadlang(context)

Load a language file. This function should not be used directly, HTMLArea._lc will use it when necessary.

Parameters:
context - Case sensitive context name, eg 'HTMLArea', 'TableOperations', ...

_makeColor

<static> Object _makeColor(v)

_makeColor() creates a rgb-style color from a number

_postback

<static> void _postback(url, data, handler)

_postback() Use XML HTTPRequest to post some data back to the server and do something with the response (asyncronously!), this is used by such things as the tidy functions

_removeClass

<static> void _removeClass(el, className)

_removeClass()

_removeEvent

<static> void _removeEvent(el, evname, func)

_removeEvent()

_removeEvents

<static> void _removeEvents(el, evs, func)

_removeEvents()

_stopEvent

<static> void _stopEvent(ev)

_stopEvent()

addClasses

<static> void addClasses(el, classes)

addClasses()

arrayContainsArray

<static> Object arrayContainsArray(a1, a2)

arrayContainsArray()

arrayFilter

<static> Object arrayFilter(a1, filterfn)

arrayFilter()

checkSupportedBrowser

<static> Object checkSupportedBrowser()

checkSupportedBrowser()

cloneObject

<static> Object cloneObject(obj)

returns a clone of the given object recurses through all the members of an object, which may contain nested objects and/or arrays, and constructs a complete copy.

collectionToArray

<static> Object collectionToArray(collection)

collectionToArray()

getElementById

<static> Object getElementById(tag, id)

getElementById() FIX: Internet Explorer returns an item having the _name_ equal to the given id, even if it's not having any id. This way it can return a different form field even if it's not a textarea. This workarounds the problem by specifically looking to search only elements having a certain tag name.

getHTML

<static> Object getHTML(root, outputRoot, editor)

getHTML() Retrieves the HTML code from the given node. This is a replacement for getting innerHTML, using standard DOM calls. Wrapper catch a Mozilla-Exception with non well formed html source code

getHTMLWrapper

<static> Object getHTMLWrapper(root, outputRoot, editor)

getHTMLWrapper() Called, for instance, when switching from wysiwyg to text mode.

getInnerText

<static> Object getInnerText(el)

getInnerText()

getPluginDir

<static> Object getPluginDir(pluginName)

getPluginDir() static function that loads the required plugin and lang file, based on the language loaded already for HTMLArea. You better make sure that the plugin _has_ that language, otherwise shit might happen ;-)

hasDisplayedChildren

<static> Object hasDisplayedChildren(el)

hasDisplayedChildren()

htmlEncode

<static> Object htmlEncode(str)

htmlEncode() performs HTML encoding of some given string

init

<static> void init()

actually does the scripts loading and fires onLoad handler Loads the scripts scheduled by loadScript(). The algorithm here puts the loadNextScript() temporary function into the onreadystatechange (for MSIE) or onLoad (for Gecko) event handler for each script it loads. Thus, when a script is completely loaded the onreadystatechange/onLoad handler is called which then loads in the next script and so forth. This makes certain that each script is completely loaded before the next one is started. HTMLArea.init() is called at the bottom of this file ( htmlarea.js - see last line of file) and as a result the HTMLArea object is not yet constructed.

See:
- loadScript()

isBlockElement

<static> Object isBlockElement(el)

isBlockElement()

isParaContainer

<static> Object isParaContainer(el)

isParaContainer()

loadPlugin

<static> Object loadPlugin(pluginName, callback)

loadPlugin - load a plugin This method is also called prior to HTMLArea object construction.

See:
- HTMLArea.loadPlugins()

loadPlugins

<static> Object loadPlugins(plugins, callbackIfNotReady)

loadPlugins This is called from the page to load in the plugin javascript files. This method is called before the HTMLArea object is constructed.

loadScript

<static> void loadScript(url, plugin)

loadScript add a script to the list of files to be loaded during init()

See:
- HTMLArea.init()

loadStyle

<static> void loadStyle(style, plugin)

loadStyle()

makeBtnImg

<static> Object makeBtnImg(imgDef, doc)

makeBtnImg()

makeEditors

<static> Object makeEditors(editor_names, default_config, plugin_names)

makeEditors()

needsClosingTag

<static> Object needsClosingTag(el)

needsClosingTag()

objectProperties

<static> Object objectProperties(obj)

objectProperties

onload

<static> void onload()

onLoad handler I'm assuming this is set to a NULL function so it can easily be overridden from the calling page. This function is called from init()

See:
- HTMLArea.init()

refreshPlugin

<static> void refreshPlugin(plugin)

refresh plugin by calling onGenerate or onGenerateOnce method.

removeClasses

<static> Object removeClasses(el, classes)

removeClasses()

replace

<static> Object replace(id, config)

Helper function: replaces the TEXTAREA with the given ID with HTMLArea.

replaceAll

<static> void replaceAll(config)

replace all TEXTAREA-s in the document with HTMLArea-s.

ripStylesFromCSSFile

<static> Object ripStylesFromCSSFile(URL)

ripStylesFromCSSString

<static> Object ripStylesFromCSSString(css)

startEditors

<static> void startEditors(editors)

startEditors() - front end to generate() loops through all editors on the page and generates each.

uniq

<static> Object uniq(prefix)

uniq()