contentbox.model.menu.providers

Class BaseProvider

railo-context.Component
        extended by contentbox.model.menu.providers.BaseProvider
Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Direct Known Subclasses:
    ContentProvider , FreeProvider , JSProvider , MediaProvider , SubMenuProvider , URLProvider

    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. Base Provider

    Property Summary
    type property default serializable required
    string description


    true false
    string entityName


    true false
    string iconClass


    true false
    string name


    true false
    any renderer


    • inject = provider:ColdBoxRenderer
    true false
    string type


    true false
    Method Summary
    string getDescription()
         Gets the description of the menu item provider.
    string getEntityName()
         Gets the entityName for the menu item provider.
    string getIconClass()
         Gets the iconCls of the menu item provider.
    string getName()
         Gets the name of the menu item provider.
    string getRenderer()
    string getType()
         Gets the name of the menu item provider.
    any setDescription(string description)
    any setEntityName(string entityName)
    any setIconClass(string iconClass)
    any setName(string name)
    any setRenderer(any renderer)
    any setType(string type)
     
    Methods inherited from class railo-context.Component
    None

    Property Detail

    description

    property string description

    Attributes:
    required - false
    serializable - true

    entityName

    property string entityName

    Attributes:
    required - false
    serializable - true

    iconClass

    property string iconClass

    Attributes:
    required - false
    serializable - true

    name

    property string name

    Attributes:
    required - false
    serializable - true

    renderer

    property any renderer

    Attributes:
    required - false
    inject - provider:ColdBoxRenderer
    serializable - true

    type

    property string type

    Attributes:
    required - false
    serializable - true

    Method Detail

    getDescription

    public string getDescription()

    Gets the description of the menu item provider


    getEntityName

    public string getEntityName()

    Gets the entityName for the menu item provider


    getIconClass

    public string getIconClass()

    Gets the iconCls of the menu item provider


    getName

    public string getName()

    Gets the name of the menu item provider


    getRenderer

    public string getRenderer()


    getType

    public string getType()

    Gets the name of the menu item provider


    setDescription

    public any setDescription(string description)

    Parameters:
    description

    setEntityName

    public any setEntityName(string entityName)

    Parameters:
    entityName

    setIconClass

    public any setIconClass(string iconClass)

    Parameters:
    iconClass

    setName

    public any setName(string name)

    Parameters:
    name

    setRenderer

    public any setRenderer(any renderer)

    Parameters:
    renderer

    setType

    public any setType(string type)

    Parameters:
    type