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

TDBArrowStep extends TArrowStep
in package
Uses AdiantiDatabaseWidgetTrait

Database Arrow Step

Tags
version
7.6
subpackage

util

author

Lucas Tomasi

author

Matheus Agnes Dias

author

Pablo Dall'Oglio

copyright

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

license

https://adiantiframework.com.br/license

Table of Contents

Properties

$action  : mixed
$className  : mixed
$color  : mixed
$colorcolumn  : mixed
$colorItems  : mixed
$container  : mixed
$criteria  : mixed
$database  : mixed
$disableColor  : mixed
$disableFontColor  : mixed
$editable  : mixed
$fontColor  : mixed
$fontSize  : mixed
$formName  : mixed
$height  : mixed
$hideText  : mixed
$id  : mixed
$items  : mixed
$key  : mixed
$label  : mixed
$model  : mixed
$name  : mixed
$ordercolumn  : mixed
$properties  : mixed
$selected  : mixed
$size  : mixed
$tag  : mixed
$value  : mixed
$valueCallback  : mixed
$width  : 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
addItem()  : mixed
Add an item
addItems()  : mixed
Add items
addValidation()  : mixed
Add a field validator
clearField()  : mixed
Clear the field
defineCurrent()  : mixed
Define current item on steps
disableField()  : mixed
Disable the field
enableField()  : mixed
Enable the field
getAction()  : mixed
Get action
getContents()  : mixed
Returns the element content as a string
getCurrent()  : mixed
Get current item
getEditable()  : A
Returns if the field is editable
getFormName()  : mixed
Return the name of the form to wich the field is attached
getHeight()  : mixed
Get heigth
getId()  : mixed
Returns the field's id
getItem()  : mixed
Get item
getItems()  : mixed
Get items
getItemsFromModel()  : mixed
Get items (key/value) from database to populate widget
getLabel()  : mixed
Returns the field's label
getName()  : mixed
Returns the field's name
getObjectsFromModel()  : mixed
Get objects from database to populate widget
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
getWidth()  : mixed
Get width
isRequired()  : mixed
Returns if the field is required
setAction()  : mixed
Set action
setColorColumn()  : mixed
setColorItems()  : mixed
Set color items
setCurrent()  : mixed
Select current item
setCurrentKey()  : mixed
Select current item
setEditable()  : mixed
Define if the field is editable
setFilledColor()  : mixed
Set color arrows
setFilledFontColor()  : mixed
Set font color arrows
setFontSize()  : mixed
Set font size
setFormName()  : mixed
Define the name of the form to wich the field is attached
setHeight()  : mixed
Set height arrows
setHideText()  : mixed
Set hide text
setId()  : mixed
Define the field's id
setItems()  : mixed
Set items
setLabel()  : mixed
Define the field's label
setName()  : mixed
Define the field's name
setProperty()  : mixed
Define a field property
setSize()  : mixed
Define the Field's width
setTagName()  : mixed
Change input tag name
setTip()  : mixed
Define the field's tooltip
setUnfilledColor()  : mixed
Set color arrows
setUnfilledFontColor()  : mixed
Set color arrows
setValue()  : mixed
Define the field's value
setValueCallback()  : mixed
Set callback for setValue method
setWidth()  : mixed
Set width
show()  : mixed
Show component
validate()  : mixed
Validate a field
getSerializedAction()  : mixed
Get action in serialized way
makeItem()  : mixed
Make a html of item
makeStyle()  : mixed
Make component style

Properties

$disableFontColor

protected mixed $disableFontColor

$editable

protected mixed $editable

$formName

protected mixed $formName

$properties

protected mixed $properties

$valueCallback

protected mixed $valueCallback

$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(mixed $name,  $database,  $model,  $key,  $value[,  $ordercolumn = NULL ][,  $criteria = NULL ]) : mixed
Parameters
$name : mixed

widget's name

$database :

database name

$model :

model class name

$key :

table field to be used as key in the combo

$value :

table field to be listed in the combo

$ordercolumn : = NULL

column to order the fields (optional)

$criteria : = NULL

criteria (TCriteria object) to filter the model (optional)

__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

addItem()

Add an item

public addItem( $title[,  $id = null ][,  $color = null ]) : mixed
Parameters
$title :

Item title

$id : = null

Item id

$color : = null

Item color

addItems()

Add items

public addItems(mixed $items) : mixed
Parameters
$items : mixed

addValidation()

Add a field validator

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

Field name

$validator :

TFieldValidator object

$parameters : = NULL

Aditional parameters

clearField()

Clear the field

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

Form name

$field :

Field name

defineCurrent()

Define current item on steps

public static defineCurrent( $name,  $value) : mixed
Parameters
$name :

name of arrow steps

$value :

value current

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

getAction()

Get action

public getAction() : mixed

getContents()

Returns the element content as a string

public getContents() : mixed

getCurrent()

Get current item

public getCurrent() : 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

getHeight()

Get heigth

public getHeight() : mixed

getId()

Returns the field's id

public getId() : mixed

getItem()

Get item

public getItem(mixed $key) : mixed
Parameters
$key : mixed

getItemsFromModel()

Get items (key/value) from database to populate widget

public static getItemsFromModel(mixed $database, mixed $model, mixed $key, mixed $value[, mixed $ordercolumn = NULL ][, TCriteria $criteria = NULL ]) : mixed
Parameters
$database : mixed
$model : mixed
$key : mixed
$value : mixed
$ordercolumn : mixed = NULL
$criteria : TCriteria = NULL

getLabel()

Returns the field's label

public getLabel() : mixed

getName()

Returns the field's name

public getName() : mixed

getObjectsFromModel()

Get objects from database to populate widget

public static getObjectsFromModel(mixed $database, mixed $model, mixed $key[, mixed $ordercolumn = NULL ][, TCriteria $criteria = NULL ]) : mixed
Parameters
$database : mixed
$model : mixed
$key : mixed
$ordercolumn : mixed = NULL
$criteria : TCriteria = NULL

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

setAction()

Set action

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

Action

setColorColumn()

public setColorColumn(mixed $colorcolumn) : mixed
Parameters
$colorcolumn : mixed

setColorItems()

Set color items

public setColorItems( $colorItems) : mixed
Parameters
$colorItems :

Items

setCurrent()

Select current item

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

setCurrentKey()

Select current item

public setCurrentKey(mixed $key) : mixed
Parameters
$key : mixed

setEditable()

Define if the field is editable

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

A boolean

setFilledColor()

Set color arrows

public setFilledColor( $color[,  $fontColor = null ]) : mixed
Parameters
$color :

string to color

$fontColor : = null

string to color font

setFilledFontColor()

Set font color arrows

public setFilledFontColor(string $fontColor) : mixed
Parameters
$fontColor : string

setFontSize()

Set font size

public setFontSize(mixed $fontSize) : mixed
Parameters
$fontSize : mixed

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

setHeight()

Set height arrows

public setHeight( $height) : mixed
Parameters
$height :

int|float to height

setHideText()

Set hide text

public setHideText([ $hide = true ]) : mixed
Parameters
$hide : = true

bool

setId()

Define the field's id

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

A string containing the field's id

setItems()

Set items

public setItems(mixed $items) : mixed
Parameters
$items : mixed

setLabel()

Define the field's label

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

A string containing the field's label

setName()

Define the field's name

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

A string containing the field's name

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

setTip()

Define the field's tooltip

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

setUnfilledColor()

Set color arrows

public setUnfilledColor( $color[,  $fontColor = null ]) : mixed
Parameters
$color :

string to color

$fontColor : = null

string to color font

setUnfilledFontColor()

Set color arrows

public setUnfilledFontColor(string $color) : mixed
Parameters
$color : string

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

setWidth()

Set width

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

int|float to width

validate()

Validate a field

public validate() : mixed

getSerializedAction()

Get action in serialized way

private getSerializedAction(mixed $key, mixed $value[, mixed $selected = false ]) : mixed
Parameters
$key : mixed
$value : mixed
$selected : mixed = false

makeItem()

Make a html of item

private makeItem(mixed $key, mixed $value[, mixed $selected = false ]) : mixed
Parameters
$key : mixed
$value : mixed
$selected : mixed = false

makeStyle()

Make component style

private makeStyle() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results