IEditor

contentbox.models.ui.editors

Interface IEditor

contentbox.models.ui.editors.IEditor

All Known Implementing Classes:

TextareaEditor , CKEditor , MarkdownEditor

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Interface to implement ContentBox editors

Class Attributes:

None

Method Summary
`any`	getDisplayName() Get the display name of an editor.
`any`	getName() Get the internal name of an editor.
`any`	loadAssets() This is fired once editor javascript loads, you can use this to return back functions, asset calls, etc.
`any`	shutdown() Shutdown the editor(s) on a page.
`any`	startup() Startup the editor(s) on a page.

Method Detail

getDisplayName

public any getDisplayName()

Get the display name of an editor

getName

public any getName()

Get the internal name of an editor

loadAssets

public any loadAssets()

This is fired once editor javascript loads, you can use this to return back functions, asset calls, etc. return the appropriate JavaScript. Each editor must implement the following JS functions: checkIsDirty() - Checks if the editor has detected any changes
getEditorContent() - Get's the HTML value of the content field
getEditorExcerpt() - Get's the HTML value of the excerpt field
updateEditorContent() - Updates the HTML value of the content field from the editor (if editor supports it)
updateEditorExcerpt() - Updates the HTML value of the excerpt field from the editor (if editor supports it)

shutdown

public any shutdown()

Shutdown the editor(s) on a page. This method is called inline within our dynamic JavaScript and must return the appropriate JavaScript to turn off the editor.

startup

public any startup()

Startup the editor(s) on a page. This method is called inline within our dynamic JavaScript and must return the appropriate JavaScript to turn on the editor.