API Documentação da API
Lançado Adianti Framework 8.0!
Clique aqui para saber mais
Pacote Dominando o Adianti Framework
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.
API
API do Framework
Documentation

Documentation

TDataGridAction extends TAction
in package

Represents an action inside a datagrid

Tags
version
8.0
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
$param  : mixed
$properties  : mixed
$usePopover  : mixed
$buttonClass  : mixed
$displayCondition  : mixed
$field  : mixed
$fields  : mixed
$image  : mixed
$label  : mixed
$title  : mixed
$useButton  : mixed

Methods

__construct()  : mixed
Class Constructor
cloneWithParameters()  : mixed
disableState()  : mixed
Disable URL history state register
enablePost()  : mixed
Change the request method
fieldDefined()  : mixed
Return if there at least one field defined
getAction()  : mixed
Returns the current calback
getButtonClass()  : mixed
Returns the buttonClass
getDisplayCondition()  : mixed
Returns the action display condition
getField()  : mixed
Returns the Active Record's property that will be passed along with the action
getFieldParameters()  : mixed
Return fields used in parameters
getFields()  : mixed
Returns the Active Record's properties that will be passed along with the action
getImage()  : mixed
Returns the icon of the action
getLabel()  : mixed
Returns the text label for the action
getParameter()  : mixed
Returns a parameter
getParameters()  : mixed
Return the Action Parameters
getProperty()  : mixed
Get property
getTitle()  : mixed
Returns the tooltip title for the action
getUseButton()  : mixed
Returns if the action will use a regular button
isPopover()  : mixed
Return if is using popover
isStatic()  : mixed
Returns if the action is static
prepare()  : mixed
Prepare action for use over an object
preserveRequestParameters()  : mixed
Keep REQUEST parameters
serialize()  : mixed
Converts the action into an URL
setButtonClass()  : mixed
define the buttonClass for the action
setDisplayCondition()  : mixed
Define a callback that must be valid to show the action
setField()  : mixed
Define wich Active Record's property will be passed along with the action
setFields()  : mixed
Define wich Active Record's properties will be passed along with the action
setImage()  : mixed
Define an icon for the action
setLabel()  : mixed
define the label for the action
setParameter()  : mixed
Adds a parameter to the action
setParameters()  : mixed
Set the parameters for the action
setProperty()  : mixed
Set property
setTitle()  : mixed
define the title for the action
setUseButton()  : mixed
define if the action will use a regular button
toString()  : mixed
Returns the action as a string
usePopover()  : mixed
Enable popover
validate()  : mixed
Validate action
replace()  : mixed
Replace a string with object properties within {pattern}

Properties

$properties

protected mixed $properties

$usePopover

protected mixed $usePopover

Methods

__construct()

Class Constructor

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

Callback to be executed

$parameters : mixed = null

= array of parameters

cloneWithParameters()

public cloneWithParameters([mixed $parameters = [] ]) : mixed
Parameters
$parameters : mixed = []

disableState()

Disable URL history state register

public disableState() : mixed

fieldDefined()

Return if there at least one field defined

public fieldDefined() : mixed

getAction()

Returns the current calback

public getAction() : mixed

getButtonClass()

Returns the buttonClass

public getButtonClass() : mixed

getDisplayCondition()

Returns the action display condition

public getDisplayCondition() : mixed

getField()

Returns the Active Record's property that will be passed along with the action

public getField() : mixed

getFieldParameters()

Return fields used in parameters

public getFieldParameters() : mixed

getFields()

Returns the Active Record's properties that will be passed along with the action

public getFields() : mixed

getImage()

Returns the icon of the action

public getImage() : mixed

getLabel()

Returns the text label for the action

public getLabel() : mixed

getParameter()

Returns a parameter

public getParameter(mixed $param) : mixed
Parameters
$param : mixed

= parameter name

getParameters()

Return the Action Parameters

public getParameters() : mixed

getProperty()

Get property

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

getTitle()

Returns the tooltip title for the action

public getTitle() : mixed

getUseButton()

Returns if the action will use a regular button

public getUseButton() : mixed

isPopover()

Return if is using popover

public isPopover() : mixed

isStatic()

Returns if the action is static

public isStatic() : mixed

prepare()

Prepare action for use over an object

public prepare(mixed $object) : mixed
Parameters
$object : mixed

Data Object

preserveRequestParameters()

Keep REQUEST parameters

public preserveRequestParameters([mixed $request_parameters = [] ]) : mixed
Parameters
$request_parameters : mixed = []

serialize()

Converts the action into an URL

public serialize([mixed $format_action = TRUE ][, mixed $check_permission = FALSE ]) : mixed
Parameters
$format_action : mixed = TRUE

= format action with document or javascript (ajax=no)

$check_permission : mixed = FALSE

setButtonClass()

define the buttonClass for the action

public setButtonClass(mixed $buttonClass) : mixed
Parameters
$buttonClass : mixed

A string containing the button css class

setDisplayCondition()

Define a callback that must be valid to show the action

public setDisplayCondition(callable $displayCondition) : mixed
Parameters
$displayCondition : callable

Action display condition

setField()

Define wich Active Record's property will be passed along with the action

public setField(mixed $field) : mixed
Parameters
$field : mixed

Active Record's property

setFields()

Define wich Active Record's properties will be passed along with the action

public setFields(mixed $fields) : mixed
Parameters
$fields : mixed

setImage()

Define an icon for the action

public setImage(mixed $image) : mixed
Parameters
$image : mixed

The Image path

setLabel()

define the label for the action

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

A string containing a text label

setParameter()

Adds a parameter to the action

public setParameter(mixed $param, mixed $value) : mixed
Parameters
$param : mixed

= parameter name

$value : mixed

= parameter value

setParameters()

Set the parameters for the action

public setParameters(mixed $parameters) : mixed
Parameters
$parameters : mixed

= array of parameters

setProperty()

Set property

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

setTitle()

define the title for the action

public setTitle(mixed $title) : mixed
Parameters
$title : mixed

setUseButton()

define if the action will use a regular button

public setUseButton(mixed $useButton) : mixed
Parameters
$useButton : mixed

A boolean

toString()

Returns the action as a string

public toString() : mixed

usePopover()

Enable popover

public usePopover() : mixed

validate()

Validate action

public validate() : mixed

replace()

Replace a string with object properties within {pattern}

private replace(mixed $content, mixed $object) : mixed
Parameters
$content : mixed

String with pattern

$object : mixed

Any object


        
On this page

Search results