contentbox.model.ui.editors

Interface IEditor

contentbox.model.ui.editors.IEditor
Class Attributes:
None
All Known Implementing Classes:
CKEditor , EditAreaEditor , TextareaEditor

ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Interface to implement ContentBox editors

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.