Class \Prado\Web\UI\WebControls\TColorPicker

TColorPicker class.

TColorPicker displays a text box for color input purpose. Next to the textbox there's a button filled with the current chosen color. Users can write a color name directly in the text box as an hex triplet (also known as HTML notation, eg: #FF00FF). Alternatively, if the ShowColorPicker property is enabled (it is by default), users can click the button to have a color picker UI appear. A color chan be chosen directly by clicking on the color picker.

TColorPicker has three different color picker UI Modes:

Simple - Grid with 12 simple colors.

Basic - Grid with the most common 70 colors. This is the default mode.

Full - Full-featured color picker.

The CssClass property can be used to override the CSS class name for the color picker panel. The ColorStyle property sets the packages styles available. E.g. default.

If the Mode property is set to Full, the color picker panel will display an "Ok" and "Cancel" buttons. You can customize the button labels setting the OKButtonText and CancelButtonText properties.

Class hierarchy

\Prado\Web\UI\WebControls\TColorPicker

\Prado\Web\UI\WebControls\TTextBox implements IPostBackDataHandler, IValidatable, IDataRenderer

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.0

Methods summary
`public`	`getCancelButtonText() : string`
`public`	`getClientSide() : TColorPickerClientSide`
`public`	`getColorPickerStyle() : string`
`public`	`getMode() : TColorPickerMode`
`public`	`getOKButtonText() : string`
`public`	`getShowColorPicker() : bool`
`public`	`onPreRender(mixed $param) : mixed` Publish the color picker Css asset files.
`public`	`renderEndTag(THtmlWriter $writer) : mixed` Renders additional body content. This method overrides parent implementation by adding additional color picker button.
`public`	`setCancelButtonText(string $value) : mixed`
`public`	`setColorPickerStyle(string $value) : mixed`
`public`	`setMode(TColorPickerMode $value) : mixed`
`public`	`setOKButtonText(string $value) : mixed`
`public`	`setShowColorPicker(bool $value) : mixed` Sets whether to pop up the color picker when the button is clicked.
`protected`	`createClientSide() : TColorPickerClientSide`
`protected`	`getAssetUrl([string $file = '' ]) : string`
`protected`	`getClientClassName() : string` Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.
`protected`	`getPostBackOptions() : array<string\|int, mixed>` Get javascript color picker options.
`protected`	`publishColorPickerAssets() : mixed` Publish the color picker assets.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoCompleteType, getAutoGlobalListen, getAutoPostBack, getAutoTrim, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getCausesValidation, getClassHierarchy, getClientID, getColumns, getConfig, getControls, getCssClass, getCustomData, getData, getDataChanged, getDecorator, getDisplay, getEnableClientScript, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getIsValid, getListeningToGlobalEvents, getMaxLength, getNamingContainer, getPage, getParent, getPersistPassword, getPluginModule, getReadOnly, getRegisteredObject, getRequest, getResponse, getRows, getSafeText, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getText, getTextMode, getToolTip, getUniqueID, getUser, getValidationGroup, getValidationPropertyValue, getViewState, getVisible, getWidth, getWrap, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadPostData, loadState, onDataBinding, onInit, onLoad, onPreRender, onTextChanged, onUnload, publishAsset, publishFilePath, raiseEvent, raisePostDataChangedEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setAutoCompleteType, setAutoPostBack, setAutoTrim, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCausesValidation, setColumns, setConfig, setCssClass, setCustomData, setData, setDisplay, setEnableClientScript, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setIsValid, setMaxLength, setPage, setPersistPassword, setReadOnly, setRows, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setText, setTextMode, setToolTip, setValidationGroup, setViewState, setVisible, setWidth, setWrap, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getClientClassName, getControlStage, getControlState, getPostBackOptions, getSafeTextParser, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, renderClientControlScript, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`SCRIPT_PATH`	`'colorpicker'`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\Web\UI\WebControls\TTextBox::DEFAULT_COLUMNS, \Prado\Web\UI\WebControls\TTextBox::DEFAULT_ROWS, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TColorPicker

Simple - Grid with 12 simple colors.

Basic - Grid with the most common 70 colors. This is the default mode.

Full - Full-featured color picker.

Class hierarchy