Lançado Adianti Framework 7.6!
Clique aqui para saber mais
menu

Adianti Solutions

API

Adianti, Framework, PHP, MVC, Active record, Front controller, IDE, RAD, Web, multiplataforma, geração de código, desenvolvimento rápido, relatórios, formulários, listagens, datagrids, gráficos, banco de dados, padrões de projeto, design patterns API do Adianti Framework.
API Docs
code
Selecione a classe

Class TDataGridColumn

Description

Representes a DataGrid column

Located in /widget/datagrid/TDataGridColumn.php (line 18)


	
			
Method Summary
__construct ($name, $label, $align, [$width = NULL])
enableAutoHide ($width)
enableTotal ($function, [$prefix = null], [$decimals = 2], [$decimal_separator = ','], [$thousand_separator = '.'])
getDataProperty ($name)
getName ()
getProperty ($name)
setAction ($action, [$parameters = null])
setDataProperty ($name, $value)
setEditAction ($editaction)
setLabel ($label)
setProperty ($name, $value)
setTotalFunction (Callable$callback, [$apply_transformer = true])
setTransformer (Callable$callback)
setVisibility ($bool)
__set ($name, $value)
Methods
Constructor __construct (line 43)

Class Constructor

  • access: public
__construct ($name, $label, $align, [$width = NULL])
  • $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: = Column Width (pixels)
enableAutoHide (line 74)

Enable column auto hide

  • access: public
enableAutoHide ($width)
  • $width
enableSearch (line 83)

Enable column search

  • access: public
enableSearch ()
enableTotal (line 309)

Enable total

  • access: public
enableTotal ($function, [$prefix = null], [$decimals = 2], [$decimal_separator = ','], [$thousand_separator = '.'])
  • $function
  • $prefix
  • $decimals
  • $decimal_separator
  • $thousand_separator
getAction (line 248)

Returns the action defined by set_action() method

  • return: action to be executed when the user clicks over the column header
  • access: public
getAction ()
getAlign (line 214)

Returns the column's align

  • access: public
getAlign ()
getDataProperties (line 166)

Return data properties

  • access: public
getDataProperties ()
getDataProperty (line 147)

Return a data property

  • access: public
getDataProperty ($name)
  • $name: Property Name
getEditAction (line 280)

Returns the action defined by setEditAction() method

  • return: action to be executed when the user clicks do edit the column
  • access: public
getEditAction ()
getInputSearch (line 98)

Get input search

  • access: public
getInputSearch ()
getLabel (line 197)

Returns the column's label

  • access: public
getLabel ()
getName (line 189)

Returns the database column's name

  • access: public
getName ()
getProperties (line 158)

Return column properties

  • access: public
getProperties ()
getProperty (line 135)

Return a column property

  • access: public
getProperty ($name)
  • $name: Property Name
getTotalCallback (line 338)

Returns the callback defined by the setTotalFunction()

  • access: public
getTotalCallback ()
getTotalFunction (line 346)

Returns total function

  • access: public
getTotalFunction ()
getTotalMask (line 354)

Returns total mask

  • access: public
getTotalMask ()
getTransformer (line 301)

Returns the callback defined by the setTransformer()

  • access: public
getTransformer ()
getWidth (line 222)

Returns the column's width

  • access: public
getWidth ()
isSearchable (line 106)

Returns if column is searchable

  • access: public
isSearchable ()
removeAction (line 260)

Remove action

  • access: public
removeAction ()
setAction (line 233)

Define the action to be executed when

the user clicks over the column header

  • access: public
setAction ($action, [$parameters = null])
  • $action: TAction object
  • $parameters: Action parameters
setDataProperty (line 126)

Define a data property

  • access: public
setDataProperty ($name, $value)
  • $name: Property Name
  • $value: Property Value
setEditAction (line 270)

Define the action to be executed when

the user clicks do edit the column

  • access: public
setEditAction ($editaction)
  • $editaction: A TDataGridAction object
setLabel (line 206)

Set the column's label

  • access: public
setLabel ($label)
  • $label: column label
setProperty (line 116)

Define a column header property

  • access: public
setProperty ($name, $value)
  • $name: Property Name
  • $value: Property Value
setTotalFunction (line 329)

Define a callback function to totalize column

  • access: public
setTotalFunction (Callable$callback, [$apply_transformer = true])
  • Callable$callback: A function name of a method of an object
  • $apply_transformer: Apply transform function also in total
setTransformer (line 293)

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

  • access: public
setTransformer (Callable$callback)
  • Callable$callback: A function name of a method of an object
setVisibility (line 57)

Define column visibility

  • access: public
setVisibility ($bool)
  • $bool
totalTransformed (line 362)

Is total transformed

  • access: public
totalTransformed ()
__set (line 176)

Intercepts whenever someones assign a new property's value

  • access: public
__set ($name, $value)
  • $name: Property Name
  • $value: Property Value