Class TColorPicker

Description

TColorPicker class.

Be aware, this control is EXPERIMENTAL and is not stablized yet.

Located in /Web/UI/WebControls/TColorPicker.php (line 23)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TTextBox
               |
               --TColorPicker
Class Constant Summary
 SCRIPT_PATH = 'prado/colorpicker'
Method Summary
string getAssetUrl ([string $file = ''])
string getClientClassName ()
string getOKButtonText ()
boolean getShowColorPicker ()
void onPreRender (mixed $param)
void renderEndTag (THtmlWriter $writer)
void setCancelButtonText (string $value)
void setColorPickerStyle (string $value)
void setMode (TColorPickerMode $value)
void setOKButtonText (string $value)
void setShowColorPicker (boolean $value)
Methods
createClientSide (line 123)
  • return: javascript validator event options.
  • access: protected
TColorPickerClientSide createClientSide ()
getAssetUrl (line 153)
  • return: asset file url.
  • access: protected
string getAssetUrl ([string $file = ''])
  • string $file: asset file in the self::SCRIPT_PATH directory.
getCancelButtonText (line 97)
  • return: text for the color picker Cancel button. Default is "Cancel".
  • access: public
string getCancelButtonText ()
getClientClassName (line 216)

Gets the name of the javascript class responsible for performing postback for this control.

This method overrides the parent implementation.

  • return: the javascript class name
  • access: protected
string getClientClassName ()

Redefinition of:
TTextBox::getClientClassName()
Gets the name of the javascript class responsible for performing postback for this control.
getClientSide (line 113)
  • return: javascript event options.
  • access: public
TColorPickerClientSide getClientSide ()
getColorPickerStyle (line 73)
  • return: current color picker style
  • access: public
string getColorPickerStyle ()
getMode (line 57)
  • return: current color picker UI mode. Defaults to TColorPickerMode::Basic.
  • access: public
TColorPickerMode getMode ()
getOKButtonText (line 81)
  • return: text for the color picker OK button. Default is "OK".
  • access: public
string getOKButtonText ()
getPostBackOptions (line 132)

Get javascript color picker options.

  • return: color picker client-side options
  • access: protected
array getPostBackOptions ()

Redefinition of:
TTextBox::getPostBackOptions()
Gets the post back options for this textbox.
getShowColorPicker (line 32)
  • return: whether the color picker should pop up when the button is clicked.
  • access: public
boolean getShowColorPicker ()
onPreRender (line 162)

Publish the color picker Css asset files.

  • access: public
void onPreRender (mixed $param)

Redefinition of:
TControl::onPreRender()
This method is invoked when the control enters 'OnPreRender' stage.
publishColorPickerAssets (line 171)

Publish the color picker assets.

  • access: protected
void publishColorPickerAssets ()
renderEndTag (line 192)

Renders additional body content.

This method overrides parent implementation by adding additional color picker button.

  • access: public
void renderEndTag (THtmlWriter $writer)

Redefinition of:
TWebControl::renderEndTag()
Renders the closing tag for the control
setCancelButtonText (line 105)
  • access: public
void setCancelButtonText (string $value)
  • string $value: text for the color picker Cancel button
setColorPickerStyle (line 65)
  • access: public
void setColorPickerStyle (string $value)
  • string $value: set the color picker style
setMode (line 49)
  • access: public
void setMode (TColorPickerMode $value)
setOKButtonText (line 89)
  • access: public
void setOKButtonText (string $value)
  • string $value: text for the color picker OK button
setShowColorPicker (line 41)

Sets whether to pop up the color picker when the button is clicked.

  • access: public
void setShowColorPicker (boolean $value)
  • boolean $value: whether to show the color picker popup

Inherited Methods

Inherited From TTextBox

TTextBox::addAttributesToRender()
TTextBox::getAutoCompleteType()
TTextBox::getAutoPostBack()
TTextBox::getAutoTrim()
TTextBox::getCausesValidation()
TTextBox::getClientClassName()
TTextBox::getColumns()
TTextBox::getData()
TTextBox::getDataChanged()
TTextBox::getEnableClientScript()
TTextBox::getMaxLength()
TTextBox::getPersistPassword()
TTextBox::getPostBackOptions()
TTextBox::getReadOnly()
TTextBox::getRows()
TTextBox::getSafeText()
TTextBox::getSafeTextParser()
TTextBox::getTagName()
TTextBox::getText()
TTextBox::getTextMode()
TTextBox::getValidationGroup()
TTextBox::getValidationPropertyValue()
TTextBox::getWrap()
TTextBox::loadPostData()
TTextBox::onTextChanged()
TTextBox::raisePostDataChangedEvent()
TTextBox::renderClientControlScript()
TTextBox::renderContents()
TTextBox::setAutoCompleteType()
TTextBox::setAutoPostBack()
TTextBox::setAutoTrim()
TTextBox::setCausesValidation()
TTextBox::setColumns()
TTextBox::setData()
TTextBox::setEnableClientScript()
TTextBox::setMaxLength()
TTextBox::setPersistPassword()
TTextBox::setReadOnly()
TTextBox::setRows()
TTextBox::setText()
TTextBox::setTextMode()
TTextBox::setValidationGroup()
TTextBox::setWrap()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDisplay()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Class Constants

Documentation generated on Mon, 21 Apr 2008 11:33:38 -0400 by phpDocumentor 1.3.0RC4