Inheritance diagram for ColorPicker:

Public Member Functions
	__construct (ContextInterface $context, ColorModesProvider $modesProvider, array $components=[], array $data=[])

	getComponentName ()

	prepare ()

Public Member Functions inherited from AbstractElement
	getHtmlId ()

	getValue ()

	getFormInputName ()

	isReadonly ()

	getCssClasses ()

Public Member Functions inherited from AbstractComponent
	__construct (ContextInterface $context, array $components=[], array $data=[])

	getContext ()

	getName ()

	prepare ()

	toHtml ()

	render ()

	addComponent ($name, UiComponentInterface $component)

	getComponent ($name)

	getChildComponents ()

	renderChildComponent ($name)

	getTemplate ()

	getConfiguration ()

	getJsConfig (UiComponentInterface $component)

	setData ($key, $value=null)

	getData ($key='', $index=null)

	prepareDataSource (array $dataSource)

	getDataSourceData ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	NAME = 'colorPicker'

const	DEFAULT_MODE = 'full'

Additional Inherited Members
Protected Member Functions inherited from AbstractComponent
	prepareChildComponent (UiComponentInterface $component)

	initObservers (array & $data=[])

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes inherited from AbstractComponent
	$context

	$components

	$componentData = []

	$dataSources = []

Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Prepares Color Picker UI component with mode and format

@api

Definition at line 21 of file ColorPicker.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ContextInterface	$context,
		ColorModesProvider	$modesProvider,
		array	$components = `[]`,
		array	$data = `[]`
	)

Constructor

Parameters

ContextInterface	$context
ColorModesProvider	$modesProvider
UiComponentFactory	$uiComponentFactory
	UiComponentInterface[]	$components
array	$data

Definition at line 43 of file ColorPicker.php.

       {
         $this->modesProvider = $modesProvider;
         parent::__construct($context, $components, $data);
     }

Member Function Documentation

◆ getComponentName()

getComponentName ( )

Get component name

Returns: string

Implements UiComponentInterface.

Definition at line 58 of file ColorPicker.php.

                                       : string
     {
         return static::NAME;
     }

◆ prepare()

prepare ( )

Prepare component configuration

Returns: void

Implements UiComponentInterface.

Definition at line 68 of file ColorPicker.php.

                               : void
     {
         $modes = $this->modesProvider->getModes();
         $colorPickerModeSetting = $this->getData('config/colorPickerMode');
         $colorFormatSetting = $this->getData('config/colorFormat');
         $colorPickerMode = $modes[$colorPickerModeSetting] ?? $modes[self::DEFAULT_MODE];
         $colorPickerMode['preferredFormat'] = $colorFormatSetting;
         $this->_data['config']['colorPickerConfig'] = $colorPickerMode;
 
         parent::prepare();
     }

Field Documentation

◆ DEFAULT_MODE

const DEFAULT_MODE = 'full'

Definition at line 25 of file ColorPicker.php.

◆ NAME

const NAME = 'colorPicker'

Definition at line 23 of file ColorPicker.php.

The documentation for this class was generated from the following file:

vendor/magento/module-ui/Component/Form/Element/ColorPicker.php

Public Member Functions

Data Fields

Additional Inherited Members