ContentBox Core API 1.5.7

contentbox.model.ui.editors
Class EditorService

WEB-INF.cftags.component
        extended by contentbox.model.ui.editors.EditorService

public class EditorService
extends WEB-INF.cftags.component

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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. ******************************************************************************* Manages editor services


Constructor Summary
init(any wirebox)
          Constructor
 
Method Summary
 struct GETEDITORS()
 struct GETMARKUPS()
 any GETSETTINGSERVICE()
 void SETEDITORS(struct editors)
 void SETMARKUPS(struct markups)
 void SETSETTINGSERVICE(any settingService)
 any getDefaultEditor()
          Get the default system editor
 any getDefaultMarkup()
          Get the default system markup
 IEditor getEditor(any name)
          Get a registered editor instance
 array getRegisteredEditors()
          Get an array of registered editor names in alphabetical order
 array getRegisteredEditorsMap()
          Get an array of registered editor names in alphabetical order with their display names
 array getRegisteredMarkups()
          Get an array of registered markup names in alphabetical order
 EditorService registerEditor(IEditor editor)
          Register a new editor in ContentBox
 EditorService registerMarkup(string markup)
          Register a new markup in ContentBox
 EditorService unRegisterEditor(any name)
          UnRegister an editor in ContentBox
 EditorService unRegisterMarkup(string markup)
          UnRegister a markup in ContentBox
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any wirebox)
Constructor

Parameters:
wirebox
Method Detail

GETEDITORS

public struct GETEDITORS()


GETMARKUPS

public struct GETMARKUPS()


GETSETTINGSERVICE

public any GETSETTINGSERVICE()


SETEDITORS

public void SETEDITORS(struct editors)

Parameters:
editors

SETMARKUPS

public void SETMARKUPS(struct markups)

Parameters:
markups

SETSETTINGSERVICE

public void SETSETTINGSERVICE(any settingService)

Parameters:
settingService

getDefaultEditor

public any getDefaultEditor()
Get the default system editor


getDefaultMarkup

public any getDefaultMarkup()
Get the default system markup


getEditor

public IEditor getEditor(any name)
Get a registered editor instance

Parameters:
name

getRegisteredEditors

public array getRegisteredEditors()
Get an array of registered editor names in alphabetical order


getRegisteredEditorsMap

public array getRegisteredEditorsMap()
Get an array of registered editor names in alphabetical order with their display names


getRegisteredMarkups

public array getRegisteredMarkups()
Get an array of registered markup names in alphabetical order


registerEditor

public EditorService registerEditor(IEditor editor)
Register a new editor in ContentBox

Parameters:
editor

registerMarkup

public EditorService registerMarkup(string markup)
Register a new markup in ContentBox

Parameters:
markup

unRegisterEditor

public EditorService unRegisterEditor(any name)
UnRegister an editor in ContentBox

Parameters:
name

unRegisterMarkup

public EditorService unRegisterMarkup(string markup)
UnRegister a markup in ContentBox

Parameters:
markup

ContentBox Core API 1.5.7