CSSkin extends CSSkinWrapper

in package

• Core
• GUI
• Skin

Abstract class to serve as a base structure for multiple CSSkin's classes

Tags

Table of Contents

COLOR_ACCENT  = 'ColorAccent'

COLOR_ACCENT_DEFAULT  = self::COLOR_SECONDARY_DEFAULT

COLOR_BACKGROUND  = 'ColorBackground'

COLOR_BACKGROUND_DEFAULT  = '#FFFFFF'

COLOR_BLACK  = 'ColorBlack'

COLOR_BLACK_BLUE  = 'ColorBlackBlue'

COLOR_BLUE  = 'ColorBlue'

COLOR_BORDER  = 'ColorBorder'

COLOR_BORDER_DEFAULT  = '#3F587D10'

COLOR_CS_BLUE  = 'ColorCSBlue'

COLOR_CS_BLUE_DARK  = 'ColorCSBlueDark'

COLOR_CS_BLUE_LIGHT  = 'ColorCSBlueLight'

COLOR_CS_MAGENTA  = 'ColorCSMagenta'

COLOR_CS_TURQUOISE  = 'ColorCSTurquoise'

COLOR_DIALOG_TITLE_BACKGROUND  = 'ColorDialogTitleBackground'

COLOR_DIALOG_TITLE_BACKGROUND_DEFAULT  = '#FFFFFF'

COLOR_DIALOG_TITLE_FONT  = 'ColorDialogTitleFont'

COLOR_DIALOG_TITLE_FONT_DEFAULT  = self::COLOR_FONT_DEFAULT

COLOR_ERROR_200  = 'ColorError200'

COLOR_ERROR_600  = 'ColorError600'

The variants of the default error colors for the new UI design.

COLOR_FONT  = 'ColorFont'

COLOR_FONT_DEFAULT  = '#191D23'

COLOR_FONT_LINK  = 'ColorFontLink'

COLOR_FONT_LINK_DEFAULT  = '#426BDF'

COLOR_GRAY  = 'ColorGray'

COLOR_GRAY_LIGHT  = 'ColorGrayLight'

COLOR_GREEN  = 'ColorGreen'

COLOR_HEADER_BACKGROUND  = 'ColorHeaderBackground'

COLOR_HEADER_BACKGROUND_DEFAULT  = self::COLOR_PRIMARY_DEFAULT

COLOR_HEADER_FONT  = 'ColorHeaderFont'

COLOR_HEADER_FONT_DEFAULT  = '#FFFFFF'

COLOR_HEADER_SELECTED_FONT  = 'ColorHeaderSelectedFont'

COLOR_HEADER_SELECTED_FONT_DEFAULT  = '#FFFFFF'

COLOR_INFORMATION_DEFAULT  = 'ColorInfoDefault'

COLOR_INFORMATION_ERROR  = 'ColorInfoError'

COLOR_INFORMATION_SUCCESS  = 'ColorInfoSuccess'

COLOR_INFORMATION_WARNING  = 'ColorInfoWarning'

COLOR_INPUT_BORDER  = 'ColorInputBorder'

COLOR_INPUT_BORDER_FOCUS  = 'ColorInputBorderFocus'

COLOR_INPUT_BORDER_HOVER  = 'ColorInputBorderHover'

COLOR_LIST_HOVER  = 'ColorListHover'

COLOR_LIST_SELECTED  = 'ColorListSelected'

COLOR_LOGIN_BACKGROUND  = 'ColorLoginBackground'

COLOR_LOGIN_BACKGROUND_DEFAULT  = self::COLOR_PRIMARY_DEFAULT

COLOR_LOGIN_FONT  = 'ColorLoginFont'

COLOR_LOGIN_FONT_DEFAULT  = '#FFFFFF'

COLOR_LOGIN_FOREGROUND  = 'ColorLoginForeground'

COLOR_LOGIN_FOREGROUND_DEFAULT  = self::COLOR_SECONDARY_DEFAULT

COLOR_ORANGE  = 'ColorOrange'

COLOR_POPUP_MENU_BACKGROUND  = 'ColorPopupMenuBackground'

COLOR_POPUP_MENU_BACKGROUND_DEFAULT  = '#FFFFFF'

COLOR_POPUP_MENU_FONT  = 'ColorPopupMenuFont'

COLOR_POPUP_MENU_FONT_DEFAULT  = self::COLOR_FONT_DEFAULT

COLOR_POPUP_MENU_SELECTION  = 'ColorPopupMenuSelection'

COLOR_POPUP_MENU_SELECTION_DEFAULT  = '#3F587D10'

COLOR_PRIMARY  = 'ColorPrimary'

COLOR_PRIMARY_100  = 'ColorPrimary100'

COLOR_PRIMARY_20  = 'ColorPrimary20'

COLOR_PRIMARY_200  = 'ColorPrimary200'

COLOR_PRIMARY_300  = 'ColorPrimary300'

COLOR_PRIMARY_400  = 'ColorPrimary400'

COLOR_PRIMARY_50  = 'ColorPrimary50'

COLOR_PRIMARY_500  = 'ColorPrimary500'

COLOR_PRIMARY_600  = 'ColorPrimary600'

COLOR_PRIMARY_700  = 'ColorPrimary700'

COLOR_PRIMARY_800  = 'ColorPrimary800'

COLOR_PRIMARY_900  = 'ColorPrimary900'

The variants of the default primary color for the new UI design.

COLOR_PRIMARY_DEFAULT  = '#221F61'

COLOR_PRIMARY_FOREGROUND  = 'ColorPrimaryForeground'

The foreground colors for the primary & secondary color, which should be used for icon & text.

COLOR_PURPLE  = 'ColorPurple'

COLOR_RED  = 'ColorRed'

COLOR_SECONDARY  = 'ColorSecondary'

COLOR_SECONDARY_300  = 'ColorSecondary300'

COLOR_SECONDARY_400  = 'ColorSecondary400'

COLOR_SECONDARY_50  = 'ColorSecondary50'

COLOR_SECONDARY_500  = 'ColorSecondary500'

COLOR_SECONDARY_600  = 'ColorSecondary600'

COLOR_SECONDARY_700  = 'ColorSecondary700'

The variants of the default secondary color for the new UI design.

COLOR_SECONDARY_DEFAULT  = '#FE0074'

COLOR_SECONDARY_FOREGROUND  = 'ColorSecondaryForeground'

COLOR_SEPARATOR  = 'ColorSeparator'

COLOR_STUDIO_BAR_BACKGROUND  = 'ColorStudioBarBackground'

COLOR_STUDIO_BAR_BACKGROUND_DEFAULT  = self::COLOR_PRIMARY_DEFAULT

COLOR_STUDIO_BAR_FOREGROUND  = 'ColorStudioBarForeground'

COLOR_STUDIO_BAR_FOREGROUND_DEFAULT  = '#FFFFFF'

COLOR_STUDIO_BAR_SELECTED_FOREGROUND  = 'ColorStudioBarSelectedBackground'

COLOR_STUDIO_BAR_SELECTED_FOREGROUND_DEFAULT  = '#3A3783'

COLOR_TOOLBAR_BACKGROUND  = 'ColorToolbarBackground'

COLOR_TOOLBAR_BACKGROUND_DEFAULT  = '#FFFFFF'

COLOR_TOOLBAR_FONT  = 'ColorToolbarFont'

COLOR_TOOLBAR_FONT_DEFAULT  = self::COLOR_FONT_DEFAULT

COLOR_TOOLBAR_ICON  = 'ColorToolbarIcon'

COLOR_TOOLBAR_ICON_DEFAULT  = self::COLOR_FONT_DEFAULT

COLOR_TREE_BACKGROUND  = 'ColorTreeBackground'

COLOR_TREE_BACKGROUND_DEFAULT  = '#F3F5F7'

COLOR_TREE_ICON  = 'ColorTreeIcon'

COLOR_TREE_ICON_DEFAULT  = '#535961'

COLOR_TREE_SELECTION  = 'ColorTreeSelection'

COLOR_TREE_SELECTION_DEFAULT  = self::COLOR_SECONDARY_DEFAULT

COLOR_VIOLET  = 'ColorViolet'

COLOR_YELLOW  = 'ColorYellow'

LOGO_TYPE_LARGE  = 0

Logo types

LOGO_TYPE_SMALL  = 1

TOOLBAR_EXPAND_MENU  = 'ToolbarExpandMenu'

addTransparencyToHexColor()  : string

Adds the transparency part of the hex color based on a percentage. It will also overwrite already defined alpha channel in the color code.

createCSSFiles()  : mixed

Creates all CSS files required

getApplicationLogo()  : int|null

Method that retrieves the Theme logo's if in presence of a configured Theme, or the ones from the general settings.

getApplicationLogoForType()  : string

Returns the URL to the configured or standard application SVG logo.

getBottomBarBackgroundColor()  : string

getButtonBackgroundColor()  : string

getColor()  : mixed|null

Get a specific color based in a given token

getColorAccent()  : string

getColorBackground()  : string

getColorBorder()  : string

getColorDialogTitleBackground()  : string

getColorDialogTitleFont()  : string

getColorFont()  : string

getColorFontLink()  : string

getColorForBackgroundColor()  : the

Returns a foreground color recommended in front of a given background color

getColorForPrimaryColor()  : string

Returns the foreground color recommended in front of the primary color.

getColorForSecondaryColor()  : string

Returns the foreground color recommended in front of the secondary color.

getColorHeaderBackground()  : string

getColorHeaderFont()  : string

getColorHeaderSelectedFont()  : string

getColorLoginBackground()  : string

Returns the login background color which is defined in the skin options.

getColorLoginFont()  : string

Returns the login font color which is defined in the skin options.

getColorLoginForeground()  : string

Returns the login background color which is defined in the skin options.

getColorPopupMenuBackground()  : string

getColorPopupMenuFont()  : string

Gets the font color to be used on popup menus. If no color is defined, we dynamically calculate the font color based on COLOR_POPUP_MENU_BACKGROUND

getColorPopupMenuIcon()  : string

Tells the configured color of the popup menu icons

getColorPopupMenuSelection()  : string

getColorPrimary()  : string

Returns the color value of the primary color.

getColors()  : array<string|int, mixed>

Get all the colors defined

getColorSecondary()  : string

Returns the color value of the secondary color.

getColorStudioBarBackground()  : string

getColorStudioBarForeground()  : string

getColorStudioBarSelectedBackground()  : string

getColorToolbarBackground()  : string

getColorToolbarFont()  : string

getColorToolbarIcon()  : string

getColorTreeBackground()  : string

Defines the tree background color

getColorTreeIcon()  : string

Tells the configured color of the tree icons

getColorTreeSelection()  : string

getHeaderBackgroundColor()  : string

Older Version used before naming convention

getHeaderForegroundColor()  : string

Older Version used before naming convention

getHeaderLogo()  : string

getHeaderSelectedForegroundColor()  : string

Older Version used before naming convention

getHexColorFromBrightness()  : string

Calculates a new hex color based on a level of brightness

getLoginBackground()  : string

getLoginBackgroundFile()  : CSMamFile

getLoginLogo()  : string

getLoginTitle()  : string

getLuminance()  : float

This algorithm is taken from a formula for converting RGB values to YIQ values.

getOptionNames()  : string

Tells which option names are available

getParam()  : string

Returns a specific parameter value by name

getParamNames()  : array<string|int, mixed>

Returns which parameter names are available

getStandardColors()  : mixed

getStandardLuminance()  : float

Calculates the relative luminance which is the Standard way to calculate luminance

getStylesheetLink()  : string

getTableRowBackgroundColorEven()  : string

Defines the background color for even table rows

getTableRowBackgroundColorOdd()  : string

Defines the background color for odd table rows

getTabPaneBackgroundColor()  : mixed

getToolbarBorderColor()  : string

getToolbarIconColor()  : string

isBrightColor()  : bool

Tells if a color is bright against a dark background

isDarkColor()  : bool

Tells if a color is dark against a white background

isMenuBarExpanded()  : bool

parseColorParameter()  : mixed|null