ContentBox Core API 1.6.0

contentbox.model.ui.admin
Class AdminThemeService

WEB-INF.cftags.component
        extended by contentbox.model.ui.admin.AdminThemeService

public class AdminThemeService
extends WEB-INF.cftags.component

******************************************************************************* 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 ContentBox Admin Themes

Property Summary
Type Property & Description Default Serializable Required
 any settingService


Attributes:
  • inject = settingService@cb
true false
 struct themes


Attributes:
true false
 
Constructor Summary
init(any wirebox)
          Constructor
 
Method Summary
 any GETSETTINGSERVICE()
          get:
 struct GETTHEMES()
          get:
 AdminThemeService SETSETTINGSERVICE(any settingService)
          set:
 AdminThemeService SETTHEMES(struct themes)
          set:
 IAdminTheme getCurrentTheme()
          Get the current theme object
 string getDefaultTheme()
          Get the default admin theme setting
 array getRegisteredThemes()
          Get an array of registered theme names in alphabetical order
 array getRegisteredThemesMap()
          Get an array of registered theme names in alphabetical order with their display names
 IAdminTheme getTheme(any name)
          Get a registered theme instance
 AdminThemeService registerTheme(IAdminTheme theme)
          Register a new admin theme in ContentBox
 AdminThemeService unregisterTheme(any name)
          UnRegister a theme in ContentBox
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any wirebox)
Constructor

Parameters:
wirebox
Property Detail

settingService

any settingService

Attributes:
inject - settingService@cb
required - false
serializable - true
default -

themes

struct themes

Attributes:
default -
serializable - true
required - false

Method Detail

GETSETTINGSERVICE

public any GETSETTINGSERVICE()
get:


GETTHEMES

public struct GETTHEMES()
get:


SETSETTINGSERVICE

public AdminThemeService SETSETTINGSERVICE(any settingService)
set:

Parameters:
settingService

SETTHEMES

public AdminThemeService SETTHEMES(struct themes)
set:

Parameters:
themes

getCurrentTheme

public IAdminTheme getCurrentTheme()
Get the current theme object


getDefaultTheme

public string getDefaultTheme()
Get the default admin theme setting


getRegisteredThemes

public array getRegisteredThemes()
Get an array of registered theme names in alphabetical order


getRegisteredThemesMap

public array getRegisteredThemesMap()
Get an array of registered theme names in alphabetical order with their display names


getTheme

public IAdminTheme getTheme(any name)
Get a registered theme instance

Parameters:
name

registerTheme

public AdminThemeService registerTheme(IAdminTheme theme)
Register a new admin theme in ContentBox

Parameters:
theme

unregisterTheme

public AdminThemeService unregisterTheme(any name)
UnRegister a theme in ContentBox

Parameters:
name

ContentBox Core API 1.6.0