|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--Xinha
Defined in XinhaCore.js
Version: $Rev: 819 $ $LastChangedDate: 2007-04-20 01:20:22 +0200 (Fr, 20 Apr 2007) $
Nested Class Summary | |
<static class> |
Xinha.Config |
Field Summary | |
integer |
__htmlarea_id_num
running number that identifies the current editor |
document |
_doc
The document object of the iframe. Use this property to perform DOM operations on the edited document |
Object framework parts |
_framework
Holds the parts (table cells) of the UI (toolbar, panels, statusbar) |
window |
_iframe
This is the actual editable area. Technically it's an iframe that's made editable using window.designMode = 'on', respectively document.body.contentEditable = true (IE). Use this property to get a grip on the iframe's window features |
DomNode statusbar div |
_statusBar
The statusbar container |
DomNode textarea |
_textArea
This property references the original textarea, which is at the same time the editor in text mode |
Xinha.Config |
config
The configuration used in the editor |
<static> Object |
_addClasses
Alias of Xinha.addClasses() |
<static> Object |
_closingTags
|
<static> Array |
_eventFlushers
Holds the events to be flushed |
<static> Object |
_removeClasses
Alias of Xinha.removeClasses() |
<static> Object |
addClass
Alias of Xinha._addClass() |
<static> string |
ie_version
Version Number, if browser is Microsoft Internet Explorer |
<static> string |
is_gecko
Browserengine is Gecko (Mozilla) |
<static> string |
is_ie
Browser is Microsoft Internet Explorer |
<static> string |
is_khtml
Browserengine is KHTML (Konqueror, Safari) |
<static> string |
is_mac
OS is MacOS |
<static> string |
is_mac_ie
Browser is Microsoft Internet Explorer Mac |
<static> string |
is_opera
Browser is Opera |
<static> string |
is_safari
Browser is Safari |
<static> string |
is_win_ie
Browser is Microsoft Internet Explorer Windows |
<static> string |
opera_version
Version Number, if browser is Opera |
<static> RegExp |
RE_body
Finds body section in HTML |
<static> RegExp |
RE_doctype
Exracts DOCTYPE string from HTML |
<static> RegExp |
RE_email
Identifies email addresses |
<static> RegExp |
RE_head
Finds head section in HTML |
<static> RegExp |
RE_tagName
Identifies HTML tag names |
<static> RegExp |
RE_url
Identifies URLs |
<static> Object |
removeClass
Alias of Xinha.Xinha._removeClass() |
<static> Object |
version
|
Constructor Summary | |
Xinha(<String|DomNode> textarea, <Xinha.Config> config)
Creates a new Xinha object |
Method Summary | |
DomNode|null
|
_activeElement(sel)
Alias of activeElement() |
void
|
_clearFonts()
Removes <font> tags; always cleans the whole editor content |
void
|
_createImplicitBlock(type)
What's this? |
Range
|
_createRange(<Selection> sel)
Alias of createRange() |
Object
|
_editorEvent(<Event> ev)
A generic event handler for things that happen in the IFRAME's document. It provides two hooks for the "firePluginEvent" system: "onKeyPress" "onMouseDown" |
DomNode|null
|
_getAncestorBlock(<Selection> sel)
Traverses the DOM upwards and returns the first element that is a block level element |
DomNode|null
|
_getFirstAncestor(<Selection> sel, <Array> types)
Traverses the DOM upwards and returns the first element that is of one of the specified types |
Selection
|
_getSelection()
Alias of getSelection() |
void
|
_popupDialog(<String> url, <Function> action, <Mixed> init)
Modal popup dialogs |
Boolean
|
_selectionEmpty(<Selection> sel)
Alias of selectionEmpty() |
void
|
_splitBlock()
|
Boolean
|
_toggleBorders()
Use some CSS trickery to toggle borders on tables |
void
|
_wordClean()
Cleans dirty HTML from MS word; always cleans the whole editor content |
DomNode|null
|
activeElement(sel)
Returns the selected element, if any. |
DomNode
|
addPanel(<String> side)
Creates a panel in the panel container on the specified side |
DomNode
|
convertNode(<DomNode> el, <String> newTagName)
Changes the type of a given node |
Range
|
createRange(<Selection> sel)
Create a Range object from the given selection. |
void
|
debugTree()
Utility function: Outputs the structure of the edited document |
void
|
disableToolbar(<Array> except)
Disables (greys out) the buttons of the toolbar |
void
|
enableToolbar()
Enables the toolbar again when disabled by disableToolbar() |
Boolean
|
execCommand(<String> cmdID, <Boolean> UI, <Mixed> param)
This is a wrapper for the browser's execCommand function that handles things like formatting, inserting elements, etc. It intercepts some commands and replaces them with our own implementation. It provides a hook for the "firePluginEvent" system ("onExecCommand"). For reference see: Mozilla implementation MS implementation |
Boolean
|
firePluginEvent(<String> methodName)
Call a method of all plugins which define the method using the supplied arguments. |
document
|
focusEditor()
Focuses the iframe window. |
void
|
forceRedraw()
Sometimes the display has to be refreshed to make DOM changes visible (?) (Gecko bug?) |
Boolean
|
generate()
Creates the Xinha object and replaces the textarea with it. |
Array
|
getAllAncestors()
Returns an array with all the ancestor nodes of the selection or current cursor position. |
String
|
getEditorContent()
Get the edited HTML |
String
|
getKey(<Event> keyEvent)
Return the character (as a string) of a keyEvent - ie, press the 'a' key and this method will return 'a', press SHIFT-a and it will return 'A'. |
DomNode
|
getParentElement(<Selection> sel)
Get the parent element of the supplied or current selection. |
String
|
getSelectedHTML()
Get the HTML of the current selection. |
Selection
|
getSelection()
Get a Selection object of the current selection. |
Boolean
|
hasSelectedText()
Return true if we have some selection |
void
|
hidePanel(<DomNode> panel)
Hides a panel |
void
|
hidePanels(<Array> sides)
Hides the panel(s) on one or more sides |
String
|
imgURL(<String> file, <String> plugin)
Creates a path in the form _editor_url + "plugins/" + plugin + "/img/" + file |
void
|
insertHTML(<String> html)
Insert HTML at the current position, deleting the selection if any. |
void
|
insertNodeAtSelection(<DomNode> toBeInserted)
Insert a node at the current selection point. |
Boolean
|
isKeyEvent(<Event> event)
Determine if the given event object is a keydown/press event. |
Boolean
|
isShortCut(<Event> keyEvent)
Determines if the given key event object represents a combination of CTRL- |
void
|
notifyOf(ev, args)
|
void
|
notifyOn(ev, fn)
|
String
|
popupURL(<String> file)
Creates a path |
void
|
registerPanel(<string> side, object)
FIXME: Never used, what is this for? |
Object
|
registerPlugin()
Create the specified plugin and register it with this Xinha return the plugin created to allow refresh when necessary. This is only useful if Xinha is generated without using Xinha.makeEditors() |
void
|
removeLoadingMessage()
|
void
|
removePanel(<DomNode> panel)
Removes a panel |
void
|
restoreSelection(<Range> savedSelection)
Restores a selection previously stored |
Range
|
saveSelection()
Returns a range object to be stored and later restored with Xinha.prototype.restoreSelection() |
Object
|
scrollPos(<Window> scope)
Detect the current scroll position |
void
|
scrollToElement(<DomNode> e)
Scrolls the editor iframe to a given element or to the cursor |
Boolean
|
selectionEmpty(<Selection> sel)
Determines if the given selection is empty (collapsed). |
void
|
selectNodeContents(<DomNode> node,<Integer> pos)
Selects the contents of the given node. |
void
|
setEditorContent(<String> html)
Completely change the HTML inside the editor |
void
|
setLoadingMessage(string)
|
Object
|
setMode(<String> mode)
Switches editor mode between wysiwyg and text (HTML) |
void
|
showPanel(<DomNode> panel)
Shows a panel |
void
|
showPanels(<Array> sides)
Shows the panel(s) on one or more sides |
void
|
sizeEditor(<string> width, <string> height, <Boolean> includingBars, <Boolean> includingPanels)
Size the editor to a specific size, or just refresh the size (when window resizes for example) |
String
|
stripBaseURL(<String> string)
Strips host-part of URL which is added by browsers to links relative to server root |
void
|
updateToolbar(<Boolean> noStatus)
Updates enabled/disable/active state of the toolbar elements, the statusbar and other things This function is called on every key stroke as well as by a timer on a regular basis. Plugins have the opportunity to implement a prototype.onUpdateToolbar() method, which will also be called by this function. |
void
|
whenDocReady(<Function> f)
Delay a function until the document is ready for operations. |
<static> void
|
_addClass(<DomNode> el, <String> className)
Adds one CSS class to a given element (that is, it expands its className property by the given string, separated by a space) |
<static> void
|
_addEvent(<DomNode> el, <String> evname, <function> func)
adds an event listener for the specified element and event type |
<static> void
|
_addEvents(<DomNode> el, <Array> evs, <function> func)
add several events at once to one element |
<static> String
|
_colorToRgb(<String|Integer> v)
Returns hexadecimal color representation from a number or a rgb-style color. |
<static> void
|
_getback(<String> url, <Function> handler)
Use XMLHTTPRequest to receive some data from the server and do something with the it (asyncronously!) |
<static> Object
|
_geturlcontent(<String> url)
Use XMLHTTPRequest to receive some data from the server syncronously |
<static> Boolean
|
_hasClass(<DomNode> el, <String> className)
Checks if one element has set the given className |
<static> Object
|
_lc(<String> string, <String> context, <Object> replace)
Return a localised string. |
<static> Object
|
_loadback(<String> url, <Object> callback, <Object> scope, <Object> bonus)
Load a javascript file by inserting it in the HEAD tag and eventually call a function when loaded |
<static> String
|
_makeColor(v)
Creates a rgb-style rgb(r,g,b) color from a (24bit) number |
<static> void
|
_postback(<String> url, <Object> data, <Function> handler)
Use XMLHTTPRequest 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 |
<static> void
|
_removeClass(<DomNode> el, <String> className)
Removes one CSS class (that is one of possible more parts separated by spaces) from a given element |
<static> void
|
_removeEvent(<DomNode> el, <String> evname, <function> func)
removes an event listener previously added |
<static> void
|
_removeEvents(<DomNode> el, <Array> evs, <function> func)
remove several events at once to from element |
<static> Object
|
_resolveRelativeUrl( base, url )
|
<static> void
|
_stopEvent(<event> ev)
stops bubbling of the event, if no further listeners should be triggered |
<static> void
|
addClasses(<DomNode> el, <String> classes)
Adds CSS classes to a given element (that is, it expands its className property by the given string, separated by a space, thereby checking that no class is doubly added) |
<static> void
|
addDom0Event(<DomNode> el, <String> ev, <function> fn)
Adds a standard "DOM-0" event listener to an element. |
<static> Boolean
|
arrayContainsArray(<Array> a1, <Array> a2)
Returns true if all elements of a2 are also contained in a1 (at least I think this is what it does) |
<static> Array
|
arrayFilter(<Array> a1, <Function> filterfn)
Walks through an array and applies a filter function to each item |
<static> String
|
base64_decode(<String> input)
Utility function to base64_decode some arbitrary data, uses the builtin atob() if it exists (Moz) |
<static> String
|
base64_encode(<String> input)
Utility function to base64_encode some arbitrary data, uses the builtin btoa() if it exists (Moz) |
<static> Array
|
collectionToArray(<Collection> collection)
Converts a Collection object to an array |
<static> Object
|
createLoadingMessage(textarea,text)
|
<static> void
|
createLoadingMessages(xinha_editors)
|
<static> Object
|
escapeStringForRegExp(<string> string)
When dynamically creating a RegExp from an arbtrary string, some charactes that have special meanings in regular expressions have to be escaped. |
<static> Integer
|
findPosX(obj)
Find left pixel position of an element in the DOM. |
<static> Integer
|
findPosY(obj)
Find top pixel position of an element in the DOM. |
<static> DomNode
|
getElementById(<String> tag, <String> id)
FIX: Internet Explorer returns an item having the _name_ equal to the given id, even if it's not having any id. |
<static> Object
|
getElementTopLeft(<DomNode> element)
Calculate the top and left pixel position of an element in the DOM. |
<static> Object
|
getInnerText(<DomNode> el)
Extracts the textual content of a given node |
<static> String
|
getOuterHTML(<DomNode> element)
Return the HTML string of the given Element, including the Element. |
<static> XMLHTTPRequest
|
getXMLHTTPRequestObject()
Get a new XMLHTTPRequest Object ready to be used. |
<static> Boolean
|
hasDisplayedChildren(<DomNode> el)
Walks through the children of a given element and checks if any of the are visible (= not display:none) |
<static> Boolean
|
hasParentNode(<DomNode> el)
Checks if some element has a parent node |
<static> String
|
htmlEncode(<String> str)
Performs HTML encoding of some given string (converts HTML special characters to entities) |
<static> void
|
init()
|
<static> Boolean
|
isBlockElement(<DomNode> el)
Checks if one element is in the list of elements that are defined as block level elements in HTML |
<static> Boolean
|
isParaContainer(<DomNode> el)
Checks if one element is in the list of elements that are allowed to contain a paragraph in HTML |
<static> Boolean
|
loadPlugin(<String> pluginName, <Function> callback, <String> plugin_file)
Static function that loads the given plugin |
<static> Boolean
|
loadPlugins(<Array> plugins, <Function> callbackIfNotReady)
Static function that loads the plugins (see xinha_plugins in NewbieGuide) |
<static> void
|
loadStyle(<String> style, <String> plugin, <String> id)
Adds a stylesheet to the document |
<static> Object
|
makeEditors(<Array> editor_names, <Xinha.Config> default_config, <Array> plugin_names)
Xinha's main loading function (see NewbieGuide) |
<static> Boolean
|
needsClosingTag(<DomNode> el)
Checks if one element is in the list of elements for which the end tag is not optional or forbidden in HTML |
<static> void
|
notImplemented(methodName)
|
<static> Array
|
objectProperties(<Object> obj)
Returns an array containig all properties that are set in an object |
<static> void
|
onload()
|
<static> Object
|
pageSize(<Window> scope)
Detect the size of the whole document |
<static> void
|
prependDom0Event(el, ev, fn)
See addDom0Event, the difference is that handlers registered using prependDom0Event will be triggered before existing DOM-0 events of the same name on the same element. |
<static> Object
|
removeClasses(<DomNode> el, classes)
Removes CSS classes (that is one or more of possibly several parts separated by spaces) from a given element |
<static> DomNode
|
removeFromParent(<DomNode> el)
Removes a node from the DOM |
<static> void
|
removeLoadingMessages(xinha_editors)
|
<static> Object
|
replace(<string> id, config)
Helper function: replaces the TEXTAREA with the given ID with Xinha. |
<static> void
|
replaceAll(config)
Helper function: replace all TEXTAREA-s in the document with Xinha-s. |
<static> void
|
setLoadingMessage(string)
|
<static> void
|
startEditors(<Object> editors)
Another main loading function (see NewbieGuide) |
<static> String
|
uniq(<String> prefix)
Returns a string that is unique on the page |
<static> Object
|
viewportSize(<Window> scope)
Detect the size of visible area |
Field Detail |
integer __htmlarea_id_num
document _doc
Object framework parts _framework
window _iframe
DomNode statusbar div _statusBar
DomNode textarea _textArea
Xinha.Config config
<static> Object _addClasses
<static> Object _closingTags
<static> Array _eventFlushers
<static> Object _removeClasses
<static> Object addClass
<static> string ie_version
<static> string is_gecko
<static> string is_ie
<static> string is_khtml
<static> string is_mac
<static> string is_mac_ie
<static> string is_opera
<static> string is_safari
<static> string is_win_ie
<static> string opera_version
<static> RegExp RE_body
<static> RegExp RE_doctype
<static> RegExp RE_email
<static> RegExp RE_head
<static> RegExp RE_tagName
<static> RegExp RE_url
<static> Object removeClass
<static> Object version
Constructor Detail |
Xinha(<String|DomNode> textarea, <Xinha.Config> config)
textarea
- the textarea to replace; can be either only the id or the DOM object as returned by document.getElementById()
config
- optional if no Xinha.Config object is passed, the default config is used
Method Detail |
DomNode|null _activeElement(sel)
void _clearFonts()
void _createImplicitBlock(type)
Range _createRange(<Selection> sel)
sel
- Selection object
Object _editorEvent(<Event> ev)
ev
-
DomNode|null _getAncestorBlock(<Selection> sel)
sel
- Selection object as returned by getSelection
DomNode|null _getFirstAncestor(<Selection> sel, <Array> types)
sel
- Selection object as returned by getSelection
types
- Array of HTML tag names (lower case)
Selection _getSelection()
void _popupDialog(<String> url, <Function> action, <Mixed> init)
url
- URL to the popup dialog
action
- A function that receives one value; this function will get called after the dialog is closed, with the return value of the dialog.
init
- A variable that is passed to the popup window to pass arbitrary data
Boolean _selectionEmpty(<Selection> sel)
sel
- Selection object as returned by getSelection
void _splitBlock()
Boolean _toggleBorders()
void _wordClean()
DomNode|null activeElement(sel)
DomNode addPanel(<String> side)
side
- the panel container to which the new panel will be addedDomNode convertNode(<DomNode> el, <String> newTagName)
el
- The element to convert
newTagName
- The type the element will be converted to
Range createRange(<Selection> sel)
sel
- Selection object
void debugTree()
void disableToolbar(<Array> except)
except
- this array contains ids of toolbar objects that will not be disabled
void enableToolbar()
Boolean execCommand(<String> cmdID, <Boolean> UI, <Mixed> param)
cmdID
- command to be executed as defined in the browsers implemantations or Xinha custom
UI
- for compatibility with the execCommand syntax; false in most (all) cases
param
- Some commands require parameters
Boolean firePluginEvent(<String> methodName)
editor.firePluginEvent('onExecCommand', 'paste')
PluginName.prototype.onExecCommand = function (cmdID, UI, param) {do something...}
methodName | Parameters |
---|---|
onExecCommand | cmdID, UI, param |
onKeyPress | ev |
onMouseDown | ev |
methodName
-
arguments
- to pass to the method, optional [2..n]
document focusEditor()
void forceRedraw()
Boolean generate()
Array getAllAncestors()
String getEditorContent()
String getKey(<Event> keyEvent)
keyEvent
-
DomNode getParentElement(<Selection> sel)
sel
- optional selection as returned by getSelection
String getSelectedHTML()
Selection getSelection()
Boolean hasSelectedText()
void hidePanel(<DomNode> panel)
panel
- object as returned by Xinha.prototype.addPanel()
void hidePanels(<Array> sides)
sides
- the sides on which the panels shall be hidden
String imgURL(<String> file, <String> plugin)
file
- Name of the image
plugin
- optional If omitted, simply _editor_url + file is returned
void insertHTML(<String> html)
html
-
void insertNodeAtSelection(<DomNode> toBeInserted)
toBeInserted
-
Boolean isKeyEvent(<Event> event)
event
-
Boolean isShortCut(<Event> keyEvent)
keyEvent
-
void notifyOf(ev, args)
void notifyOn(ev, fn)
String popupURL(<String> file)
file
- Name of the popup
void registerPanel(<string> side, object)
side
-
Object
- }
Object registerPlugin()
void removeLoadingMessage()
void removePanel(<DomNode> panel)
panel
- object as returned by Xinha.prototype.addPanel()
void restoreSelection(<Range> savedSelection)
savedSelection
- Range object as returned by Xinha.prototype.restoreSelection()
Range saveSelection()
Object scrollPos(<Window> scope)
scope
- optional When calling from a popup window, pass its window object to get the values of the popup
void scrollToElement(<DomNode> e)
e
- optional The element to scroll to; if ommitted, element the element the cursor is in
Boolean selectionEmpty(<Selection> sel)
sel
- Selection object as returned by getSelection
void selectNodeContents(<DomNode> node,<Integer> pos)
node
-
pos
- Set to a numeric position inside the node to collapse the cursor here if possible.
void setEditorContent(<String> html)
html
- new content
void setLoadingMessage(string)
Object setMode(<String> mode)
mode
- optional "textmode" or "wysiwyg", if omitted, toggles between modes.
void showPanel(<DomNode> panel)
panel
- object as returned by Xinha.prototype.addPanel()
void showPanels(<Array> sides)
sides
- the sides on which the panels shall be hidden
void sizeEditor(<string> width, <string> height, <Boolean> includingBars, <Boolean> includingPanels)
width
- optional width (CSS specification)
height
- optional height (CSS specification)
includingBars
- optional to indicate if the size should include or exclude tool & status bars
includingPanels
- optional to indicate if the size should include or exclude panels
String stripBaseURL(<String> string)
string
-
void updateToolbar(<Boolean> noStatus)
noStatus
- private use Exempt updating of statusbar
void whenDocReady(<Function> f)
f
- The function to call once the document is ready
<static> void _addClass(<DomNode> el, <String> className)
el
- The DOM element the class will be added to
className
- The class to be added
<static> void _addEvent(<DomNode> el, <String> evname, <function> func)
el
- the DOM element the event should be attached to
evname
- the name of the event to listen for (without leading "on")
func
- the function to be called when the event is fired
<static> void _addEvents(<DomNode> el, <Array> evs, <function> func)
el
- the DOM element the event should be attached to
evs
- the names of the event to listen for (without leading "on")
func
- the function to be called when the event is fired
<static> String _colorToRgb(<String|Integer> v)
v
- rgb(r,g,b) or 24bit color definition
<static> void _getback(<String> url, <Function> handler)
url
- The address for the HTTPRequest
handler
- A function that is called when an answer is received from the server with the responseText as argument
<static> Object _geturlcontent(<String> url)
url
- The address for the HTTPRequest
<static> Boolean _hasClass(<DomNode> el, <String> className)
el
- The DOM element to check
className
- The class to be looked for
<static> Object _lc(<String> string, <String> context, <Object> replace)
string
- English language string. It can also contain variables in the form "Some text with $variable=replaced text$". This replaces $variable in "Some text with $variable" with "replaced text"
context
- Case sensitive context name, eg 'Xinha' (default), 'TableOperations'...
replace
- Replace $variables in String, eg {foo: 'replaceText'} ($foo in string will be replaced by replaceText)
<static> Object _loadback(<String> url, <Object> callback, <Object> scope, <Object> bonus)
url
- Source url of the file to load
callback
- optional Callback function to launch once ready
scope
- optional Application scope for the callback function
bonus
- optional Arbitrary object send as a param to the callback function
<static> String _makeColor(v)
Integer
- }
<static> void _postback(<String> url, <Object> data, <Function> handler)
url
- The address for the HTTPRequest
data
- The data to be passed to the server like {name:"value"}
handler
- A function that is called when an answer is received from the server with the responseText as argument
<static> void _removeClass(<DomNode> el, <String> className)
el
- The DOM element the class will be removed from
className
- The class to be removed
<static> void _removeEvent(<DomNode> el, <String> evname, <function> func)
el
- the DOM element the event should be removed from
evname
- the name of the event the listener should be removed from (without leading "on")
func
- the function to be removed
<static> void _removeEvents(<DomNode> el, <Array> evs, <function> func)
el
- the DOM element the events should be remove from
evs
- the names of the events the listener should be removed from (without leading "on")
func
- the function to be removed
<static> Object _resolveRelativeUrl( base, url )
<static> void _stopEvent(<event> ev)
ev
- the event to be stopped
<static> void addClasses(<DomNode> el, <String> classes)
el
- The DOM element the classes will be added to
classes
- The classes to be added
<static> void addDom0Event(<DomNode> el, <String> ev, <function> fn)
el
- the DOM element the event should be attached to
ev
- the name of the event to listen for (without leading "on")
fn
- the function to be called when the event is fired
<static> Boolean arrayContainsArray(<Array> a1, <Array> a2)
a1
-
a2
-
<static> Array arrayFilter(<Array> a1, <Function> filterfn)
a1
- The array to filter
filterfn
- If this function returns true, the item is added to the new array
<static> String base64_decode(<String> input)
input
-
<static> String base64_encode(<String> input)
input
-
<static> Array collectionToArray(<Collection> collection)
collection
- The array to filter
<static> Object createLoadingMessage(textarea,text)
<static> void createLoadingMessages(xinha_editors)
<static> Object escapeStringForRegExp(<string> string)
string
- the string to be escaped
<static> Integer findPosX(obj)
element
- HTML Element
<static> Integer findPosY(obj)
element
- HTML Element
<static> DomNode getElementById(<String> tag, <String> id)
tag
- The tag name to limit the return to
id
-
<static> Object getElementTopLeft(<DomNode> element)
element
- HTML Element
<static> Object getInnerText(<DomNode> el)
el
-
<static> String getOuterHTML(<DomNode> element)
element
- HTML Element
<static> XMLHTTPRequest getXMLHTTPRequestObject()
<static> Boolean hasDisplayedChildren(<DomNode> el)
el
-
<static> Boolean hasParentNode(<DomNode> el)
el
-
<static> String htmlEncode(<String> str)
str
- The unencoded input
<static> void init()
<static> Boolean isBlockElement(<DomNode> el)
el
- The DOM element to check
<static> Boolean isParaContainer(<DomNode> el)
el
- The DOM element to check
<static> Boolean loadPlugin(<String> pluginName, <Function> callback, <String> plugin_file)
pluginName
-
callback
- function to be called when file is loaded
plugin_file
- URL of the file to load
<static> Boolean loadPlugins(<Array> plugins, <Function> callbackIfNotReady)
plugins
-
callbackIfNotReady
- function that is called repeatedly until all files are
<static> void loadStyle(<String> style, <String> plugin, <String> id)
style
- name of the stylesheet file
plugin
- optional name of a plugin; if passed this function looks for the stylesheet file in the plugin directory
id
- optional a unique id for identifiing the created link element, e.g. for avoiding double loading or later removing it again
<static> Object makeEditors(<Array> editor_names, <Xinha.Config> default_config, <Array> plugin_names)
editor_names
-
default_config
-
plugin_names
-
<static> Boolean needsClosingTag(<DomNode> el)
el
- The DOM element to check
<static> void notImplemented(methodName)
<static> Array objectProperties(<Object> obj)
obj
-
<static> void onload()
<static> Object pageSize(<Window> scope)
scope
- optional When calling from a popup window, pass its window object to get the values of the popup
<static> void prependDom0Event(el, ev, fn)
the
- DOM element the event should be attached to
the
- name of the event to listen for (without leading "on")
the
- function to be called when the event is fired
<static> Object removeClasses(<DomNode> el, classes)
el
- The DOM element the class will be removed from
className
- The class to be removed
<static> DomNode removeFromParent(<DomNode> el)
el
- The element to be removed
<static> void removeLoadingMessages(xinha_editors)
<static> Object replace(<string> id, config)
id
- id of the textarea to replace
optional
- config
<static> void replaceAll(config)
optional
- config
<static> void setLoadingMessage(string)
<static> void startEditors(<Object> editors)
editors
- As returned by Xinha.makeEditors()
<static> String uniq(<String> prefix)
prefix
- This string is prefixed to a running number
<static> Object viewportSize(<Window> scope)
scope
- optional When calling from a popup window, pass its window object to get the values of the popup
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |