TDBSeekButton
extends TSeekButton
in package
Abstract Record Lookup Widget: Creates a lookup field used to search values from associated entities
Tags
Table of Contents
Properties
- $allowNegative : mixed
- $auxiliar : 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
- $properties : mixed
- $replaceOnPost : mixed
- $reverse : mixed
- $size : mixed
- $tag : mixed
- $thousandSeparator : mixed
- $value : mixed
- $valueCallback : mixed
- $action : mixed
- $button : mixed
- $extra_size : mixed
- $input_size : mixed
- $mask : mixed
- $toggleVisibility : mixed
- $useOutEvent : 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
- createButton() : mixed
- Create seek button object
- 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
- getAction() : mixed
- Return the action
- getContents() : mixed
- Returns the element content as a string
- getEditable() : A
- Returns if the field is editable
- getExtraSize() : mixed
- Returns extra size
- 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
- 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
- hasAuxiliar() : mixed
- Returns if has auxiliar field
- isRequired() : mixed
- Returns if the field is required
- reloadCompletion() : mixed
- Reload completion
- setAction() : mixed
- Define the action for the SeekButton
- setAuxiliar() : mixed
- Define an auxiliar field
- setCompletion() : mixed
- Define options for completion
- setCriteria() : mixed
- Set search criteria
- setDelimiter() : mixed
- Set autocomplete delimiter
- setDisplayLabel() : mixed
- Set display label
- setDisplayMask() : mixed
- Set display mask
- 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
- setExtraSize() : mixed
- Set extra size
- 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)
- setOperator() : mixed
- Set operator
- 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
- setUseOutEvent() : mixed
- Define it the out event will be fired
- 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
Properties
$allowNegative
protected
mixed
$allowNegative
$auxiliar
protected
mixed
$auxiliar
$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
$id
protected
mixed
$id
$innerIcon
protected
mixed
$innerIcon
$label
protected
mixed
$label
$minLength
protected
mixed
$minLength
$name
protected
mixed
$name
$numericMask
protected
mixed
$numericMask
$properties
protected
mixed
$properties
$replaceOnPost
protected
mixed
$replaceOnPost
$reverse
protected
mixed
$reverse
$size
protected
mixed
$size
$tag
protected
mixed
$tag
$thousandSeparator
protected
mixed
$thousandSeparator
$value
protected
mixed
$value
$valueCallback
protected
mixed
$valueCallback
$action
private
mixed
$action
$button
private
mixed
$button
$extra_size
private
mixed
$extra_size
$input_size
private
mixed
$input_size
$mask
private
mixed
$mask
$toggleVisibility
private
mixed
$toggleVisibility
$useOutEvent
private
mixed
$useOutEvent
$validations
private
mixed
$validations
Methods
__call()
Redirects function call
public
__call( $method, $param) : mixed
Parameters
__clone()
Clone the object
public
__clone() : mixed
__construct()
Class Constructor
public
__construct( $name, $database, $form, $model, $display_field[, $receive_key = null ][, $receive_display_field = null ][, TCriteria $criteria = NULL ][, mixed $operator = 'like' ]) : mixed
Parameters
- $name :
-
name of the form field
- $database :
-
name of the database connection
- $form :
-
name of the parent form
- $model :
-
name of the Active Record to be searched
- $display_field :
-
name of the field to be searched and shown
- $receive_key : = null
-
name of the form field to receive the primary key
- $receive_display_field : = null
-
name of the form field to receive the "display field"
- $criteria : TCriteria = NULL
- $operator : mixed = 'like'
__get()
Returns a property value
public
__get( $name) : mixed
Parameters
__isset()
Returns if the property is set
public
__isset( $name) : mixed
Parameters
__set()
Intercepts whenever someones assign a new property's value
public
__set( $name, $value) : mixed
Parameters
__toString()
Converts the object into a string
public
__toString() : mixed
addValidation()
Add a field validator
public
addValidation( $label, $validator[, $parameters = NULL ]) : mixed
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
createButton()
Create seek button object
public
static createButton(mixed $name, mixed $icon) : mixed
Parameters
- $name : mixed
- $icon : mixed
disableAutoComplete()
Disable auto complete
public
disableAutoComplete() : mixed
disableField()
Disable the field
public
static disableField( $form_name, $field) : mixed
Parameters
enableField()
Enable the field
public
static enableField( $form_name, $field) : mixed
Parameters
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
getAction()
Return the action
public
getAction() : 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
getExtraSize()
Returns extra size
public
getExtraSize() : mixed
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
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
getSize()
Returns the field size
public
getSize() : mixed
getValidations()
Returns field validations
public
getValidations() : mixed
getValue()
Returns the field's value
public
getValue() : mixed
hasAuxiliar()
Returns if has auxiliar field
public
hasAuxiliar() : mixed
isRequired()
Returns if the field is required
public
isRequired() : mixed
reloadCompletion()
Reload completion
public
static reloadCompletion( $field, mixed $list[, $options = null ]) : mixed
Parameters
setAction()
Define the action for the SeekButton
public
setAction( $action) : mixed
Parameters
setAuxiliar()
Define an auxiliar field
public
setAuxiliar( $object) : mixed
Parameters
setCompletion()
Define options for completion
public
setCompletion( $options) : mixed
Parameters
setCriteria()
Set search criteria
public
setCriteria(TCriteria $criteria) : mixed
Parameters
- $criteria : TCriteria
setDelimiter()
Set autocomplete delimiter
public
setDelimiter( $delimiter) : mixed
Parameters
setDisplayLabel()
Set display label
public
setDisplayLabel(mixed $label) : mixed
Parameters
- $label : mixed
setDisplayMask()
Set display mask
public
setDisplayMask( $mask) : mixed
Parameters
setEditable()
Define if the field is editable
public
setEditable( $editable) : mixed
Parameters
setExitAction()
Define the action to be executed when the user leaves the form field
public
setExitAction( $action) : mixed
Parameters
setExitFunction()
Define the javascript function to be executed when the user leaves the form field
public
setExitFunction( $function) : mixed
Parameters
setExtraSize()
Set extra size
public
setExtraSize(mixed $extra_size) : mixed
Parameters
- $extra_size : mixed
setFormName()
Define the name of the form to wich the field is attached
public
setFormName( $name) : mixed
Parameters
Tags
setId()
Define the field's id
public
setId( $id) : mixed
Parameters
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
setMask()
Define the field's mask
public
setMask( $mask[, mixed $replaceOnPost = FALSE ]) : mixed
Parameters
setMaxLength()
Define max length
public
setMaxLength( $length) : mixed
Parameters
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
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
setOperator()
Set operator
public
setOperator(mixed $operator) : mixed
Parameters
- $operator : mixed
setProperty()
Define a field property
public
setProperty( $name, $value[, mixed $replace = TRUE ]) : mixed
Parameters
setSize()
Define the Field's width
public
setSize( $width[, mixed $height = NULL ]) : mixed
Parameters
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
setUseOutEvent()
Define it the out event will be fired
public
setUseOutEvent(mixed $bool) : mixed
Parameters
- $bool : mixed
setValue()
Define the field's value
public
setValue( $value) : mixed
Parameters
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