|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.ui.AdminMenuService
public class AdminMenuService
******************************************************************************* 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 the admin menu services
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
array
|
menu
Attributes: |
|
true
|
false
|
any
|
requestService
Attributes: |
|
true
|
false
|
struct
|
topMenuMap
Attributes: |
|
true
|
false
|
Constructor Summary | |
---|---|
init(any requestService, any coldbox)
Constructor |
Method Summary | |
---|---|
array |
GETMENU()
|
any |
GETREQUESTSERVICE()
|
struct |
GETTOPMENUMAP()
|
AdminMenuService |
SETMENU(array menu)
|
AdminMenuService |
SETREQUESTSERVICE(any requestService)
|
AdminMenuService |
SETTOPMENUMAP(struct topMenuMap)
|
AdminMenuService |
addSubMenu([any topMenu], any name, any label, [any title=''], [any href='#'], [any target=''], [any permissions=''], [any data='[runtime expression]'])
Add a sub level menu |
AdminMenuService |
addTopMenu(any name, any label, [any title=''], [any href='javascript:null()'], [any target=''], [any permissions=''], [any data='[runtime expression]'])
Add top level menus |
any |
buildModuleLink(string module, string linkTo, [any queryString=''], [boolean ssl='false'])
Build out ContentBox module links |
AdminMenuService |
createDefaultMenu()
Create the default ContentBox menu |
any |
generateMenu()
Generate menu from cache or newly generated menu |
string |
parseADataAttributes(Struct data)
|
AdminMenuService |
removeSubMenu(any topMenu, any name)
Remove a sub level menu |
AdminMenuService |
removeTopMenu(any topMenu)
Remove a top level menu |
AdminMenuService |
withTopMenu(any name)
Use a top menu |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any requestService, any coldbox)
requestService
coldbox
Property Detail |
---|
array menu
default
- serializable
- truerequired
- falseany requestService
default
- serializable
- truerequired
- falsestruct topMenuMap
default
- serializable
- truerequired
- falseMethod Detail |
---|
public array GETMENU()
public any GETREQUESTSERVICE()
public struct GETTOPMENUMAP()
public AdminMenuService SETMENU(array menu)
menu
public AdminMenuService SETREQUESTSERVICE(any requestService)
requestService
public AdminMenuService SETTOPMENUMAP(struct topMenuMap)
topMenuMap
public AdminMenuService addSubMenu([any topMenu], any name, any label, [any title=''], [any href='#'], [any target=''], [any permissions=''], [any data='[runtime expression]'])
topMenu
- The optional top menu name to add this sub level menu to or if concatenated then it uses that one.name
- The unique name for this sub level menulabel
- The label for the menu itemtitle
- The optional title elementhref
- The href, if any to locate when clickedtarget
- The target to execute the link in, default is same page.permissions
- The list of permissions needed to view this menudata
- A structure of data attributes to add to the linkpublic AdminMenuService addTopMenu(any name, any label, [any title=''], [any href='javascript:null()'], [any target=''], [any permissions=''], [any data='[runtime expression]'])
name
- The unique name for this top level menulabel
- The label for the menu itemtitle
- The optional title elementhref
- The href, if any to locate when clickedtarget
- The target to execute the link in, default is same page.permissions
- The list of permissions needed to view this menudata
- A structure of data attributes to add to the linkpublic any buildModuleLink(string module, string linkTo, [any queryString=''], [boolean ssl='false'])
module
linkTo
queryString
ssl
public AdminMenuService createDefaultMenu()
public any generateMenu()
public string parseADataAttributes(Struct data)
data
public AdminMenuService removeSubMenu(any topMenu, any name)
topMenu
- The optional top menu name to add this sub level menu to or if concatenated then it uses that one.name
- The unique name for this sub level menupublic AdminMenuService removeTopMenu(any topMenu)
topMenu
- The optional top menu name to add this sub level menu to or if concatenated then it uses that one.public AdminMenuService withTopMenu(any name)
name
|
ContentBox Core API 1.6.0 | ||||
FRAMES |