WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

@mozilla.org/editor/htmleditor;1

This component implements the following interfaces:

Constants

PRInt16 nsIEditor.eNone = 0
PRInt16 nsIEditor.eNext = 1
PRInt16 nsIEditor.ePrevious = 2
PRInt16 nsIEditor.eNextWord = 3
PRInt16 nsIEditor.ePreviousWord = 4
PRInt16 nsIEditor.eToBeginningOfLine = 5
PRInt16 nsIEditor.eToEndOfLine = 6
PRInt16 nsIHTMLEditor.eLeft = 0
PRInt16 nsIHTMLEditor.eCenter = 1
PRInt16 nsIHTMLEditor.eRight = 2
PRInt16 nsIHTMLEditor.eJustify = 3
PRInt16 nsIHTMLObjectResizer.eTopLeft = 0
PRInt16 nsIHTMLObjectResizer.eTop = 1
PRInt16 nsIHTMLObjectResizer.eTopRight = 2
PRInt16 nsIHTMLObjectResizer.eLeft = 3
PRInt16 nsIHTMLObjectResizer.eRight = 4
PRInt16 nsIHTMLObjectResizer.eBottomLeft = 5
PRInt16 nsIHTMLObjectResizer.eBottom = 6
PRInt16 nsIHTMLObjectResizer.eBottomRight = 7
PRInt32 nsIPlaintextEditor.eEditorPlaintextMask = 1
PRInt32 nsIPlaintextEditor.eEditorSingleLineMask = 2
PRInt32 nsIPlaintextEditor.eEditorPasswordMask = 4
PRInt32 nsIPlaintextEditor.eEditorReadonlyMask = 8
PRInt32 nsIPlaintextEditor.eEditorDisabledMask = 16
PRInt32 nsIPlaintextEditor.eEditorFilterInputMask = 32
PRInt32 nsIPlaintextEditor.eEditorMailMask = 64
PRInt32 nsIPlaintextEditor.eEditorUseAsyncUpdatesMask = 128
PRInt32 nsIPlaintextEditor.eEditorEnableWrapHackMask = 256
PRInt32 nsIPlaintextEditor.eEditorWidgetMask = 512
PRInt32 nsIPlaintextEditor.eEditorNoCSSMask = 1024
PRInt32 nsIPlaintextEditor.eEditorAllowInteraction = 2048
PRInt32 nsIPlaintextEditor.eNewlinesPasteIntact = 0
PRInt32 nsIPlaintextEditor.eNewlinesPasteToFirst = 1
PRInt32 nsIPlaintextEditor.eNewlinesReplaceWithSpaces = 2
PRInt32 nsIPlaintextEditor.eNewlinesStrip = 3
PRInt32 nsIPlaintextEditor.eNewlinesReplaceWithCommas = 4
PRInt32 nsIPlaintextEditor.eNewlinesStripSurroundingWhitespace = 5
PRInt16 nsITableEditor.eNoSearch = 0
PRInt16 nsITableEditor.ePreviousColumn = 1
PRInt16 nsITableEditor.ePreviousRow = 2

Properties

char* nsIEditor.contentsMIMEType

The MimeType of the document

readonly nsIDOMDocument nsIEditor.document

The DOM Document this editor is associated with, refcounted.

ACString nsIEditor.documentCharacterSet

readonly PRBool nsIEditor.documentIsEmpty

readonly PRBool nsIEditor.documentModified

PRUint32 nsIEditor.flags

PRBool nsIHTMLEditor.isCSSEnabled

A boolean which is true is the HTMLEditor has been instantiated with CSS knowledge and if the CSS pref is currently checked

readonly PRBool nsIEditor.isDocumentEditable

PRInt32 nsIPlaintextEditor.maxTextLength

The maximum number of characters allowed. default: -1 (unlimited).

PRInt32 nsIPlaintextEditor.newlineHandling

Get and set newline handling.

Values are the constants defined above.

PRBool nsIHTMLObjectResizer.objectResizingEnabled

A boolean indicating if object resizing is enabled in the editor

readonly DOMString nsIPhonetic.phonetic

Phonetic get the phonetic value of the input text

readonly nsIDOMElement nsIHTMLObjectResizer.resizedObject

The element currently displaying resizers

PRBool nsIHTMLEditor.returnInParagraphCreatesNewParagraph

A boolean indicating if a return key pressed in a paragraph creates another paragraph or just inserts a
at the caret

readonly nsIDOMElement nsIEditor.rootElement

The body element, i.e. the root of the editable document.

readonly nsISelection nsIEditor.selection

readonly nsISelectionController nsIEditor.selectionController

The selection controller for the current presentation, refcounted.

readonly PRInt32 nsIPlaintextEditor.textLength

The length of the contents in characters. XXX change this type to 'unsigned long'

nsITransactionManager nsIEditor.transactionManager

TransactionManager Get the transaction manager the editor is using.

PRInt32 nsIPlaintextEditor.wrapWidth

Get and set the body wrap width.

Special values: 0 = wrap to window width -1 = no wrap at all

Methods

InterfaceMethod
nsIHTMLEditor void addDefaultProperty ( nsIAtom property , AString attribute , AString value )
nsIEditor void addDocumentStateListener ( nsIDocumentStateListener listener )
nsIEditor void addEditActionListener ( nsIEditActionListener listener )
nsIEditor void addEditorObserver ( nsIEditorObserver observer )
nsIHTMLEditor void addInsertionListener ( nsIContentFilter inFilter )
nsIHTMLObjectResizer void addObjectResizeEventListener ( nsIHTMLObjectResizeListener listener )
nsIEditorStyleSheets void addOverrideStyleSheet ( AString URL )
nsIEditorStyleSheets void addStyleSheet ( AString URL )
nsIHTMLEditor void align ( AString align )
nsIEditorIMESupport [noscript] void beginComposition ( nsTextEventReplyPtr* reply )
nsIEditor void beginningOfDocument ( )
nsIEditor void beginPlaceHolderTransaction ( nsIAtom name )
nsIEditor void beginTransaction ( )
nsIEditor PRBool canCopy ( )
nsIEditor PRBool canCut ( )
nsIHTMLEditor PRBool canDrag ( nsIDOMEvent event )
nsIEditor PRBool canPaste ( PRInt32 selectionType )
nsIEditor void canRedo ( out PRBool isEnabled , out PRBool canRedo )
nsIEditor void canUndo ( out PRBool isEnabled , out PRBool canUndo )
nsIHTMLEditor void checkSelectionStateForAnonymousButtons ( nsISelection selection )
nsIEditor void cloneAttribute ( AString attribute , nsIDOMNode destNode , nsIDOMNode sourceNode )
nsIEditor void cloneAttributes ( nsIDOMNode destNode , nsIDOMNode sourceNode )
nsIEditor void copy ( )
nsIHTMLEditor nsIDOMElement createAnonymousElement ( AString tag , nsIDOMNode parentNode , AString anonClass , PRBool isCreatedHidden )
nsIHTMLEditor nsIDOMElement createElementWithDefaults ( AString tagName )
nsIEditor nsIDOMNode createNode ( AString tag , nsIDOMNode parent , PRInt32 position )
nsIEditor void cut ( )
nsIEditor void debugDumpContent ( )
nsIEditor void debugUnitTests ( out PRInt32 outNumTests , out PRInt32 outNumTestsFailed )
nsIHTMLEditor void decreaseFontSize ( )
nsIEditor void deleteNode ( nsIDOMNode child )
nsIEditor void deleteSelection ( PRInt16 action )
nsITableEditor void deleteTable ( )
nsITableEditor void deleteTableCell ( PRInt32 number )
nsITableEditor void deleteTableCellContents ( )
nsITableEditor void deleteTableColumn ( PRInt32 number )
nsITableEditor void deleteTableRow ( PRInt32 number )
nsIHTMLEditor void doDrag ( nsIDOMEvent event )
nsIEditor void doTransaction ( nsITransaction txn )
nsIEditor void dumpContentTree ( )
nsIEditorStyleSheets void enableStyleSheet ( AString URL , PRBool enable )
nsIEditor void enableUndo ( PRBool enable )
nsIEditorIMESupport void endComposition ( )
nsIEditor void endOfDocument ( )
nsIEditor void endPlaceHolderTransaction ( )
nsIEditor void endTransaction ( )
nsIEditorIMESupport void forceCompositionEnd ( )
nsIHTMLEditor void getAlignment ( out PRBool mixed , out PRInt16 align )
nsIEditor PRBool getAttributeValue ( nsIDOMElement element , AString attributestr , out AString resultValue )
nsIHTMLEditor AString getBackgroundColorState ( out PRBool mixed )
nsITableEditor nsIDOMElement getCellAt ( nsIDOMElement table , PRInt32 rowIndex , PRInt32 colIndex )
nsITableEditor void getCellDataAt ( nsIDOMElement table , PRInt32 rowIndex , PRInt32 colIndex , out nsIDOMElement cell , out PRInt32 startRowIndex , out PRInt32 startColIndex , out PRInt32 rowSpan , out PRInt32 colSpan , out PRInt32 actualRowSpan , out PRInt32 actualColSpan , out PRBool isSelected )
nsITableEditor void getCellIndexes ( nsIDOMElement cell , out PRInt32 rowIndex , out PRInt32 colIndex )
nsIHTMLEditor nsIDOMElement getElementOrParentByTagName ( AString tagName , nsIDOMNode node )
nsIEditorMailSupport nsISupportsArray getEmbeddedObjects ( )
nsITableEditor nsIDOMNode getFirstRow ( nsIDOMElement tableElement )
nsITableEditor nsIDOMElement getFirstSelectedCell ( out nsIDOMRange range )
nsITableEditor nsIDOMElement getFirstSelectedCellInTable ( out PRInt32 rowIndex , out PRInt32 colIndex )
nsIHTMLEditor AString getFontColorState ( out PRBool mixed )
nsIHTMLEditor AString getFontFaceState ( out PRBool mixed )
nsIHTMLEditor AString getHeadContentsAsHTML ( )
nsIHTMLEditor AString getHighlightColorState ( out PRBool mixed )
nsIHTMLEditor void getIndentState ( out PRBool canIndent , out PRBool canOutdent )
nsIHTMLEditor void getInlineProperty ( nsIAtom property , AString attribute , AString value , out PRBool first , out PRBool any , out PRBool all )
nsIHTMLEditor AString getInlinePropertyWithAttrValue ( nsIAtom property , AString attribute , AString value , out PRBool first , out PRBool any , out PRBool all )
nsIEditor nsIInlineSpellChecker getInlineSpellChecker ( PRBool autoCreate )
nsIHTMLEditor nsISupportsArray getLinkedObjects ( )
nsIHTMLEditor void getListItemState ( out PRBool mixed , out PRBool LI , out PRBool DT , out PRBool DD )
nsIHTMLEditor void getListState ( out PRBool mixed , out PRBool OL , out PRBool UL , out PRBool DL )
nsIEditor PRInt32 getModificationCount ( )
nsITableEditor nsIDOMNode getNextRow ( nsIDOMNode tableElement )
nsITableEditor nsIDOMElement getNextSelectedCell ( out nsIDOMRange range )
nsIHTMLEditor AString getParagraphState ( out PRBool mixed )
nsIEditorIMESupport [noscript] void getPreferredIMEState ( out PRUint32 state )
nsIEditorIMESupport [noscript] void getQueryCaretRect ( nsQueryCaretRectEventReplyPtr* reply )
nsIEditorIMESupport [noscript] void getReconversionString ( nsReconversionEventReplyPtr* reply )
nsITableEditor PRUint32 getSelectedCellsType ( nsIDOMElement element )
nsIHTMLEditor nsIDOMElement getSelectedElement ( AString tagName )
nsITableEditor nsIDOMElement getSelectedOrParentTableElement ( out AString tagName , out PRInt32 count )
nsIHTMLEditor nsIDOMElement getSelectionContainer ( )
nsIEditorStyleSheets [noscript] nsICSSStyleSheet getStyleSheetForURL ( AString URL )
nsITableEditor void getTableSize ( nsIDOMElement table , out PRInt32 rowCount , out PRInt32 colCount )
nsIEditorStyleSheets [noscript] AString getURLForStyleSheet ( nsICSSStyleSheet styleSheet )
nsISupportsWeakReference nsIWeakReference GetWeakReference ( )
nsIPlaintextEditor void handleKeyPress ( nsIDOMKeyEvent keyEvent )
nsIHTMLObjectResizer void hideResizers ( )
nsIHTMLEditor void ignoreSpuriousDragEvent ( PRBool ignoreSpuriousDragEvent )
nsIHTMLEditor void increaseFontSize ( )
nsIEditor void incrementModificationCount ( PRInt32 modCount )
nsIHTMLEditor void indent ( AString indent )
nsIEditor [noscript] void init ( nsIDOMDocument doc , nsIPresShellPtr shell , nsIContent root , nsISelectionController selCon , PRUint32 flags )
nsIEditorMailSupport nsIDOMNode insertAsCitedQuotation ( AString quotedText , AString citation , PRBool insertHTML )
nsIEditorMailSupport nsIDOMNode insertAsQuotation ( AString quotedText )
nsIHTMLEditor void insertElementAtSelection ( nsIDOMElement element , PRBool deleteSelection )
nsIHTMLEditor void insertFromDrop ( nsIDOMEvent event )
nsIHTMLEditor void insertHTML ( AString inputString )
nsIHTMLEditor void insertHTMLWithContext ( AString inputString , AString contextStr , AString infoStr , AString flavor , nsIDOMDocument sourceDoc , nsIDOMNode destinationNode , PRInt32 destinationOffset , PRBool deleteSelection )
nsIPlaintextEditor void insertLineBreak ( )
nsIHTMLEditor void insertLinkAroundSelection ( nsIDOMElement anchorElement )
nsIEditor void insertNode ( nsIDOMNode node , nsIDOMNode parent , PRInt32 position )
nsITableEditor void insertTableCell ( PRInt32 number , PRBool after )
nsITableEditor void insertTableColumn ( PRInt32 number , PRBool after )
nsITableEditor void insertTableRow ( PRInt32 number , PRBool after )
nsIPlaintextEditor void insertText ( DOMString stringToInsert )
nsIEditorMailSupport void insertTextWithQuotations ( DOMString stringToInsert )
nsIHTMLEditor PRBool isAnonymousElement ( nsIDOMElement element )
nsIEditor [notxpcom] PRBool isModifiableNode ( nsIDOMNode node )
nsIEditor void joinNodes ( nsIDOMNode leftNode , nsIDOMNode rightNode , nsIDOMNode parent )
nsITableEditor void joinTableCells ( PRBool mergeNonContiguousContents )
nsIHTMLEditor void makeOrChangeList ( AString listType , PRBool entireList , AString bulletType )
nsIEditor void markNodeDirty ( nsIDOMNode node )
nsIHTMLObjectResizer void mouseDown ( PRInt32 aX , PRInt32 aY , nsIDOMElement target )
nsIHTMLObjectResizer void mouseMove ( nsIDOMEvent mouseEvent )
nsIHTMLObjectResizer void mouseUp ( PRInt32 aX , PRInt32 aY , nsIDOMElement target )
nsIHTMLEditor PRBool nodeIsBlock ( nsIDOMNode node )
nsITableEditor void normalizeTable ( nsIDOMElement table )
nsIEditorIMESupport void notifyIMEOnBlur ( )
nsIEditorIMESupport void notifyIMEOnFocus ( )
nsIEditor void outputToStream ( nsIOutputStream stream , AString formatType , ACString charsetOverride , PRUint32 flags )
nsIEditor AString outputToString ( AString formatType , PRUint32 flags )
nsIEditor void paste ( PRInt32 selectionType )
nsIEditorMailSupport void pasteAsCitedQuotation ( AString citation , PRInt32 selectionType )
nsIEditorMailSupport void pasteAsQuotation ( PRInt32 selectionType )
nsIHTMLEditor void pasteNoFormatting ( PRInt32 selectionType )
nsIEditor void postCreate ( )
nsIEditor void preDestroy ( )
nsIEditorIMESupport [noscript] void queryComposition ( nsTextEventReplyPtr* reply )
nsIHTMLEditor void rebuildDocumentFromSource ( AString sourceString )
nsIEditor void redo ( PRUint32 count )
nsIHTMLObjectResizer void refreshResizers ( )
nsIHTMLEditor void removeAllDefaultProperties ( )
nsIHTMLEditor void removeAllInlineProperties ( )
nsIEditor void removeAttribute ( nsIDOMElement element , AString attribute )
nsIEditor void removeAttributeOrEquivalent ( nsIDOMElement element , DOMString sourceAttrName , PRBool suppressTransaction )
nsIHTMLEditor void removeDefaultProperty ( nsIAtom property , AString attribute , AString value )
nsIEditor void removeDocumentStateListener ( nsIDocumentStateListener listener )
nsIEditor void removeEditActionListener ( nsIEditActionListener listener )
nsIEditor void removeEditorObserver ( nsIEditorObserver observer )
nsIHTMLEditor void removeInlineProperty ( nsIAtom property , AString attribute )
nsIHTMLEditor void removeInsertionListener ( nsIContentFilter inFilter )
nsIHTMLEditor void removeList ( AString listType )
nsIHTMLObjectResizer void removeObjectResizeEventListener ( nsIHTMLObjectResizeListener listener )
nsIEditorStyleSheets void removeOverrideStyleSheet ( AString URL )
nsIEditorStyleSheets void removeStyleSheet ( AString URL )
nsIHTMLEditor void replaceHeadContentsWithHTML ( AString sourceToInsert )
nsIEditorStyleSheets void replaceOverrideStyleSheet ( AString URL )
nsIEditorStyleSheets void replaceStyleSheet ( AString URL )
nsIEditor void resetModificationCount ( )
nsIEditorMailSupport void rewrap ( PRBool respectNewlines )
nsIEditor void selectAll ( )
nsITableEditor void selectAllTableCells ( )
nsITableEditor void selectBlockOfCells ( nsIDOMElement startCell , nsIDOMElement endCell )
nsIHTMLEditor void selectElement ( nsIDOMElement element )
nsITableEditor void selectTable ( )
nsITableEditor void selectTableCell ( )
nsITableEditor void selectTableColumn ( )
nsITableEditor void selectTableRow ( )
nsIEditor void setAttribute ( nsIDOMElement element , AString attributestr , AString attvalue )
nsIEditor void setAttributeOrEquivalent ( nsIDOMElement element , AString sourceAttrName , AString sourceAttrValue , PRBool suppressTransaction )
nsIHTMLEditor void setBackgroundColor ( AString color )
nsIHTMLEditor void setBodyAttribute ( AString attr , AString value )
nsIHTMLEditor void setCaretAfterElement ( nsIDOMElement element )
nsIEditorIMESupport [noscript] void setCompositionString ( DOMString compositionString , nsIPrivateTextRangeListPtr textRange , nsTextEventReplyPtr* reply )
nsIHTMLEditor void setCSSInlineProperty ( nsIAtom property , AString attribute , AString value )
nsIHTMLEditor void setDocumentTitle ( AString title )
nsIHTMLEditor void setInlineProperty ( nsIAtom property , AString attribute , AString value )
nsIHTMLEditor void setParagraphFormat ( AString paragraphFormat )
nsITableEditor void setSelectionAfterTableEdit ( nsIDOMElement table , PRInt32 row , PRInt32 col , PRInt32 direction , PRBool selected )
nsIEditor void setShouldTxnSetSelection ( PRBool should )
nsIEditor void setSpellcheckUserOverride ( PRBool enable )
nsIPlaintextEditor void setWrapColumn ( PRInt32 wrapColumn )
nsIEditor PRBool shouldTxnSetSelection ( )
nsIHTMLObjectResizer void showResizers ( nsIDOMElement resizedElement )
nsIEditor void splitNode ( nsIDOMNode existingRightNode , PRInt32 offset , out nsIDOMNode newLeftNode )
nsITableEditor void splitTableCell ( )
nsIEditorMailSupport void stripCites ( )
nsITableEditor nsIDOMElement switchTableCellHeaderType ( nsIDOMElement sourceCell )
nsIEditor void switchTextDirection ( )
nsIEditor void syncRealTimeSpell ( )
nsIEditor void undo ( PRUint32 count )
nsIHTMLEditor void updateBaseURL ( )

Reference documentation is generated from Mozilla's source.