contentbox.model.ui.editors

Class EditorService

railo-context.Component
        extended by contentbox.model.ui.editors.EditorService
Class Attributes:
  • threadsafe
  •  
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  

    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. Manages editor services

    Property Summary
    type property default serializable required
    struct editors


    true false
    struct markups


    true false
    any settingService


    • inject = settingService@cb
    true false
    Constructor Summary
    init(any wirebox)
          Constructor.
    Method Summary
    string getDefaultEditor()
         Get the default system editor.
    string getDefaultMarkup()
         Get the default system markup.
    IEditor getEditor(any name)
         Get a registered editor instance.
    string getEditors()
    string getMarkups()
    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.
    string getSettingService()
    boolean hasEditor(any name)
         Check if an editor exists or not.
    boolean hasMarkup(any markup)
         Check if an markup exists or not.
    EditorService registerEditor(IEditor editor)
         Register a new editor in ContentBox.
    EditorService registerMarkup(any markup)
         Register a new markup in ContentBox.
    any setEditors(struct editors)
    any setMarkups(struct markups)
    any setSettingService(any settingService)
    EditorService unRegisterEditor(any name)
         UnRegister an editor in ContentBox.
    EditorService unRegisterMarkup(any markup)
         UnRegister a markup in ContentBox.
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init(any wirebox)

    Constructor

    Parameters:
    wirebox

    Property Detail

    editors

    property struct editors

    Attributes:
    required - false
    serializable - true

    markups

    property struct markups

    Attributes:
    required - false
    serializable - true

    settingService

    property any settingService

    Attributes:
    required - false
    inject - settingService@cb
    serializable - true

    Method Detail

    getDefaultEditor

    public string getDefaultEditor()

    Get the default system editor


    getDefaultMarkup

    public string getDefaultMarkup()

    Get the default system markup


    getEditor

    public IEditor getEditor(any name)

    Get a registered editor instance

    Parameters:
    name - The name of the editor

    getEditors

    public string getEditors()


    getMarkups

    public string getMarkups()


    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


    getSettingService

    public string getSettingService()


    hasEditor

    public boolean hasEditor(any name)

    Check if an editor exists or not

    Parameters:
    name - The name of the editor

    hasMarkup

    public boolean hasMarkup(any markup)

    Check if an markup exists or not

    Parameters:
    markup - The name of the markup

    registerEditor

    public EditorService registerEditor(IEditor editor)

    Register a new editor in ContentBox

    Parameters:
    editor - The editor instance to register

    registerMarkup

    public EditorService registerMarkup(any markup)

    Register a new markup in ContentBox

    Parameters:
    markup - The markup name to register

    setEditors

    public any setEditors(struct editors)

    Parameters:
    editors

    setMarkups

    public any setMarkups(struct markups)

    Parameters:
    markups

    setSettingService

    public any setSettingService(any settingService)

    Parameters:
    settingService

    unRegisterEditor

    public EditorService unRegisterEditor(any name)

    UnRegister an editor in ContentBox

    Parameters:
    name - The name of the editor to unregister

    unRegisterMarkup

    public EditorService unRegisterMarkup(any markup)

    UnRegister a markup in ContentBox

    Parameters:
    markup - The markup name to unregister