|
Class 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.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TTextBox
implements
IPostBackDataHandler,
IValidatable,
IDataRenderer
-
TColorPicker
Methods summary
public
boolean
|
#
getShowColorPicker( )
Returns
boolean whether the color picker should pop up when the button is clicked.
|
public
|
#
setShowColorPicker( boolean $value )
Sets whether to pop up the color picker when the button is clicked.
Sets whether to pop up the color picker when the button is clicked.
Parameters
- $value
boolean whether to show the color picker popup
|
public
|
|
public
TColorPickerMode
|
#
getMode( )
Returns
TColorPickerMode
current color picker UI mode. Defaults to TColorPickerMode::Basic.
|
public
|
#
setColorPickerStyle( string $value )
Parameters
- $value
string set the color picker style
|
public
string
|
#
getColorPickerStyle( )
Returns
string current color picker style
|
public
string
|
#
getOKButtonText( )
Returns
string text for the color picker OK button. Default is "OK".
|
public
|
#
setOKButtonText( string $value )
Parameters
- $value
string text for the color picker OK button
|
public
string
|
#
getCancelButtonText( )
Returns
string text for the color picker Cancel button. Default is "Cancel".
|
public
|
#
setCancelButtonText( string $value )
Parameters
- $value
string text for the color picker Cancel button
|
public
TColorPickerClientSide
|
|
protected
TColorPickerClientSide
|
|
protected
array
|
#
getPostBackOptions( )
Get javascript color picker options.
Get javascript color picker options.
Returns
array color picker client-side options
Overrides
|
protected
string
|
#
getAssetUrl( string $file = '' )
Parameters
- $file
string asset file in the self::SCRIPT_PATH directory.
Returns
string asset file url.
|
public
|
#
onPreRender( TEventParameter $param )
Publish the color picker Css asset files.
Publish the color picker Css asset files.
Parameters
Overrides
|
protected
|
#
publishColorPickerAssets( )
Publish the color picker assets.
Publish the color picker assets.
|
public
|
#
renderEndTag( THtmlWriter $writer )
Renders additional body content. This method overrides parent implementation
by adding additional color picker button.
Renders additional body content. This method overrides parent implementation
by adding additional color picker button.
Parameters
Overrides
|
protected
string
|
#
getClientClassName( )
Gets the name of the javascript class responsible for performing postback for
this control. This method overrides the parent implementation.
Gets the name of the javascript class responsible for performing postback for
this control. This method overrides the parent implementation.
Returns
string the javascript class name
Overrides
|
Methods inherited from TTextBox
addAttributesToRender(),
getAutoCompleteType(),
getAutoPostBack(),
getAutoTrim(),
getCausesValidation(),
getColumns(),
getData(),
getDataChanged(),
getEnableClientScript(),
getIsValid(),
getMaxLength(),
getPersistPassword(),
getReadOnly(),
getRows(),
getSafeText(),
getSafeTextParser(),
getTagName(),
getText(),
getTextMode(),
getValidationGroup(),
getValidationPropertyValue(),
getWrap(),
loadPostData(),
onTextChanged(),
raisePostDataChangedEvent(),
renderBeginTag(),
renderClientControlScript(),
renderContents(),
setAutoCompleteType(),
setAutoPostBack(),
setAutoTrim(),
setCausesValidation(),
setColumns(),
setData(),
setEnableClientScript(),
setIsValid(),
setMaxLength(),
setPersistPassword(),
setReadOnly(),
setRows(),
setText(),
setTextMode(),
setValidationGroup(),
setWrap()
|
Methods inherited from TWebControl
clearStyle(),
copyBaseAttributes(),
createStyle(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getDisplay(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
render(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setDisplay(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__construct(),
__get(),
addParsedObject(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBind(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
findControl(),
findControlsByID(),
findControlsByType(),
focus(),
getAdapter(),
getAllowChildControls(),
getAttribute(),
getAttributes(),
getChildControlsCreated(),
getClientID(),
getControlStage(),
getControlState(),
getControls(),
getCustomData(),
getEnableTheming(),
getEnableViewState(),
getEnabled(),
getHasAdapter(),
getHasAttributes(),
getHasChildInitialized(),
getHasControls(),
getHasInitialized(),
getHasLoaded(),
getHasLoadedPostData(),
getHasPreRendered(),
getID(),
getIsSkinApplied(),
getNamingContainer(),
getPage(),
getParent(),
getRegisteredObject(),
getSkinID(),
getSourceTemplateControl(),
getTemplateControl(),
getUniqueID(),
getViewState(),
getVisible(),
hasAttribute(),
initRecursive(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadState(),
loadStateRecursive(),
onDataBinding(),
onInit(),
onLoad(),
onUnload(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveState(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
setEnabled(),
setID(),
setPage(),
setSkinID(),
setTemplateControl(),
setViewState(),
setVisible(),
trackViewState(),
traverseChildControls(),
unbindProperty(),
unloadRecursive(),
unregisterObject()
|
Methods inherited from TComponent
__call(),
__destruct(),
__isset(),
__set(),
__sleep(),
__unset(),
__wakeup(),
asa(),
attachBehavior(),
attachBehaviors(),
attachClassBehavior(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
clearBehaviors(),
createdOnTemplate(),
detachBehavior(),
detachBehaviors(),
detachClassBehavior(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
evaluateStatements(),
fxAttachClassBehavior(),
fxDetachClassBehavior(),
getAutoGlobalListen(),
getBehaviorsEnabled(),
getClassHierarchy(),
getEventHandlers(),
getListeningToGlobalEvents(),
getSubProperty(),
hasEvent(),
hasEventHandler(),
hasProperty(),
isa(),
listen(),
raiseEvent(),
setSubProperty(),
unlisten()
|
Constants summary
string |
SCRIPT_PATH |
'prado/colorpicker' |
|
Constants inherited from TControl
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID
|
|