Referência à classe MSubDetail

Diagrama de heranças da classe MSubDetail

Membros públicos
	__construct ($name, $title, $columns=NULL, $fields=NULL, $opts=true, $align='vertical', $border='css', $formMode=MFormControl::FORM_MODE_SHOW_SIDE)
	getTitle ()
	setTitle ($title)
	setDefaultValue ($fieldId, $value)
	setUpdateButton ($show)
	setOrder ($show)
	getUpdateButton ($itemForce=null)
	setShowButtons ($showButtons)
	getShowButtons ()
	setOverFlowWidth ($width, $type='auto')
	setOverFlowHeight ($height, $type='auto')
	addChild ($name, $childId)
	getChilds ($name)
	getFields ($itemForce, $elementId=null)
	getCurrentFields ()
	setFields ($fields)
	getCurrentColumns ()
	setColumns ($columns)
	getColumns ($itemForce=null)
	getColumn ($columnId, $itemForce=null)
	setValidators ($validators=null)
	addAction ($phpFunction, $imgUrl)
	parseData ($data, $itemForce, $remove=false)
	parseFieldData ($result, $itemForce)
	generate ()
	order ($columnName, $orderType=null, $itemForce=null)
	hasData ($item=null)
	setValue ($data)
	getValue ($value)
	moveDataToFields ($args)
	duplicate ($args)
	editCell ($args)
	editCellExit ($args)
	getCurrentValidators ()
	setDoLookupAutocomplete ($doLookupAutocomplete)
Membros públicos herdados de MBaseGroup
	__construct ( $name='', $caption='', $controls='', $disposition='none', $border='css', $formMode=MFormControl::FORM_MODE_SHOW_ABOVE)
	setScrollHeight ( $height)
	setBorder ( $border)
	generateInner ()
Membros públicos herdados de MContainer
	__construct ($name=NULL, $controls=NULL, $disposition='none', $formMode=MFormControl::FORM_MODE_SHOW_ABOVE)
	setDisposition ($disposition)
	isShowLabel ()
	isShowChildLabel ()
	setShowChildLabel ( $visible=true, $recursive=true)
	setShowLabel ( $visible=true, $recursive=true)
	setControls ($controls, $recursive=false)
Membros públicos herdados de MContainerControl
	__construct ( $name=NULL)
	__clone ()
	addControl ($control)
	insertControl ($control, $pos=0)
	setControl ($control, $pos=0)
	setControls ($controls)
	getControls ()
	getControl ($pos)
	getControlById ($id)
	findControlById ($id)
	setControlById ($control, $id)
	clearControls ()
Membros públicos herdados de MControl
	setName ($name)
	setId ($id)
	getId ()
	getName ()
	getUniqueId ()
	__set ( $name, $value)
	__get ( $name)
	setClass ($cssClass, $add=TRUE)
	insertClass ( $cssClass)
	addStyleFile ( $styleFile)
	getClass ()
	addStyle ($name, $value)
	setStyle ($style)
	getStyle ()
	getBoxStyle ()
	setPosition ($left, $top, $position='absolute')
	setWidth ($value)
	setHeight ($value)
	setColor ($value)
	setVisibility ($value)
	setFont ($value)
	getBox ()
	setBoxId ( $id)
	setBoxClass ( $cssClass, $add=true)
	getBoxClass ()
	setBoxAttributes ($attr)
	getBoxAttributes ()
	generateBox ( $content)
	addAttribute ( $name, $value='')
	setAttribute ( $name, $value)
	getAttribute ( $name)
	setAttributes ($attr)
	attributes ( $mergeDuplicates=false)
	getAttributes ( $mergeDuplicates=false)
	setReadOnly ($status)
	setEnabled ($state)
	setJsHint ( $hint)
	setHint ( $hint)
	setCaption ($caption)
	setHTMLTitle ($title)
	addBoxStyle ($name, $value)
	eventHandler ()
	attachEventHandler ( $name, $handler, $param=NULL)
	addEvent ($event, $handler, $preventDefault=true)
	hasEvent ($event)
	generateEvent ()
	setContent ($inner)
	setInner ($inner)
	getInner ()
	getRender ( $method)
	getInnerToString ()
	getCSSP ()
	__toString ()
Membros públicos herdados de MComponent
	getManager ()

Membros públicos estáticos
static	getOrder ($itemForce)
static	getTable ($item, $readOnly=false)
static	update ($data=NULL, $name)
static	removeFromTable ($args)
static	forceAddToTable ($args)
static	addToTable ($data)
static	clearTableFields ($args)
static	upFromTable ($data)
static	downFromTable ($data)
static	editFromTable ($args)
static	clearDataStatus ($name)
static	setSessionValue ($var, $value, $item)
static	getSessionValue ($var, $item)
static	getValidators ($item)
static	getValidator ($item, $id)
static	getData ($itemForce=NULL, $final=true)
static	getDataItem ($arrayItem, $item)
static	defineData ($arrayItem, $data, $item)
static	addData ($data, $item)
static	setData ($data, $itemForce)
static	lookupAutocomplete ($data, $controls)
static	clearData ($itemForce)
static	removeData ($arrayItem, $item)
static	ajaxHandler ()
static	isFirstAccess ($step=NULL)
static	setValidationError ($errorMsg)
static	clearValidationErrors ()

Campos de Dados
	$title = ''
	$cleanFields = true
	$cleanHiddenF = false
	$actionCelWidth = false
	$transaction = NULL
const	BIGIMGWIDTH = 35
const	IMGWIDTH = 20
const	STATUS_ADD = 'add'
const	STATUS_EDIT = 'edit'
const	STATUS_REMOVE = 'remove'
Campos de Dados herdados de MBaseGroup
	$borderType
	$scrollable
	$scrollHeight
Campos de Dados herdados de MContainer
	$disposition
	$formMode
	$showLabel
	$showChildLabel = true
Campos de Dados herdados de MContainerControl
	$controls
	$controlsId
Campos de Dados herdados de MControl
	$id
	$uniqueId
	$enabled
	$style
	$attrs
	$attributes
	$maintainState
	$readonly
	$visible
	$caption
	$jsHint
	$hint
	$cssp
	$inner
	$parent
	$eventHandlers
	$painter
	$event
	$formId
const	ALIGN_CENTER = 'center'
const	ALIGN_LEFT = 'left'
const	ALIGN_RIGHT = 'right'
const	FORM_MODE_WHOLE_ROW = 0
const	FORM_MODE_SHOW_SIDE = 1
const	FORM_MODE_SHOW_ABOVE = 2
const	FORM_MODE_SHOW_NBSP = 3
	$formMode
Campos de Dados herdados de MComponent
	$manager
	$page
	$owner
	$name
	$className

Membros protegidos
	convertValidator ($validator)
	generateActionString ($i, $itemForce=NULL)
Membros protegidos herdados de MContainerControl
	_AddControl ($control, $pos=0, $op='add')
Membros protegidos herdados de MControl
	_addStyle ($name, $value)

Atributos Protegidos
	$updateButton = false

Outros membros herdados
Atributos Públicos Estáticos herdados de MControl
static	$_number = 0

Documentação dos Construtores & Destrutor

__construct()

__construct	(		$name,
			$title,
			$columns = NULL,
			$fields = NULL,
			$opts = true,
			$align = 'vertical',
			$border = 'css',
			$formMode = MFormControl::FORM_MODE_SHOW_SIDE )

Default constructor, need to pass Session Item.

Documentação das funções

addAction()

addAction	(		$phpFunction,
			$imgUrl )

Adiciona uma ação personalizada a tabela

addChild()

addChild	(		$name,
			$childId )

Definido automaticamente pelo subdetail no parseFields quando ele detecta in subdetail dentro dele.

Parâmetros

String	$name	nome/item/id do subdetail
String	$childId	nome/item/id do filho

addData()

static addData ( $data, $item )

static

addData some item to session/Table (You can pass an array or one item) It is a recursive function.

addToTable()

static addToTable ( $data )

static

ajaxHandler()

static ajaxHandler ( )

static

clearData()

static clearData ( $itemForce )

static

clearData all itens of the table session

clearDataStatus()

static clearDataStatus ( $name )

static

Limpa o campo dataStatus de todos os dados do subdetail passado

Função chamada após enviar o SubDetail para o banco de dados, mas continuando a sua utilização.

Se for STATUS_REMOVE, quer dizer, é pra remover no banco, após a remoção, o registro é removido do subdetail Se for STATUS_ADD o registro foi inserido no banco e pode continuar aqui, mas não precisa mais fazer nada, removemos então o dataStatus O caso do STATUS_EDIT é o mesmo do STATUS_ADD, o registro foi editado e podemos remover o dataStatus

Parâmetros

$name

Retorna

void

clearTableFields()

static clearTableFields ( $args )

static

Limpa o valor prenchido nos campos

Parâmetros

object

$args

clearValidationErrors()

static clearValidationErrors ( )

static

convertValidator()

convertValidator ( $validator )

protected

defineData()

static defineData ( $arrayItem, $data, $item )

static

Set one item to table

Parâmetros

arrayItem	the index to be seted
$obj	the object to put into table

downFromTable()

static downFromTable ( $data )

static

duplicate()

duplicate

(

$args

)

editCell()

editCell

(

$args

)

Evento chamado ao clicar em uma célula editável

editCellExit()

editCellExit

(

$args

)

Evento executado ao sair de uma célula editável

editFromTable()

static editFromTable ( $args )

static

Função chamada automaticamente ao apertar editar na tabela, define os valores dos campos

Parâmetros

object

$data

ajax miolo object

forceAddToTable()

static forceAddToTable ( $args )

static

generate()

generate

(

)

Custom generate to this class it implements some MGridColumn function: List: $ title = inplemented $ align = inplemented $ nowrap = no $ width = inplemented $ visible = inplemented $ options = inplemented $ order = no $ filter = no

Reimplementado de MBaseGroup.

generateActionString()

generateActionString ( $i, $itemForce = NULL )

protected

Gera uma a string de uma ação

Retorna

o html correspondente a uma ação

getChilds()

getChilds

(

$name

)

Retorna um array com os ids dos filho

Parâmetros

String

$name

Retorna

String um array com os ids dos filho

getColumn()

getColumn	(		$columnId,
			$itemForce = null )

getColumns()

getColumns

(

$itemForce = null

)

Return a array of columns You can use in static or object way

Parâmetros

String

$itemForce

the id of the subDetail

Retorna

Return a array of columns

getCurrentColumns()

getCurrentColumns

(

)

Retorna

array

getCurrentFields()

getCurrentFields

(

)

Retorna

array

getCurrentValidators()

getCurrentValidators

(

)

Retorna

array

getData()

static getData ( $itemForce = NULL, $final = true )

static

getData Item all itens of table/session, organized with arrayItem Each time u call this function the session is cleanned and rewrited

getDataItem()

static getDataItem ( $arrayItem, $item )

static

getDataItem one item from table

Parâmetros

arrayItem

the index of the item you wanna take

getFields()

getFields	(		$itemForce,
			$elementId = null )

getOrder()

static getOrder ( $itemForce )

static

getSessionValue()

static getSessionValue ( $var, $item )

static

getShowButtons()

getShowButtons

(

)

Retornar se é para adicionar botões automáticos

Retorna

boolean

getTable()

static getTable ( $item, $readOnly = false )

static

getTitle()

getTitle

(

)

getUpdateButton()

getUpdateButton

(

$itemForce = null

)

Return se é para mostrar ou não o botão de atualização

Retorna

se é para mostrar ou não o botão de atualização

getValidator()

static getValidator ( $item, $id )

static

getValidators()

static getValidators ( $item )

static

Get validators

Retorna

$validators (Array)

getValue()

getValue

(

$value

)

hasData()

hasData

(

$item = null

)

isFirstAccess()

static isFirstAccess ( $step = NULL )

static

lookupAutocomplete()

static lookupAutocomplete ( $data, $controls )

static

Função estática que executa o autocomplete dos lookups presentes no array passado ($controls)

Parâmetros

array	$data
array	$controls

moveDataToFields()

moveDataToFields

(

$args

)

order()

order	(		$columnName,
			$orderType = null,
			$itemForce = null )

parseData()

parseData	(		$data,
			$itemForce,
			$remove = false )

Trata os dados de acordo com a situação retirando ou adicionando o id do componente a frente dos dados.

Parâmetros

Object	$data	dados a serem parseado
String	$itemForce	id do subdetail
Boolean	$remove	se é para remover (caso contrário é adição)

Retorna

Object

parseFieldData()

parseFieldData	(		$result,
			$itemForce )

Trabalha os dados para reconhecer automaticamente o campoDescription dentre outros

Os dados ja devem vir trabalhados com o nome do subdetail na frente, por isso $result.

Parâmetros

$result

Retorna

unknown_type

removeData()

static removeData ( $arrayItem, $item )

static

Remove Data some item from Table, you need an Id. This id can be found is $item->arrayItem

removeFromTable()

static removeFromTable ( $args )

static

setColumns()

setColumns

(

$columns

)

Define as colunas que serão criadas na Tabela

Parâmetros

array

$columns

array de objetos MGridColum

setData()

static setData ( $data, $itemForce )

static

Define the Data of the field. It will clearData e add the passed data

Parâmetros

(array)

the array of objects with all data

setDefaultValue()

setDefaultValue	(		$fieldId,
			$value )

Define um valor padrão a ser mostrado em um campo específico a cada vez que os campos forem limpos

Este valor é chamado ao limpar, após adicionar, e após editar.

Parâmetros

String	$fieldId	o id do campo a receber o valor
String	$value	o valor padrão para o campo

setDoLookupAutocomplete()

setDoLookupAutocomplete

(

$doLookupAutocomplete

)

Método para alterar o atributo doLookupAutocomplete Esse atributo indica se o autocomplete do lookup deve ser disparado ao fazer o setValue

Importante: No setData, o atributo não é levado em consideração, pois o método é estático, disparando o autocomplete de cada lookup

Parâmetros

boolean

$doLookupAutocomplete

setFields()

setFields

(

$fields

)

Define os campos que serão utilizados na classe

Parâmetros

array

$fields

array de objetos

setOrder()

setOrder

(

$show

)

Define se é para dar suporte as funções de ordenação automáticas ou não

Parâmetros

boolean

$show

setOverFlowHeight()

setOverFlowHeight	(		$height,
			$type = 'auto' )

Make the table flow inside a div.

Parâmetros

integer	$width	in pixels (without 'px');
string	$type	the type of overflow, see CSS overflow declaration

setOverFlowWidth()

setOverFlowWidth	(		$width,
			$type = 'auto' )

Make the table flow inside a div.

Parâmetros

integer	$width	in pixels (without 'px');
string	$type	the type of overflow, see CSS overflow declaration

setSessionValue()

static setSessionValue ( $var, $value, $item )

static

setShowButtons()

setShowButtons

(

$showButtons

)

Se era para adicionar botões automaticos de adição e de limpar (add e clear)

Parâmetros

boolean

$showButtons

true para adicionar botões automaticos de adição e de limpar (add e clear)

setTitle()

setTitle

(

$title

)

setUpdateButton()

setUpdateButton

(

$show

)

Define se é para mostrar ou não o botão de atualização

Parâmetros

boolean

$show

setValidationError()

static setValidationError ( $errorMsg )

static

setValidators()

setValidators

(

$validators = null

)

Set the validators

Parâmetros

$validators

setValue()

setValue

(

$data

)

update()

static update ( $data = NULL, $name )

static

Update the visual Component with some data. Make a ajax response

Parâmetros

array	$data	array of object
string	$itemForce	the name of the table

upFromTable()

static upFromTable ( $data )

static

Documentação dos campos e atributos

$actionCelWidth

$actionCelWidth = false

$cleanFields

$cleanFields = true

$cleanHiddenF

$cleanHiddenF = false

$title

$title = ''

$transaction

$transaction = NULL

$updateButton

$updateButton = false

protected

BIGIMGWIDTH

const BIGIMGWIDTH = 35

IMGWIDTH

const IMGWIDTH = 20

STATUS_ADD

const STATUS_ADD = 'add'

STATUS_EDIT

const STATUS_EDIT = 'edit'

STATUS_REMOVE

const STATUS_REMOVE = 'remove'

---

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

• classes/ui/controls/msubdetail.class.php