contentbox.widgets

Class SubPageMenu

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by contentbox.models.ui.BaseWidget
        extended by contentbox.widgets.SubPageMenu

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- A widget that renders sub pages according to where it is rendered.

Class Attributes:
  • singleton
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
    Constructor Summary
    init()
    Method Summary
    array getSlugList()
         Return an array of slug lists, the @ignore annotation means the ContentBox widget editors do not use it only used internally.
    any renderIt([string page], [string excludes], [string type='ul'], [string separator=''], [boolean showNone='true'], [numeric levels='1'], [any parentClass='parent'], [any activeClass='active'], [boolean activeShowChildren='false'])
         Renders a ContentBox sub page menu according to where it is rendered.
     
    Methods inherited from class contentbox.models.ui.BaseWidget
    getAuthor, getAuthorService, getAuthorURL, getCategory, getCategoryService, getCb, getCommentService, getContentService, getContentStoreService, getContentVersionService, getDescription, getEntryService, getForgeBoxSlug, getHtml, getIcon, getLog, getMenuService, getName, getPageService, getPublicMethods, getSecurityService, getVersion, setAuthor, setAuthorService, setAuthorURL, setCategory, setCategoryService, setCb, setCommentService, setContentService, setContentStoreService, setContentVersionService, setDescription, setEntryService, setForgeBoxSlug, setHtml, setIcon, setLog, setMenuService, setName, setPageService, setSecurityService, setVersion
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    addAsset, announceInterception, getCache, getController, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getRequestCollection, getRequestContext, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Method Detail

    getSlugList

    public array getSlugList()

    Return an array of slug lists, the @ignore annotation means the ContentBox widget editors do not use it only used internally.

    renderIt

    public any renderIt([string page], [string excludes], [string type='ul'], [string separator=''], [boolean showNone='true'], [numeric levels='1'], [any parentClass='parent'], [any activeClass='active'], [boolean activeShowChildren='false'])

    Renders a ContentBox sub page menu according to where it is rendered

    Overrides:
    renderIt in class BaseWidget
    Parameters:
    page - Optional page to create sub page menu for, else look for current page, this can be a page object or a page slug
    excludes - The list of pages to exclude from the menu
    type - The type of menu, valid choices are: ul,ol,li,none
    separator - Used if type eq none, to separate the list of href's
    showNone - Shows a 'No Sub Pages' message or not
    levels - The number of levels to nest hierarchical pages, by default it does only 1 level, * does all levels
    parentClass - The name of the CSS class to attach to the menu
  • element when it has nested elements, by default it is 'parent'
    • activeClass - The name of the CSS class to attach to the menu
  • element when that element is the current page you are on, by default it is 'active'
    • activeShowChildren - If true, then we will show the children of the active menu element, else we just show the active element