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

TDataGridColumn
in package

Representes a DataGrid column

Tags
version
7.6
subpackage

datagrid

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

Properties

$action  : mixed
$align  : mixed
$dataProperties  : mixed
$editaction  : mixed
$htmlConversion  : mixed
$inputSearch  : mixed
$label  : mixed
$name  : mixed
$properties  : mixed
$searchable  : mixed
$totalCallback  : mixed
$totalFunction  : mixed
$totalMask  : mixed
$totalTransformed  : mixed
$transformer  : mixed
$width  : mixed

Methods

__construct()  : mixed
Class Constructor
__set()  : mixed
Intercepts whenever someones assign a new property's value
disableHtmlConversion()  : mixed
Disable htmlspecialchars on output
enableAutoHide()  : mixed
Enable column auto hide
enableHtmlConversion()  : mixed
Enable htmlspecialchars on output
enableSearch()  : mixed
Enable column search
enableTotal()  : mixed
Enable total
getAction()  : the
Returns the action defined by set_action() method
getAlign()  : mixed
Returns the column's align
getDataProperties()  : mixed
Return data properties
getDataProperty()  : mixed
Return a data property
getEditAction()  : the
Returns the action defined by setEditAction() method
getInputSearch()  : mixed
Get input search
getLabel()  : mixed
Returns the column's label
getName()  : mixed
Returns the database column's name
getProperties()  : mixed
Return column properties
getProperty()  : mixed
Return a column property
getTotalCallback()  : mixed
Returns the callback defined by the setTotalFunction()
getTotalFunction()  : mixed
Returns total function
getTotalMask()  : mixed
Returns total mask
getTransformer()  : mixed
Returns the callback defined by the setTransformer()
getWidth()  : mixed
Returns the column's width
hasHtmlConversionEnabled()  : mixed
return if has html conversion
isSearchable()  : mixed
Returns if column is searchable
removeAction()  : mixed
Remove action
setAction()  : mixed
Define the action to be executed when the user clicks over the column header
setDataProperty()  : mixed
Define a data property
setEditAction()  : mixed
Define the action to be executed when the user clicks do edit the column
setLabel()  : mixed
Set the column's label
setProperty()  : mixed
Define a column header property
setTotalFunction()  : mixed
Define a callback function to totalize column
setTransformer()  : mixed
Define a callback function to be applyed over the column's data
setVisibility()  : mixed
Define column visibility
totalTransformed()  : mixed
Is total transformed

Properties

Methods

__construct()

Class Constructor

public __construct( $name,  $label,  $align[,  $width = NULL ]) : mixed
Parameters
$name :

= Name of the column in the database

$label :

= Text label that will be shown in the header

$align :

= Column align (left, center, right)

$width : = NULL

= Column Width (pixels)

__set()

Intercepts whenever someones assign a new property's value

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

Property Name

$value :

Property Value

disableHtmlConversion()

Disable htmlspecialchars on output

public disableHtmlConversion() : mixed

enableAutoHide()

Enable column auto hide

public enableAutoHide(mixed $width) : mixed
Parameters
$width : mixed

enableHtmlConversion()

Enable htmlspecialchars on output

public enableHtmlConversion() : mixed

enableTotal()

Enable total

public enableTotal(mixed $function[, mixed $prefix = null ][, mixed $decimals = 2 ][, mixed $decimal_separator = ',' ][, mixed $thousand_separator = '.' ]) : mixed
Parameters
$function : mixed
$prefix : mixed = null
$decimals : mixed = 2
$decimal_separator : mixed = ','
$thousand_separator : mixed = '.'

getAction()

Returns the action defined by set_action() method

public getAction() : the
Return values
the —

action to be executed when the user clicks over the column header

getDataProperties()

Return data properties

public getDataProperties() : mixed

getDataProperty()

Return a data property

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

Property Name

getEditAction()

Returns the action defined by setEditAction() method

public getEditAction() : the
Return values
the —

action to be executed when the user clicks do edit the column

getName()

Returns the database column's name

public getName() : mixed

getProperties()

Return column properties

public getProperties() : mixed

getProperty()

Return a column property

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

Property Name

getTotalCallback()

Returns the callback defined by the setTotalFunction()

public getTotalCallback() : mixed

getTotalFunction()

Returns total function

public getTotalFunction() : mixed

getTransformer()

Returns the callback defined by the setTransformer()

public getTransformer() : mixed

hasHtmlConversionEnabled()

return if has html conversion

public hasHtmlConversionEnabled() : mixed

isSearchable()

Returns if column is searchable

public isSearchable() : mixed

setAction()

Define the action to be executed when the user clicks over the column header

public setAction( $action[,  $parameters = null ]) : mixed
Parameters
$action :

TAction object

$parameters : = null

Action parameters

setDataProperty()

Define a data property

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

Property Name

$value :

Property Value

setLabel()

Set the column's label

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

column label

setProperty()

Define a column header property

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

Property Name

$value :

Property Value

setTotalFunction()

Define a callback function to totalize column

public setTotalFunction( $callback[,  $apply_transformer = true ]) : mixed
Parameters
$callback :

A function name of a method of an object

$apply_transformer : = true

Apply transform function also in total

setTransformer()

Define a callback function to be applyed over the column's data

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

A function name of a method of an object

setVisibility()

Define column visibility

public setVisibility(mixed $bool) : mixed
Parameters
$bool : mixed

totalTransformed()

Is total transformed

public totalTransformed() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results