Referência à classe MGrid

Diagrama de heranças da classe MGrid

Membros públicos
	__construct ($data, $columns, $href=NULL, $pageLength=15, $index=0, $name='', $useCheckBoxes=TRUE, $gridMostraTotalNumeric=false)
	isGridMostraTotalNumeric ()
	setGridMostraTotalNumeric ($gridMostraTotalNumeric)
	setShowHeaders ( $show=true)
	showHeaders ()
	setCurrentPage ($pageNumber)
	getURL ($filter=false, $order=false, $item='')
	setTitle ($title)
	setPageLength ($pageLength)
	getPageLength ()
	setFooter ($footer)
	setColumns ($columns)
	setLinkType ($linktype)
	setControls ($controls)
	setButtons ($aButtons)
	setWidth ($width)
	setIndex ($index)
	setRowMethod ($class, $method)
	setIsScrollable ($scrollable=true, $width='99%', $height='99%')
	setScrollWidth ($width='99%')
	setScrollHeight ($height='99%')
	headerLink ($id, $label, $href)
	setColumnAttr ($col, $attr, $value)
	setButtonSelectClass ($class='')
	setAlternate ($status=true)
	setData ($data)
	getData ()
	getDataValue ($row, $col)
	getPage ()
	getPageNumber ()
	getPrevPage ()
	getCurrentRow ()
	setActionDefault ($href)
	addActionSelect ()
	addActionIcon ($alt, $icon, $href, $index=0, $staticHref=null)
	addActionText ($alt, $text, $href, $index=0)
	addActionUpdate ($href)
	addActionDelete ($href)
	addActionDetail ($href)
	addFilterSelection ($index, $label, $options, $value='')
	addFilterText ($index, $label, $value='')
	addFilterControl ($index, $control, $type='text')
	getFilterValue ($index)
	getFilterControl ($index)
	setFiltered ($value=false)
	getFiltered ()
	getFilter ()
	setFilter ($status)
	applyFilter ()
	applyOrder ($column)
	addError ($err)
	showID ($state)
	setClose ($action)
	setSelecteds ($s)
	setUseSelecteds ($opt)
	handlerSelecteds ()
	clearSelecteds ()
	generateTitle ()
	generateNavigationHeader ()
	generateNavigationFooter ()
	generateLinks ()
	generateControls ()
	generateFilter ()
	hasErrors ()
	generateErrors ()
	generateHeader ()
	generateColumnsHeading (&$tbl)
	correctActionColSpan ($tbl)
	generateActions (&$tbl)
	generateColumnsControls ()
	generateColumns (&$tbl)
	generateEmptyMsg ()
	generateData ()
	callRowMethod ()
	generateBody ()
	generateFooter ()
	getImage ($src)
	generate ()
	hasOffset ()
	setQuery ($sql, $dbconf)
	getRowClickMethod ()
	setRowClickMethod ($rowClickMethod)
Membros públicos herdados de MContainerControl
	__construct ( $name=NULL)
	__clone ()
	addControl ($control)
	insertControl ($control, $pos=0)
	setControl ($control, $pos=0)
	getControls ()
	getControl ($pos)
	getControlById ($id)
	findControlById ($id)
	setControlById ($control, $id)
	clearControls ()
	generateInner ()
Membros públicos herdados de MDiv
	__construct ( $name=NULL, $content=' ', $class=NULL, $attributes=NULL)
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')
	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	obterConsultaComSomatorios ($query)
static	obterConsultaComNomesDasColunas ($query)
static	normalizaConsulta ($sql, $dbconf, $gridMostraTotalNumeric=false)

Campos de Dados
	$title
	$filters
	$filtered
	$filter
	$orderby
	$ordered
	$order
	$orderMask
	$lastorderby
	$data
	$actions = array()
	$select
	$showid
	$columns
	$icons
	$errors = array()
	$pageLength
	$rowCount
	$href
	$pn
	$headerLinks
	$linktype
	$width
	$rowmethod
	$rowClickMethod
	$index
	$controls
	$emptyMsg
	$currentRow
	$box
	$selecteds
	$allSelecteds
	$pageNumber
	$prevPage
	$name
	$css
	$footer
	$hasDetail
	$actionDefault
	$alternateColors
	$buttonSelectClass
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

Atributos Protegidos
	$isShowHeaders = true
	$scrollable = false
	$scrollWidth = '99%'
	$scrollHeight = '99%'

Outros membros herdados
Atributos Públicos Estáticos herdados de MControl
static	$_number = 0
Membros protegidos herdados de MContainerControl
	_AddControl ($control, $pos=0, $op='add')
Membros protegidos herdados de MControl
	_addStyle ($name, $value)

Documentação dos Construtores & Destrutor

__construct()

__construct	(		$data,
			$columns,
			$href = NULL,
			$pageLength = 15,
			$index = 0,
			$name = '',
			$useCheckBoxes = TRUE,
			$gridMostraTotalNumeric = false )

Grid constructor.

Parâmetros

array	$data	Data array.
array	$columns	Columns array.
string	$href	Base URL to use in pagination.
integer	$pageLength	Number of items per page.
integer	$index	The column which acts as grid index.
string	$name	Grid name.
boolean	$useCheckBoxes	Whether to use check boxes.

Documentação das funções

addActionDelete()

addActionDelete

(

$href

)

addActionDetail()

addActionDetail

(

$href

)

addActionIcon()

addActionIcon	(		$alt,
			$icon,
			$href,
			$index = 0,
			$staticHref = null )

addActionSelect()

addActionSelect

(

)

addActionText()

addActionText	(		$alt,
			$text,
			$href,
			$index = 0 )

addActionUpdate()

addActionUpdate

(

$href

)

addError()

addError

(

$err

)

addFilterControl()

addFilterControl	(		$index,
			$control,
			$type = 'text' )

addFilterSelection()

addFilterSelection	(		$index,
			$label,
			$options,
			$value = '' )

addFilterText()

addFilterText	(		$index,
			$label,
			$value = '' )

applyFilter()

applyFilter

(

)

Reimplementado em MDataGrid.

applyOrder()

applyOrder

(

$column

)

callRowMethod()

callRowMethod

(

)

Reimplementado em MDataGrid e MObjectGrid.

clearSelecteds()

clearSelecteds

(

)

correctActionColSpan()

correctActionColSpan

(

$tbl

)

generate()

generate

(

)

Reimplementado de MDiv.

Reimplementado em MSpecialGrid e MPDFReport.

generateActions()

generateActions

(

&

$tbl

)

Reimplementado em MLookupGrid.

generateBody()

generateBody

(

)

Reimplementado em MLookupGrid.

generateColumns()

generateColumns

(

&

$tbl

)

generateColumnsControls()

generateColumnsControls

(

)

generateColumnsHeading()

generateColumnsHeading

(

&

$tbl

)

generateControls()

generateControls

(

)

generateData()

generateData

(

)

Reimplementado em MDataGrid, MLookupObjectGrid, MLookupQueryGrid, MObjectGrid e MLookupGrid.

generateEmptyMsg()

generateEmptyMsg

(

)

generateErrors()

generateErrors

(

)

generateFilter()

generateFilter

(

)

Reimplementado em MLookupGrid e MLookupGrid.

generateFooter()

generateFooter

(

)

Reimplementado em MLookupGrid, MLookupGrid e MPDFReport.

generateHeader()

generateHeader

(

)

Reimplementado em MLookupGrid, MSpecialGrid, MLookupGrid e MPDFReport.

generateLinks()

generateLinks

(

)

generateNavigationFooter()

generateNavigationFooter

(

)

Reimplementado em MSpecialGrid.

generateNavigationHeader()

generateNavigationHeader

(

)

generateTitle()

generateTitle

(

)

Reimplementado em MLookupGrid e MLookupGrid.

getCurrentRow()

getCurrentRow

(

)

getData()

getData

(

)

getDataValue()

getDataValue	(		$row,
			$col )

getFilter()

getFilter

(

)

getFilterControl()

getFilterControl

(

$index

)

getFiltered()

getFiltered

(

)

getFilterValue()

getFilterValue

(

$index

)

getImage()

getImage

(

$src

)

getPage()

getPage

(

)

Reimplementado em MPDFReport.

getPageLength()

getPageLength

(

)

getPageNumber()

getPageNumber

(

)

getPrevPage()

getPrevPage

(

)

getRowClickMethod()

getRowClickMethod

(

)

getURL()

getURL	(		$filter = false,
			$order = false,
			$item = '' )

handlerSelecteds()

handlerSelecteds

(

)

hasErrors()

hasErrors

(

)

hasOffset()

hasOffset

(

)

Retorna

boolean Return whether the grid has an offset (returns true only when the setQuery method is used).

headerLink()

headerLink	(		$id,
			$label,
			$href )

isGridMostraTotalNumeric()

isGridMostraTotalNumeric

(

)

Retorna

boolean

normalizaConsulta()

static normalizaConsulta ( $sql, $dbconf, $gridMostraTotalNumeric = false )

static

Método tipa colunas que não foram tipadas, e seta alias para colunas que também não foram setadas.

Parâmetros

$sql
$dbconf

Retorna

string

obterConsultaComNomesDasColunas()

static obterConsultaComNomesDasColunas ( $query )

static

Quando for necessário que o retorno dos dados seja em formato associativo, é necessário obter os nomes das colunas da consulta para que crie a array associativa referente.

Parâmetros

$query

Retorna

mixed

obterConsultaComSomatorios()

static obterConsultaComSomatorios ( $query )

static

Retorna a consulta sql com a busca pelos somatórios dos valores.

Parâmetros

$query

Retorna

string

setActionDefault()

setActionDefault

(

$href

)

setAlternate()

setAlternate

(

$status = true

)

setButtons()

setButtons

(

$aButtons

)

setButtonSelectClass()

setButtonSelectClass

(

$class = ''

)

setClose()

setClose

(

$action

)

setColumnAttr()

setColumnAttr	(		$col,
			$attr,
			$value )

setColumns()

setColumns

(

$columns

)

Reimplementado em MDataGrid e MPDFReport.

setControls()

setControls

(

$controls

)

Reimplementado de MContainerControl.

setCurrentPage()

setCurrentPage

(

$pageNumber

)

setData()

setData

(

$data

)

setFilter()

setFilter

(

$status

)

setFiltered()

setFiltered

(

$value = false

)

setFooter()

setFooter

(

$footer

)

setGridMostraTotalNumeric()

setGridMostraTotalNumeric

(

$gridMostraTotalNumeric

)

Parâmetros

boolean

$gridMostraTotalNumeric

setIndex()

setIndex

(

$index

)

setIsScrollable()

setIsScrollable	(		$scrollable = true,
			$width = '99%',
			$height = '99%' )

setLinkType()

setLinkType

(

$linktype

)

setPageLength()

setPageLength

(

$pageLength

)

setQuery()

setQuery	(		$sql,
			$dbconf )

Define the SQL to let grid manage the database queries. Use this to make the database query use LIMIT and OFFSET.

@global object $state MState instance.

Parâmetros

string	$sql	SQL query string.
string	$dbconf	Database configuration name.

setRowClickMethod()

setRowClickMethod

(

$rowClickMethod

)

setRowMethod()

setRowMethod	(		$class,
			$method )

setScrollHeight()

setScrollHeight

(

$height = '99%'

)

setScrollWidth()

setScrollWidth

(

$width = '99%'

)

setSelecteds()

setSelecteds

(

$s

)

setShowHeaders()

setShowHeaders

(

$show = true

)

setTitle()

setTitle

(

$title

)

setUseSelecteds()

setUseSelecteds

(

$opt

)

setWidth()

setWidth

(

$width

)

Reimplementado de MControl.

Reimplementado em MPDFReport.

showHeaders()

showHeaders

(

)

showID()

showID

(

$state

)

Documentação dos campos e atributos

$actionDefault

$actionDefault

$actions

$actions = array()

$allSelecteds

$allSelecteds

$alternateColors

$alternateColors

$box

$box

$buttonSelectClass

$buttonSelectClass

$columns

$columns

$controls

$controls

$css

$css

$currentRow

$currentRow

$data

$data

$emptyMsg

$emptyMsg

$errors

$errors = array()

$filter

$filter

$filtered

$filtered

$filters

$filters

$footer

$footer

$hasDetail

$hasDetail

$headerLinks

$headerLinks

$href

$href

$icons

$icons

$index

$index

$isShowHeaders

$isShowHeaders = true

protected

$lastorderby

$lastorderby

$linktype

$linktype

$name

$name

$order

$order

$orderby

$orderby

$ordered

$ordered

$orderMask

$orderMask

$pageLength

$pageLength

$pageNumber

$pageNumber

$pn

$pn

$prevPage

$prevPage

$rowClickMethod

$rowClickMethod

$rowCount

$rowCount

$rowmethod

$rowmethod

$scrollable

$scrollable = false

protected

$scrollHeight

$scrollHeight = '99%'

protected

$scrollWidth

$scrollWidth = '99%'

protected

$select

$select

$selecteds

$selecteds

$showid

$showid

$title

$title

$width

$width

---

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

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