Class HTMLArea.Config

Object
   |
   +--HTMLArea.Config

class HTMLArea.Config

This class manages an HTMLArea configuration.
Defined in htmlarea.js

Field Detail

baseHref

Object baseHref

specify a base href for relative links

baseURL

Object baseURL

BaseURL included in the iframe document

btn

<private> Object btn

btnList

Object btnList

cfg

<private> Object cfg

charSet

Object charSet

CharSet of the iframe, default is the charset of the document

css_style

Object css_style

Add an empty css_style to Config object's prototype the format is { '.className' : 'Description' }

cssPluginConfig

Object cssPluginConfig

customSelects

Object customSelects

custom dropdown boxes.

debug

Object debug

turns on original rudimentary debugging

editor

<private> Object editor

Custom Button List ADDING CUSTOM BUTTONS: please read below! format of the btnList elements is "ID: [ ToolTip, Icon, Enabled in text mode?, ACTION ]" - ID: unique ID for the button. If the button calls document.execCommand it's wise to give it the same name as the called command. - ACTION: function that gets called when the button is clicked. it has the following prototype: function(editor, buttonName) - editor is the HTMLArea object that triggered the call - buttonName is the ID of the clicked button These 2 parameters makes it possible for you to use the same handler for more HTMLArea objects or for more different buttons. - ToolTip: tooltip, will be translated below - Icon: path to an icon image file for the button OR; you can use an 18x18 block of a larger image by supllying an array that has three elemtents, the first is the larger image, the second is the column the third is the row. The ros and columns numbering starts at 0 but there is a header row and header column which have numbering to make life easier. See images/buttons_main.gif to see how it's done. - Enabled in text mode: if false the button gets disabled for text-only mode; otherwise enabled all the time. ---------------------------------- Old Interactivetools.com Comments- Example on how to add a custom button when you construct the HTMLArea: /**

fontname

Object fontname

fonts list for font dropdown.

fontsize

Object fontsize

fontsize dropdown

formatblock

Object formatblock

format block dropdown

fullPage

Object fullPage

retrieve full HTML? if true then HTMLArea will retrieve the full HTML, starting with the tag.

height

Object height

auto-size the height

helpURL

Object helpURL

absolute location of help file

htmlareaPaste

Object htmlareaPaste

intercept ^V? intercept ^V and use the HTMLArea paste command If false, then passes ^V through to browser editor widget

htmlRemoveTags

Object htmlRemoveTags

remove tags? (these have to be a regexp, or null if this functionality is not desired)

ImageManager

Object ImageManager

ImageManager plugin configuration default Xinha layout. plugins are beneath the Xinha directory. all plugin requests are routed through a single entry point. Note the trailing &. Makes forming our URL's easier. To change the backend, just set this config variable in the calling page. The images_url config option is used to strip out the directory info when images are selected from the document.

imgURL

Object imgURL

relative location of default editor images/buttons

killWordOnPaste

Object killWordOnPaste

set to true if you want Word code to be cleaned upon Paste

lang

Object lang

default language of the editor

lcBackend

Object lcBackend

lcBackend - localization backend.

Linker

Object Linker

linker configuration

linkReplacementMode

Object linkReplacementMode

type of URL replacements in the document - fullyqualified or absolute in inwardHtml() and outwardHtml() regex's are applied to the document to fix up links in the document. The previous version always modified links to be fully qualified links (i.e. http://somesite/ ..) making content generated by AreaEdit non-portable between sites. This setting determines whether or not links in the document will be fully qualified (http://thissite/..) or absolute (/...). The default is absolute.

makeLinkShowsTarget

Object makeLinkShowsTarget

enable the 'Target' field in the Make Link dialog this is for the simple default internal Link dialog, not the Linker plugin.

mozParaHandler

Object mozParaHandler

paragraph handler to use. set to 'built-in', 'dirty' or 'best' built-in: will (may) use 'br' instead of 'p' tags (passes it off to the brower builtin handler) dirty : will use p and work good enough for the majority of cases, best : works the best, but it's about 12kb worth of javascript and will probably be slower than 'dirty'. This is the "EnterParagraphs" plugin from "hipikat", rolled in to be part of the core code

pageStyle

Object pageStyle

style included in the iframe document

pageStyleSheets

Object pageStyleSheets

external stylesheets to load (REFERENCE THESE ABSOLUTELY)

panel_dimensions

Object panel_dimensions

Dimensions of the "Right Side" panel, when present

popupURL

Object popupURL

relative location of popups

sizeIncludesToolbar

Object sizeIncludesToolbar

include toolbar in size calculation

specialReplacements

Object specialReplacements

special replacements sometimes we want to be able to replace some string in the html comng in and going out so that in the editor we use the "internal" string, and outside and in the source view we use the "external" string this is useful for say making special codes for your absolute links, your external string might be some special code, say "{server_url}" an you say that the internal represenattion of that should be http://your.server/

SpellChecker

Object SpellChecker

statusBar

Object statusBar

enable creation of a status bar?

stripBaseHref

Object stripBaseHref

force hrefs to be relative? we can strip the base href out of relative links to leave them relative, reason for this especially if you don't specify a baseHref is that mozilla at least (& IE ?) will prefix the baseHref to any relative links to make them absolute, which isn't what you want most the time.

stripSelfNamedAnchors

Object stripSelfNamedAnchors

remove local anchors? and we can strip the url of the editor page from named links (eg ...) reason for this is that mozilla at least (and IE ?) prefixes location.href to any that don't have a url prefixing them

tidy_handler

Object tidy_handler

toolbar

Object toolbar

default toolbar. Customize the toolbar contents in an external file (i.e. the one calling HTMLArea) Do not edit the toolbar here. This toolbar definition is used all over the place.

undoSteps

Object undoSteps

maximum size of the undo queue

undoTimeout

Object undoTimeout

the time interval at which undo samples are taken

URIs

Object URIs

various often used URI's

version

Object version

width

Object width

constrain the width of the editor to the toolbar

HTMLArea.Config

HTMLArea.Config()

Configuration Constructor. Sets default config values which can be overridden from the calling page.

cut_copy_paste

 <private> void cut_copy_paste(e, cmd, obj)

default cut_copy_paste handler

hideSomeButtons

void hideSomeButtons(remove)

Remove some buttons or drop-down boxes from the toolbar. Pass as the only parameter a string containing button/drop-down names delimited by spaces. Note that the string should also begin with a space and end with a space. Example: config.hideSomeButtons(" fontname fontsize textindicator "); It's useful because it's easier to remove stuff from the default toolbar than create a brand new toolbar ;-)

registerButton

Object registerButton(id, tooltip, image, textMode, action, context)

register new button Helper function register a new button with the configuration. It can be called with all 5 arguments, or with only one (first one). When called with only one argument it must be an object with the following properties: id, tooltip, image, textMode, action. Examples: 1. config.registerButton("my-hilite", "Hilite text", "my-hilite.gif", false, function(editor) {...}); 2. config.registerButton({ id : "my-hilite", // the ID of your button tooltip : "Hilite text", // the tooltip image : "my-hilite.gif", // image to be displayed in the toolbar textMode : false, // disabled in text mode action : function(editor) { // called when the button is clicked editor.surroundHTML('', ''); }, context : "p" // will be disabled if outside a

element });

registerDropdown

void registerDropdown(object)

registerDropdown The following helper function registers a dropdown box with the editor configuration. You still have to add it to the toolbar, same as with the buttons. Call it like this: FIXME: add example

stylistLoadStyles

void stylistLoadStyles(styles, altnames)

This method takes raw style definitions and uses them in the stylist

stylistLoadStylesheet

void stylistLoadStylesheet(url, altnames)

This method loads an external stylesheet and uses it in the stylist