CSSkinNeutral 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_PRIMARY  = 'ColorPrimary'

The variants of the Brand colors.

COLOR_PRIMARY_DEFAULT  = '#221F61'

COLOR_PRIMARY_DEFERRED  = 'ColorPrimaryDeferred'

COLOR_PRIMARY_DEFERRED_FOREGROUND  = 'ColorPrimaryDeferredForeground'

COLOR_PRIMARY_FOREGROUND  = 'ColorPrimaryForeground'

COLOR_PRIMARY_HOVER  = 'ColorPrimaryHover'

COLOR_PRIMARY_HOVER_FOREGROUND  = 'ColorPrimaryHoverForeground'

COLOR_PRIMARY_TYPE_DEFERRED  = 1

COLOR_PRIMARY_TYPE_HOVER  = 2

COLOR_PRIMARY_TYPE_MAIN  = 0

The Type constants to specify what variant of primary color to retrieve

COLOR_SECONDARY  = 'ColorSecondary'

COLOR_SECONDARY_DEFAULT  = '#fe0074'

COLOR_SECONDARY_DISABLED  = 'ColorSecondaryDisabled'

COLOR_SECONDARY_DISABLED_FOREGROUND  = 'ColorSecondaryDisabledForeground'

COLOR_SECONDARY_FOREGROUND  = 'ColorSecondaryForeground'

COLOR_SECONDARY_HOVER  = 'ColorSecondaryHover'

COLOR_SECONDARY_HOVER_FOREGROUND  = 'ColorSecondaryHoverForeground'

COLOR_SECONDARY_TYPE_DISABLED  = 1

COLOR_SECONDARY_TYPE_HOVER  = 2

COLOR_SECONDARY_TYPE_MAIN  = 0

The Type constants to specify what variant of secondary color to retrieve

COLOR_SHADOW_TYPE_MEDIUM  = 1

COLOR_SHADOW_TYPE_SOFT  = 0

The Type constants to specify what variant of shadow color to retrieve

COLOR_SHADOW_TYPE_STRONG  = 2

LOGO_TYPE_LARGE  = 0

Logo types

LOGO_TYPE_SMALL  = 1

SHADOW_BASE_COLOR  = '#191D23'

The variants of the shadow colors, which are dynamically calculated from the base color

SHADOW_BASE_COLOR_MEDIUM  = 'ShadowBaseColorMedium'

SHADOW_BASE_COLOR_SOFT  = 'ShadowBaseColorSoft'

SHADOW_BASE_COLOR_STRONG  = 'ShadowBaseColorStrong'

STATUS_BLUE  = 'StatusBlue'

STATUS_BLUE_DISABLED  = 'StatusBlueDisabled'

STATUS_BLUE_HOVER  = 'StatusBlueHover'

STATUS_GREEN  = 'StatusGreen'

The variants of the status colors.

STATUS_GREEN_DISABLED  = 'StatusGreenDisabled'

STATUS_GREEN_HOVER  = 'StatusGreenHover'

STATUS_ORANGE  = 'StatusOrange'

STATUS_ORANGE_DISABLED  = 'StatusOrangeDisabled'

STATUS_ORANGE_HOVER  = 'StatusOrangeHover'

STATUS_RED  = 'StatusRed'

STATUS_RED_DISABLED  = 'StatusRedDisabled'

STATUS_RED_HOVER  = 'StatusRedHover'

SYSTEM_FILL_10  = 'SystemFill10'

The variants of the system fill colors, they're complementary neutral colors

SYSTEM_FILL_20  = 'SystemFill20'

SYSTEM_FILL_35  = 'SystemFill35'

SYSTEM_FILL_70  = 'SystemFill70'

SYSTEM_FILL_D0  = 'SystemFillD0'

SYSTEM_FILL_FF  = 'SystemFillFF'

SYSTEM_PRIMARY_BACKGROUND  = 'SystemPrimaryBackground'

The variants of the system background colors

SYSTEM_PRIMARY_FOREGROUND  = 'SystemPrimaryForeground'

The variants of the system label/foreground colors.

SYSTEM_SECONDARY_BACKGROUND  = 'SystemSecondaryBackground'

SYSTEM_SECONDARY_FOREGROUND  = 'SystemSecondaryForeground'

SYSTEM_TERTIARY_BACKGROUND  = 'SystemTertiaryBackground'

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

getApplicationLogoForType()  : string

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

getColor()  : mixed|null

Get a specific color based in a given token

getColorForBackgroundColor()  : the

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

getColorPrimary()  : string

Returns the color value of the primary brand color.

getColorPrimaryForeground()  : string

Returns the color value of the primary brand foreground color.

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

Get all the colors defined

getColorSecondary()  : string

Returns the color value of the secondary brand color.

getColorSecondaryForeground()  : string

Returns the color value of the secondary brand foreground color.

getHexColorFromBrightness()  : string

Calculates a new hex color based on a level of brightness

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

getShadowColor()  : string

Returns the color value of a shadow variant

getStandardLuminance()  : float

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

getStylesheetLink()  : 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

parseColorParameter()  : mixed|null