Inheritance diagram for HtmlGrid:

Collaboration diagram for HtmlGrid:

Public Member Functions
	__construct ($identifier, $numRows=1, $numCols=NULL, $createCols=true, $implicitRows=false)

	asSegment ()

	asContainer ()

	setWide ($wide)
	Defines the grid width (alias for setWidth) More...

	setWidth ($width)
	Defines the grid width. More...

	addRow ($colsCount=NULL)
	Adds a row with $colsCount columns. More...

	addCol ($width=NULL)
	Adds a col. More...

	addCols ($sizes=array())

	setRowsCount ($rowsCount, $colsCount=NULL, $force=false)
	Create $rowsCount rows. More...

	setColsCount ($numCols, $toCreate=true, $width=NULL)
	Defines the number of columns in the grid. More...

	getRow ($index)
	return the row at $index More...

	getItem ($index)

	rowCount ()
	Returns the row count. More...

	colCount ()
	Returns the column count. More...

	getCell ($row, $col)
	Returns the cell (HtmlGridCol) at position $row,$col. More...

	setDivided ($vertically=false)
	Adds dividers between columns ($vertically=false) or between rows ($vertically=true) More...

	setCelled ($internally=false)
	Divides rows into cells. More...

	setCentered ()
	A grid can have its columns centered. More...

	setEqualWidth ()
	automatically resize all elements to split the available width evenly More...

	setPadded ($value=NULL)
	Adds vertical or/and horizontal gutters. More...

	setRelaxed ($very=false)

	setVerticalAlignment ($value=VerticalAlignment::MIDDLE)

	setValues ($values, $force=true)
	Sets $values to the grid. More...

	setColWidth ($numCol, $width)

	setStretched ()
	stretch the row contents to take up the entire column height More...

	addDivider ($afterColIndex, $vertical=true, $content=NULL)
	Adds a divider after the specified col. More...

Public Member Functions inherited from HtmlSemCollection
	__construct ( $identifier, $tagName="div", $baseClass="")

	run (JsUtils $js)

Public Member Functions inherited from HtmlCollection
	__construct ($identifier, $tagName="div")

	addItems ($items)

	setItems ($items)

	getItems ()

	addItem ($item)
	adds and returns an item More...

	insertItem ($item, $position=0)

	getItem ($index)
	Return the item at index. More...

	setItem ($index, $value)

	removeItem ($index)

	count ()

	fromDatabaseObject ($object, $function)

	apply ($callBack)

	fromArray ($array)

	setProperties ($properties)

	setPropertyValues ($property, $values)
	Sets the values of a property for each item in the collection. More...

	addPropertyValues ($property, $values)
	Adds the values of a property for each item in the collection. More...

	compile (JsUtils $js=NULL, &$view=NULL)

	getItemById ($identifier)

	asLinks ($hrefs=[], $target=NUll)

	splice ($offset, $length=null)
	Remove a portion of the items array and replace it with something else. More...

Public Member Functions inherited from HtmlDoubleElement
	__construct ($identifier, $tagName="p")

	setContent ($content)

	getContent ()

	addContent ($content, $before=false)

	run (JsUtils $js)

	setValue ($value)

	wrapContent ($before, $after="")

	wrapWith (HtmlDoubleElement $container)
	Wraps the element with a container. More...

	getContentInstances ($class)

	asLink ($href=NULL, $target=NULL)
	Transforms the element into a link. More...

	getTextContent ()

	asEditable (HtmlFormField $field, $asForm=false, $setValueProperty="val()")

Public Member Functions inherited from HtmlSingleElement
	__construct ($identifier, $tagName="br")

	setClass ($classNames)

	addClass ($classNames)

	setRole ($value)

	setTitle ($value)

	setStyle ($value)

	run (JsUtils $js)

	fromArray ($array)

	setSize ($size)

Public Member Functions inherited from BaseHtml
	run (JsUtils $js)

	getTagName ()

	setTagName ($tagName)

	fromArray ($array)

	fromDatabaseObjects ($objects, $function)

	fromDatabaseObject ($object, $function)

	wrap ($before, $after="")

	getElementById ($identifier, $elements)

	getBsComponent ()

	setBsComponent ($bsComponent)

	compile (JsUtils $js=NULL, &$view=NULL)

	setDraggable ($attr="id", $dropZone=null, $parameters=[])
	Sets the element draggable, and eventualy defines the dropzone (HTML5 drag and drop) More...

	asDropZone ($jsCallback="", $jqueryDone="append", $parameters=[])
	Declares the element as a drop zone (HTML5 drag and drop) More...

	asFileDropZone ($responseElement=null, $url=null, $progress=null, $jsCallback="", $parameters=[])
	Declares the element as a drop zone for file uploading (HTML5 drag and drop) More...

	__toString ()

	onPostCompile ($callback)

	onPreCompile ($callback)

Public Member Functions inherited from BaseWidget
	__construct ($identifier)

	getIdentifier ()

	setIdentifier ($identifier)

	getLibraryId ()

	setLibraryId ($_libraryId)

Protected Member Functions
	hasOnlyCols ($count)

	createItem ($value)

Protected Member Functions inherited from HtmlCollection
	getItemToAdd ($item)

	setItemIdentifier ($item, $classname, $index)

	createItem ($value)
	The item factory. More...

	createCondition ($value)

	contentAs ($tagName)

Protected Member Functions inherited from HtmlDoubleElement
	_getContentInstances ($class, $content)

	compile_once (\Ajax\JsUtils $js=NULL, &$view=NULL)
	{} More...

Protected Member Functions inherited from BaseHtml
	getTemplate (JsUtils $js=NULL, $view=null)

	ctrl ($name, $value, $typeCtrl)

	setMemberCtrl (&$name, $value, $typeCtrl)

	addToMemberUnique (&$name, $value, $typeCtrl, $separator=" ")

	addToMemberCtrl (&$name, $value, $typeCtrl, $separator=" ")

	addToMember (&$name, $value, $separator=' ')

	removeOldValues (&$oldValue, $allValues)

	_getElementBy ($callback, $elements)

	setWrapBefore ($wrapBefore)

	setWrapAfter ($wrapAfter)

	compile_once (JsUtils $js=NULL, &$view=NULL)

Protected Member Functions inherited from BaseWidget
	cleanIdentifier ($id)

Private Attributes
	$_createCols

	$_colSizing =true

	$_implicitRows =false

Additional Inherited Members
Protected Attributes inherited from HtmlDoubleElement
	$content

	$wrapContentBefore = ""

	$wrapContentAfter = ""

	$_editableContent

Protected Attributes inherited from BaseHtml
	$_template

	$tagName

	$_wrapBefore = array()

	$_wrapAfter = array()

	$_bsComponent

	$_compiled = false

	$_runned = false

	$_postCompile

	$_preCompile

Protected Attributes inherited from BaseWidget
	$identifier

	$_identifier

	$_libraryId

	$_self

Detailed Description

Semantic Grid component.

See also: http://semantic-ui.com/collections/grid.html

Author: jc

Version: 1.001

Definition at line 18 of file HtmlGrid.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$numRows = `1`,
		$numCols = `NULL`,
		$createCols = `true`,
		$implicitRows = `false`
	)

Definition at line 24 of file HtmlGrid.php.

Member Function Documentation

◆ addCol()

addCol ( $width = NULL )

Adds a col.

Parameters

int $width with of the column to add

Returns: mixed|

Definition at line 82 of file HtmlGrid.php.

◆ addCols()

addCols ( $sizes = array() )

Parameters

array $sizes array of width of the columns to create

Returns

Definition at line 95 of file HtmlGrid.php.

◆ addDivider()

addDivider	(	$afterColIndex,
		$vertical = `true`,
		$content = `NULL`
	)

Adds a divider after the specified col.

Parameters

integer	$afterColIndex
boolean	$vertical
mixed	$content

Returns

Definition at line 329 of file HtmlGrid.php.

◆ addRow()

addRow ( $colsCount = NULL )

Adds a row with $colsCount columns.

Parameters

int $colsCount number of columns to create

Returns: mixed

Definition at line 71 of file HtmlGrid.php.

◆ asContainer()

asContainer ( )

Definition at line 40 of file HtmlGrid.php.

◆ asSegment()

asSegment ( )

Definition at line 36 of file HtmlGrid.php.

◆ colCount()

colCount ( )

Returns the column count.

Returns: int

Definition at line 190 of file HtmlGrid.php.

◆ createItem()

createItem ( $value )

protected

See also: createItem()

Definition at line 281 of file HtmlGrid.php.

◆ getCell()

getCell	(	$row,
		$col
	)

Returns the cell (HtmlGridCol) at position $row,$col.

Parameters

int	$row
int	$col

Returns: HtmlGridCol|HtmlGridRow

Definition at line 205 of file HtmlGrid.php.

◆ getItem()

getItem ( $index )

Returns: HtmlGridRow

Definition at line 171 of file HtmlGrid.php.

◆ getRow()

getRow ( $index )

return the row at $index

Parameters

int $index

Returns: HtmlGridRow

Definition at line 164 of file HtmlGrid.php.

◆ hasOnlyCols()

hasOnlyCols ( $count )

protected

Definition at line 129 of file HtmlGrid.php.

◆ rowCount()

rowCount ( )

Returns the row count.

Returns: int

Definition at line 179 of file HtmlGrid.php.

◆ setCelled()

setCelled ( $internally = false )

Divides rows into cells.

Parameters

boolean $internally true for internal cells

Returns

Definition at line 230 of file HtmlGrid.php.

◆ setCentered()

setCentered ( )

A grid can have its columns centered.

Definition at line 238 of file HtmlGrid.php.

◆ setColsCount()

setColsCount	(	$numCols,
		$toCreate = `true`,
		$width = `NULL`
	)

Defines the number of columns in the grid.

Parameters

int	$numCols
boolean	$toCreate
int	$width

Returns

Definition at line 140 of file HtmlGrid.php.

◆ setColWidth()

setColWidth	(	$numCol,
		$width
	)

Definition at line 307 of file HtmlGrid.php.

◆ setDivided()

setDivided ( $vertically = false )

Adds dividers between columns ($vertically=false) or between rows ($vertically=true)

Parameters

boolean $vertically

Returns

Definition at line 220 of file HtmlGrid.php.

◆ setEqualWidth()

setEqualWidth ( )

automatically resize all elements to split the available width evenly

Returns

Definition at line 246 of file HtmlGrid.php.

◆ setPadded()

setPadded ( $value = NULL )

Adds vertical or/and horizontal gutters.

Parameters

string $value

Returns

Definition at line 255 of file HtmlGrid.php.

◆ setRelaxed()

setRelaxed ( $very = false )

Parameters

boolean $very

Returns

Definition at line 266 of file HtmlGrid.php.

◆ setRowsCount()

setRowsCount	(	$rowsCount,
		$colsCount = `NULL`,
		$force = `false`
	)

Create $rowsCount rows.

Parameters

int	$rowsCount
int	$colsCount

Returns

Definition at line 108 of file HtmlGrid.php.

◆ setStretched()

setStretched ( )

stretch the row contents to take up the entire column height

Returns

Definition at line 318 of file HtmlGrid.php.

◆ setValues()

setValues	(	$values,
		$force = `true`
	)

Sets $values to the grid.

Parameters

array $values

Definition at line 292 of file HtmlGrid.php.

◆ setVerticalAlignment()

setVerticalAlignment ( $value = VerticalAlignment::MIDDLE )

Definition at line 271 of file HtmlGrid.php.

◆ setWide()

setWide ( $wide )

Defines the grid width (alias for setWidth)

Parameters

int $wide

Definition at line 48 of file HtmlGrid.php.

◆ setWidth()

setWidth ( $width )

Defines the grid width.

Parameters

int $width

Returns

Definition at line 62 of file HtmlGrid.php.

Field Documentation

◆ $_colSizing

$_colSizing =true

private

Definition at line 21 of file HtmlGrid.php.

◆ $_createCols

$_createCols

private

Definition at line 20 of file HtmlGrid.php.

◆ $_implicitRows

$_implicitRows =false

private

Definition at line 22 of file HtmlGrid.php.

The documentation for this class was generated from the following file:

Ajax/semantic/html/collections/HtmlGrid.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCol()

◆ addCols()

◆ addDivider()

◆ addRow()

◆ asContainer()

◆ asSegment()

◆ colCount()

◆ createItem()

◆ getCell()

◆ getItem()

◆ getRow()

◆ hasOnlyCols()

◆ rowCount()

◆ setCelled()

◆ setCentered()

◆ setColsCount()

◆ setColWidth()

◆ setDivided()

◆ setEqualWidth()

◆ setPadded()

◆ setRelaxed()

◆ setRowsCount()

◆ setStretched()

◆ setValues()

◆ setVerticalAlignment()

◆ setWide()

◆ setWidth()

Field Documentation

◆ $_colSizing

◆ $_createCols

◆ $_implicitRows