contentbox.model.menu.item

Class BaseMenuItem

railo-context.Component
        extended by contentbox.model.menu.item.BaseMenuItem
Class Attributes:
  • entityname : cbMenuItem
  •  
  • cacheuse : read-write
  •  
  • table : cb_menuItem
  •  
  • synchronized : false
  •  
  • cachename : cbMenuItem
  •  
  • discriminatorcolumn : menuType
  •  
  • accessors : false
  •  
  • persistent : true
  •  
    Direct Known Subclasses:
    ContentMenuItem , FreeMenuItem , JSMenuItem , MediaMenuItem , SubMenuItem , URLMenuItem

    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 entity for all subclasses of Menu Items

    Property Summary
    type property default serializable required
    any active


    • ormtype = boolean
    1 true false
    array children


    • inverse = true
    • fieldtype = one-to-many
    • cascade = all-delete-orphan
    • batchsize = 25
    • singularname = child
    • fkcolumn = FK_parentID
    • cfc = BaseMenuItem
    • lazy = extra
    true false
    any data


    • notnull = false
    • ormtype = string
    true false
    any itemClass


    • notnull = false
    • ormtype = string
    • length = 200
    true false
    any label


    • notnull = false
    • ormtype = string
    • length = 200
    true false
    any menu


    • fieldtype = many-to-one
    • notnull = true
    • fetch = join
    • fkcolumn = FK_menuID
    • cfc = contentbox.model.menu.Menu
    • lazy = true
    true false
    any menuItemID


    • fieldtype = id
    • generator = native
    • setter = no
    true false
    any menuItemService


    • inject = menuItemService@cb
    • persistent = false
    true false
    any menuType


    • insert = false
    • update = false
    true false
    any parent


    • fieldtype = many-to-one
    • fkcolumn = FK_parentID
    • cfc = BaseMenuItem
    • lazy = true
    true false
    any title


    • notnull = true
    • ormtype = string
    • index = idx_menuitemtitle
    • length = 200
    true false
    Constructor Summary
    init()
          constructor.
    Method Summary
    any addChild(any child)
    boolean canDisplay(struct options='[runtime expression]')
         Available precheck to determine display-ability of menu item.
    string getActive()
    string getAttributesAsString()
         Get a handy, formatted string of attributes that are applicable for the current menu item.
    string getChildren()
    string getData()
    string getItemClass()
    string getLabel()
    struct getMemento()
         Get a flat representation of this menu item.
    string getMenu()
    string getMenuItemID()
    string getMenuItemService()
    string getMenuType()
    string getParent()
    string getTitle()
    boolean hasChild([any child])
    boolean hasMenu([any menu])
    boolean hasParent([any parent])
    boolean removeChild(any child)
    any setActive(any active)
    any setChildren(array children)
    any setData(any data)
    any setItemClass(any itemClass)
    any setLabel(any label)
    any setMenu(any menu)
    any setMenuItemService(any menuItemService)
    any setMenuType(any menuType)
    any setParent(any parent)
    any setTitle(any title)
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init()

    constructor


    Property Detail

    active

    property any active = [1]

    Attributes:
    required - false
    ormtype - boolean
    serializable - true

    children

    property array children

    Attributes:
    required - false
    inverse - true
    fieldtype - one-to-many
    cascade - all-delete-orphan
    batchsize - 25
    singularname - child
    fkcolumn - FK_parentID
    serializable - true
    cfc - BaseMenuItem
    lazy - extra

    data

    property any data

    Attributes:
    required - false
    notnull - false
    ormtype - string
    serializable - true

    itemClass

    property any itemClass

    Attributes:
    required - false
    notnull - false
    ormtype - string
    length - 200
    serializable - true

    label

    property any label

    Attributes:
    required - false
    notnull - false
    ormtype - string
    length - 200
    serializable - true

    menu

    property any menu

    Attributes:
    required - false
    fieldtype - many-to-one
    notnull - true
    fetch - join
    fkcolumn - FK_menuID
    serializable - true
    cfc - contentbox.model.menu.Menu
    lazy - true

    menuItemID

    property any menuItemID

    Attributes:
    required - false
    fieldtype - id
    generator - native
    serializable - true
    setter - no

    menuItemService

    property any menuItemService

    Attributes:
    required - false
    inject - menuItemService@cb
    persistent - false
    serializable - true

    menuType

    property any menuType

    Attributes:
    required - false
    insert - false
    update - false
    serializable - true

    parent

    property any parent

    Attributes:
    required - false
    fieldtype - many-to-one
    fkcolumn - FK_parentID
    serializable - true
    cfc - BaseMenuItem
    lazy - true

    title

    property any title

    Attributes:
    required - false
    notnull - true
    ormtype - string
    index - idx_menuitemtitle
    length - 200
    serializable - true

    Method Detail

    addChild

    public any addChild(any child)

    Parameters:
    child

    canDisplay

    public boolean canDisplay(struct options='[runtime expression]')

    Available precheck to determine display-ability of menu item

    Parameters:
    options - Additional arguments to be used in the method

    getActive

    public string getActive()


    getAttributesAsString

    public string getAttributesAsString()

    Get a handy, formatted string of attributes that are applicable for the current menu item


    getChildren

    public string getChildren()


    getData

    public string getData()


    getItemClass

    public string getItemClass()


    getLabel

    public string getLabel()


    getMemento

    public struct getMemento()

    Get a flat representation of this menu item


    getMenu

    public string getMenu()


    getMenuItemID

    public string getMenuItemID()


    getMenuItemService

    public string getMenuItemService()


    getMenuType

    public string getMenuType()


    getParent

    public string getParent()


    getTitle

    public string getTitle()


    hasChild

    public boolean hasChild([any child])

    Parameters:
    child

    hasMenu

    public boolean hasMenu([any menu])

    Parameters:
    menu

    hasParent

    public boolean hasParent([any parent])

    Parameters:
    parent

    removeChild

    public boolean removeChild(any child)

    Parameters:
    child

    setActive

    public any setActive(any active)

    Parameters:
    active

    setChildren

    public any setChildren(array children)

    Parameters:
    children

    setData

    public any setData(any data)

    Parameters:
    data

    setItemClass

    public any setItemClass(any itemClass)

    Parameters:
    itemClass

    setLabel

    public any setLabel(any label)

    Parameters:
    label

    setMenu

    public any setMenu(any menu)

    Parameters:
    menu

    setMenuItemService

    public any setMenuItemService(any menuItemService)

    Parameters:
    menuItemService

    setMenuType

    public any setMenuType(any menuType)

    Parameters:
    menuType

    setParent

    public any setParent(any parent)

    Parameters:
    parent

    setTitle

    public any setTitle(any title)

    Parameters:
    title