Class
SubMenuProvider
lucee.Component
contentbox.models.menu.providers.BaseProvider
contentbox.models.menu.providers.SubMenuProvider
All Implemented Interfaces:
ContentBox - A Modular Content Platform
Copyright since 2012 by Ortus Solutions, Corp
www.ortussolutions.com/products/contentbox
---
Provider for SubMenu-type menu items
Class Attributes:
synchronized
: false
accessors
: true
persistent
: false
Property Summary
type
property
default
serializable
required
any
menuService
access = public
returntype = any
inject = id:menuService@cb
true
false
any
requestService
access = public
returntype = any
inject = coldbox:requestService
true
false
Constructor Summary
init ()
Constructor.
Methods inherited from class contentbox.models.menu.providers.BaseProvider
getDescription , getEntityName , getIconClass , getName , getRenderer , getType , setDescription , setEntityName , setIconClass , setName , setRenderer , setType
Methods inherited from class lucee.Component
None
init
public init ()
Constructor
menuService
property any
menuService
Attributes:
access
- public
required
- false
returntype
- any
inject
- id:menuService@cb
serializable
- true
requestService
property any
requestService
Attributes:
access
- public
required
- false
returntype
- any
inject
- coldbox:requestService
serializable
- true
getAdminTemplate
public string getAdminTemplate (any menuItem, struct options='[runtime expression]')
Retrieves template for use in admin screens for this type of menu item provider
Specified by:
getAdminTemplate
in interface
IMenuItemProvider
Parameters:
menuItem
- The menu item object
options
- Additional arguments to be used in the method
getDisplayTemplate
public string getDisplayTemplate (any menuItem, struct options='[runtime expression]')
Retrieves template for use in rendering menu item on the site
Specified by:
getDisplayTemplate
in interface
IMenuItemProvider
Parameters:
menuItem
- The menu item object
options
- Additional arguments to be used in the method
getMenuService
public string getMenuService ()
getRequestService
public string getRequestService ()
setMenuService
public any setMenuService (any menuService)
Parameters:
menuService
setRequestService
public any setRequestService (any requestService)
Parameters:
requestService