API Documentação da API
Inscrições abertas para nosso Webinar anual Adianti Framework 2024!
Clique aqui para saber mais
Conheça Características Quem usa Galeria Cursos Docs Fórum
Downloads
Guia rápido Estrutura FAQ Changelog Migração API Guia
Pacote Dominando o Adianti 7
Curso + Livro + Apps exemplo
Curso completo em Video Aulas (114 aulas).
Livro completo em PDF (463 páginas).
Códigos-fontes de Apps de exemplo.
Conhecer agora
API
API do Framework
Documentation

Documentation

TColor extends TEntry
in package
implements AdiantiWidgetInterface

Color Widget

Tags
version
7.6
subpackage

form

author

Pablo Dall'Oglio

copyright

Copyright (c) 2006 Adianti Solutions Ltd. (http://www.adianti.com.br)

license

https://adiantiframework.com.br/license

Table of Contents

Interfaces

AdiantiWidgetInterface
Widget Interface

Constants

THEME_CLASSIC  = 'classic'
THEME_MONOLITH  = 'monolith'
THEME_NANO  = 'nano'

Properties

$allowNegative  : mixed
$changeAction  : mixed
$changeFunction  : mixed
$completion  : mixed
$decimals  : mixed
$decimalsSeparator  : mixed
$delimiter  : mixed
$editable  : mixed
$exitAction  : mixed
$exitFunction  : mixed
$exitOnEnterOn  : mixed
$formName  : mixed
$id  : mixed
$innerIcon  : mixed
$label  : mixed
$minLength  : mixed
$name  : mixed
$numericMask  : mixed
$options  : mixed
$properties  : mixed
$replaceOnPost  : mixed
$reverse  : mixed
$size  : mixed
$tag  : mixed
$theme  : mixed
$thousandSeparator  : mixed
$value  : mixed
$valueCallback  : mixed
$mask  : mixed
$toggleVisibility  : mixed
$validations  : mixed

Methods

__call()  : mixed
Redirects function call
__clone()  : mixed
Clone the object
__construct()  : mixed
Class Constructor
__get()  : mixed
Returns a property value
__isset()  : mixed
Returns if the property is set
__set()  : mixed
Intercepts whenever someones assign a new property's value
__toString()  : mixed
Converts the object into a string
addValidation()  : mixed
Add a field validator
changeMask()  : mixed
Change mask dynamically
clearField()  : mixed
Clear the field
disableAutoComplete()  : mixed
Disable auto complete
disableField()  : mixed
Disable the field
enableField()  : mixed
Enable the field
enableToggleVisibility()  : mixed
Enable toggle visible
exitOnEnter()  : mixed
Turn on exit on enter
forceLowerCase()  : mixed
Force lower case
forceUpperCase()  : mixed
Force upper case
getContents()  : mixed
Returns the element content as a string
getEditable()  : A
Returns if the field is editable
getFormName()  : mixed
Return the name of the form to wich the field is attached
getId()  : mixed
Returns the field's id
getLabel()  : mixed
Returns the field's label
getName()  : mixed
Returns the field's name
getOption()  : mixed
Get option TColor
getOptions()  : mixed
Get options TColor
getPostData()  : mixed
Return the post data
getPropertiesAsString()  : mixed
Get properties as string
getProperty()  : mixed
Return a field property
getSize()  : mixed
Returns the field size
getValidations()  : mixed
Returns field validations
getValue()  : mixed
Returns the field's value
isRequired()  : mixed
Returns if the field is required
reloadCompletion()  : mixed
Reload completion
setChangeAction()  : mixed
Define the action to be executed when the user changes the content
setChangeFunction()  : mixed
Set change function
setCompletion()  : mixed
Define options for completion
setDelimiter()  : mixed
Set autocomplete delimiter
setEditable()  : mixed
Define if the field is editable
setExitAction()  : mixed
Define the action to be executed when the user leaves the form field
setExitFunction()  : mixed
Define the javascript function to be executed when the user leaves the form field
setFormName()  : mixed
Define the name of the form to wich the field is attached
setId()  : mixed
Define the field's id
setInnerIcon()  : mixed
Define the Inner icon
setInputType()  : mixed
Define input type
setLabel()  : mixed
Define the field's label
setMask()  : mixed
Define the field's mask
setMaxLength()  : mixed
Define max length
setMinLength()  : mixed
Define the minimum length for search
setName()  : mixed
Define the field's name
setNumericMask()  : mixed
Define the field's numeric mask (available just in web)
setOption()  : mixed
Set extra option TColor
setProperty()  : mixed
Define a field property
setSize()  : mixed
Define the Field's width
setTagName()  : mixed
Change input tag name
setTheme()  : mixed
Set theme
setTip()  : mixed
Define the field's tooltip
setValue()  : mixed
Define the field's value
setValueCallback()  : mixed
Set callback for setValue method
show()  : mixed
Shows the widget at the screen
validate()  : mixed
Validate a field
formatMask()  : mixed
Apply mask

Constants

THEME_CLASSIC

public mixed THEME_CLASSIC = 'classic'

THEME_MONOLITH

public mixed THEME_MONOLITH = 'monolith'

THEME_NANO

public mixed THEME_NANO = 'nano'

Properties

$allowNegative

protected mixed $allowNegative

$changeAction

protected mixed $changeAction

$changeFunction

protected mixed $changeFunction

$completion

protected mixed $completion

$decimals

protected mixed $decimals

$decimalsSeparator

protected mixed $decimalsSeparator

$delimiter

protected mixed $delimiter

$editable

protected mixed $editable

$exitAction

protected mixed $exitAction

$exitFunction

protected mixed $exitFunction

$exitOnEnterOn

protected mixed $exitOnEnterOn

$formName

protected mixed $formName

$innerIcon

protected mixed $innerIcon

$minLength

protected mixed $minLength

$numericMask

protected mixed $numericMask

$options

protected mixed $options

$properties

protected mixed $properties

$replaceOnPost

protected mixed $replaceOnPost

$reverse

protected mixed $reverse

$thousandSeparator

protected mixed $thousandSeparator

$valueCallback

protected mixed $valueCallback

$toggleVisibility

private mixed $toggleVisibility

$validations

private mixed $validations

Methods

__call()

Redirects function call

public __call( $method,  $param) : mixed
Parameters
$method :

Method name

$param :

Array of parameters

__clone()

Clone the object

public __clone() : mixed

__construct()

Class Constructor

public __construct( $name) : mixed
Parameters
$name :

Name of the widget

__get()

Returns a property value

public __get( $name) : mixed
Parameters
$name :

Property Name

__isset()

Returns if the property is set

public __isset( $name) : mixed
Parameters
$name :

Property Name

__set()

Intercepts whenever someones assign a new property's value

public __set( $name,  $value) : mixed
Parameters
$name :

Property Name

$value :

Property Value

__toString()

Converts the object into a string

public __toString() : mixed

addValidation()

Add a field validator

public addValidation( $label,  $validator[,  $parameters = NULL ]) : mixed
Parameters
$label :

Field name

$validator :

TFieldValidator object

$parameters : = NULL

Aditional parameters

changeMask()

Change mask dynamically

public static changeMask(mixed $formName, mixed $name, mixed $mask) : mixed
Parameters
$formName : mixed
$name : mixed
$mask : mixed

clearField()

Clear the field

public static clearField( $form_name,  $field) : mixed
Parameters
$form_name :

Form name

$field :

Field name

disableAutoComplete()

Disable auto complete

public disableAutoComplete() : mixed

disableField()

Disable the field

public static disableField( $form_name,  $field) : mixed
Parameters
$form_name :

Form name

$field :

Field name

enableField()

Enable the field

public static enableField( $form_name,  $field) : mixed
Parameters
$form_name :

Form name

$field :

Field name

enableToggleVisibility()

Enable toggle visible

public enableToggleVisibility([mixed $toggleVisibility = TRUE ]) : mixed
Parameters
$toggleVisibility : mixed = TRUE

exitOnEnter()

Turn on exit on enter

public exitOnEnter() : mixed

forceLowerCase()

Force lower case

public forceLowerCase() : mixed

forceUpperCase()

Force upper case

public forceUpperCase() : mixed

getContents()

Returns the element content as a string

public getContents() : mixed

getEditable()

Returns if the field is editable

public getEditable() : A
Return values
A —

boolean

getFormName()

Return the name of the form to wich the field is attached

public getFormName() : mixed

getId()

Returns the field's id

public getId() : mixed

getLabel()

Returns the field's label

public getLabel() : mixed

getName()

Returns the field's name

public getName() : mixed

getOption()

Get option TColor

public getOption(mixed $option) : mixed
Parameters
$option : mixed

getOptions()

Get options TColor

public getOptions() : mixed

getPostData()

Return the post data

public getPostData() : mixed

getPropertiesAsString()

Get properties as string

public getPropertiesAsString([mixed $filter = null ]) : mixed
Parameters
$filter : mixed = null

getProperty()

Return a field property

public getProperty( $name) : mixed
Parameters
$name :

Property Name

getSize()

Returns the field size

public getSize() : mixed

getValidations()

Returns field validations

public getValidations() : mixed

getValue()

Returns the field's value

public getValue() : mixed

isRequired()

Returns if the field is required

public isRequired() : mixed

reloadCompletion()

Reload completion

public static reloadCompletion( $field, mixed $list[,  $options = null ]) : mixed
Parameters
$field :

Field name or id

$list : mixed
$options : = null

array of options for autocomplete

setChangeAction()

Define the action to be executed when the user changes the content

public setChangeAction( $action) : mixed
Parameters
$action :

TAction object

setChangeFunction()

Set change function

public setChangeFunction(mixed $function) : mixed
Parameters
$function : mixed

setCompletion()

Define options for completion

public setCompletion( $options) : mixed
Parameters
$options :

array of options for completion

setDelimiter()

Set autocomplete delimiter

public setDelimiter( $delimiter) : mixed
Parameters
$delimiter :

autocomplete delimiter

setEditable()

Define if the field is editable

public setEditable( $editable) : mixed
Parameters
$editable :

A boolean

setExitAction()

Define the action to be executed when the user leaves the form field

public setExitAction( $action) : mixed
Parameters
$action :

TAction object

setExitFunction()

Define the javascript function to be executed when the user leaves the form field

public setExitFunction( $function) : mixed
Parameters
$function :

Javascript function

setFormName()

Define the name of the form to wich the field is attached

public setFormName( $name) : mixed
Parameters
$name :

A string containing the name of the form

Tags
ignore-autocomplete

on

setId()

Define the field's id

public setId( $id) : mixed
Parameters
$id :

A string containing the field's id

setInnerIcon()

Define the Inner icon

public setInnerIcon(TImage $image[, mixed $side = 'right' ]) : mixed
Parameters
$image : TImage
$side : mixed = 'right'

setInputType()

Define input type

public setInputType(mixed $type) : mixed
Parameters
$type : mixed

setLabel()

Define the field's label

public setLabel( $label) : mixed
Parameters
$label :

A string containing the field's label

setMask()

Define the field's mask

public setMask( $mask[, mixed $replaceOnPost = FALSE ]) : mixed
Parameters
$mask :

A mask for input data

$replaceOnPost : mixed = FALSE

setMaxLength()

Define max length

public setMaxLength( $length) : mixed
Parameters
$length :

Max length

setMinLength()

Define the minimum length for search

public setMinLength(mixed $length) : mixed
Parameters
$length : mixed

setName()

Define the field's name

public setName( $name) : mixed
Parameters
$name :

A string containing the field's name

setNumericMask()

Define the field's numeric mask (available just in web)

public setNumericMask( $decimals,  $decimalsSeparator,  $thousandSeparator[, mixed $replaceOnPost = FALSE ][, mixed $reverse = FALSE ][,  $allowNegative = TRUE ]) : mixed
Parameters
$decimals :

Sets the number of decimal points.

$decimalsSeparator :

Sets the separator for the decimal point.

$thousandSeparator :

Sets the thousands separator.

$replaceOnPost : mixed = FALSE
$reverse : mixed = FALSE
$allowNegative : = TRUE

Sets negative allowed.

setOption()

Set extra option TColor

public setOption( $option,  $value) : mixed
Parameters
$option :

Key name option

$value :

Option value

Tags
see
Component

documentation https://github.com/Simonwep/pickr#options

setProperty()

Define a field property

public setProperty( $name,  $value[, mixed $replace = TRUE ]) : mixed
Parameters
$name :

Property Name

$value :

Property Value

$replace : mixed = TRUE

setSize()

Define the Field's width

public setSize( $width[, mixed $height = NULL ]) : mixed
Parameters
$width :

Field's width in pixels

$height : mixed = NULL

setTagName()

Change input tag name

public setTagName(mixed $name) : mixed
Parameters
$name : mixed

setTheme()

Set theme

public setTheme(mixed $theme) : mixed
Parameters
$theme : mixed

setTip()

Define the field's tooltip

public setTip(mixed $tip) : mixed
Parameters
$tip : mixed

setValue()

Define the field's value

public setValue( $value) : mixed
Parameters
$value :

A string containing the field's value

setValueCallback()

Set callback for setValue method

public setValueCallback(mixed $callback) : mixed
Parameters
$callback : mixed

show()

Shows the widget at the screen

public show() : mixed

validate()

Validate a field

public validate() : mixed

formatMask()

Apply mask

protected formatMask( $mask,  $value) : mixed
Parameters
$mask :

Mask

$value :

Value


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results