Semantic Grid component. More...

Inheritance 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)

setWidth ($width)

Defines the grid width.

addRow ($colsCount=NULL)

Adds a row with $colsCount columns.

addCol ($width=NULL)

Adds a col.

addCols ($sizes=array())

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

Create $rowsCount rows.

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

Defines the number of columns in the grid.

getRow ($index)

return the row at $index

getItem ($index)

rowCount ()

Returns the row count.

colCount ()

Returns the column count.

getCell ($row, $col)

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

setDivided ($vertically=false)

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

setCelled ($internally=false)

Divides rows into cells.

setCentered ()

A grid can have its columns centered.

setEqualWidth ()

automatically resize all elements to split the available width evenly

setPadded ($value=NULL)

Adds vertical or/and horizontal gutters.

setRelaxed ($very=false)

setVerticalAlignment ($value=VerticalAlignment::MIDDLE)

setValues ($values, $force=true)

Sets $values to the grid.

setColWidth ($numCol, $width)

setStretched ()

stretch the row contents to take up the entire column height

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

Adds a divider after the specified col.

Public Member Functions inherited from HtmlSemCollection

__construct ( $identifier, $tagName="div", $baseClass="")

run (JsUtils $js)

Parameters

JsUtils $js

Returns: SimpleExtComponent

See also: \Ajax\common\html\BaseHtmlrun()

See also: \Ajax\common\html\BaseHtmlrun()

Public Member Functions inherited from HtmlCollection

__construct ($identifier, $tagName="div")

addItems ($items)

setItems ($items)

getItems ()

addItem ($item)

adds and returns an item

insertItem ($item, $position=0)

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.

addPropertyValues ($property, $values)

Adds the values of a property for each item in the collection.

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.

Public Member Functions inherited from HtmlDoubleElement

setContent ($content)

getContent ()

addContent ($content, $before=false)

setValue ($value)

wrapContent ($before, $after="")

wrapWith (HtmlDoubleElement $container)

Wraps the element with a container.

getContentInstances ($class)

asLink ($href=NULL, $target=NULL)

Transforms the element into a link.

getTextContent ()

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

Public Member Functions inherited from HtmlSingleElement

setClass ($classNames)

addClass ($classNames)

setRole ($value)

setTitle ($value)

setStyle ($value)

setSize ($size)

Public Member Functions inherited from BaseHtml

getTagName ()

setTagName ($tagName)

fromDatabaseObjects ($objects, $function)

wrap ($before, $after="")

getElementById ($identifier, $elements)

getBsComponent ()

setBsComponent ($bsComponent)

setDraggable ($attr="id", $dropZone=null, $parameters=[])

Sets the element draggable, and eventualy defines the dropzone (HTML5 drag and drop)

asDropZone ($jsCallback="", $jqueryDone="append", $parameters=[])

Declares the element as a drop zone (HTML5 drag and drop)

asFileDropZone ($responseElement=null, $url=null, $progress=null, $jsCallback="", $parameters=[])

Declares the element as a drop zone for file uploading (HTML5 drag and drop)

__toString ()

onPostCompile ($callback)

onPreCompile ($callback)

Public Member Functions inherited from BaseWidget

__construct ($identifier)

getIdentifier ()

setIdentifier ($identifier)

getLibraryId ()

setLibraryId ($_libraryId)

Public Member Functions inherited from BaseHtmlEventsTrait

addEvent ($event, $jsCode, $stopPropagation=false, $preventDefault=false)

trigger ($event, $params="[]")

jsTrigger ($event, $params="[this]")

_addEvent ($event, $jsCode)

on ($event, $jsCode, $stopPropagation=false, $preventDefault=false)

onClick ($jsCode, $stopPropagation=false, $preventDefault=true)

setClick ($jsCode)

onCreate ($jsCode)

addEventsOnRun (JsUtils $js=NULL)

_ajaxOn ($operation, $event, $url, $responseElement="", $parameters=array())

getOn ($event, $url, $responseElement="", $parameters=array())

Performs a get to $url on the event $event on $element and display it in $responseElement.

getOnClick ($url, $responseElement="", $parameters=array())

Performs a get to $url on the click event on $element and display it in $responseElement.

postOn ($event, $url, $params="{}", $responseElement="", $parameters=array())

Performs a post to $url on the event $event on $element and display it in $responseElement.

postOnClick ($url, $params="{}", $responseElement="", $parameters=array())

Performs a post to $url on the click event on $element and display it in $responseElement.

postFormOn ($event, $url, $form, $responseElement="", $parameters=array())

Performs a post form with ajax.

postFormOnClick ($url, $form, $responseElement="", $parameters=array())

Performs a post form with ajax on click.

jsDoJquery ($jqueryCall, $param="")

executeOnRun ($jsCode)

jsHtml ($content="")

jsShow ()

jsHide ()

jsToggle ($value)

getEvents ()

Public Member Functions inherited from BaseHtmlPropertiesTrait

getProperties ()

setProperty ($name, $value)

getProperty ($name)

addToProperty ($name, $value, $separator=" ")

addProperties ($properties)

removePropertyValue ($name, $value)

addToPropertyCtrl ($name, $value, $typeCtrl)

addToPropertyCtrlCheck ($name, $value, $typeCtrl)

removeProperty ($name)

propertyContains ($propertyName, $value)

Public Member Functions inherited from BaseTrait

addToProperty ($name, $value, $separator=" ")

setProperty ($name, $value)

addContent ($content, $before=false)

onCreate ($jsCode)

addVariation ($variation)

addState ($state)

setVariation ($variation)

setVariations ($variations)

setState ($state)

addVariations ($variations=array())

addStates ($states=array())

setStates ($states)

addIcon ($icon, $before=true)

addSticky ($context="body")

setSize ($size)

setDisabled ($disable=true)

show it is currently unable to be interacted with

setColor ($color)

setFluid ()

asHeader ()

setActive ($value=true)

show it is currently the active user selection

setAttached ($value=true)

setInverted ($recursive=true)

can be formatted to appear on dark backgrounds

setCircular ()

setFloated ($direction="right")

floatRight ()

floatLeft ()

getBaseClass ()

getVariations ()

getStates ()

Public Member Functions inherited from TextAlignmentTrait

addToPropertyCtrl ($name, $value, $typeCtrl)

setTextAlignment ($value=TextAlignment::LEFT)

textCenterAligned ()

textJustified ()

textRightAligned ()

textLeftAligned ()

Protected Member Functions

hasOnlyCols ($count)

createItem ($value)

The item factory.

Parameters

mixed $value

Protected Member Functions inherited from HtmlCollection

getItemToAdd ($item)

setItemIdentifier ($item, $classname, $index)

createCondition ($value)

contentAs ($tagName)

Protected Member Functions inherited from HtmlDoubleElement

_getContentInstances ($class, $content)

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

{}

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)

Protected Member Functions inherited from BaseHtmlEventsTrait

_eventsOnCreate (JsUtils $js=NULL)

Protected Member Functions inherited from BaseHtmlPropertiesTrait

removePropertyValues ($name, $values)

addToPropertyUnique ($name, $value, $typeCtrl)

setPropertyCtrl ($name, $value, $typeCtrl)

getElementByPropertyValue ($propertyName, $value, $elements)

Protected Member Functions inherited from BaseTrait

setPropertyCtrl ($name, $value, $typeCtrl)

addToPropertyCtrl ($name, $value, $typeCtrl)

addToPropertyCtrlCheck ($name, $value, $typeCtrl)

addBehavior (&$array, $key, $value, $before="", $after="")

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

Protected Attributes inherited from BaseHtmlEventsTrait
	$_events =array ()

Protected Attributes inherited from BaseHtmlPropertiesTrait
	$properties =array ()

Protected Attributes inherited from BaseTrait
	$_variations =[ ]

	$_states =[ ]

	$_baseClass

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 23 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|\Ajax\semantic\html\collections\HtmlGrid

Definition at line 81 of file HtmlGrid.php.

◆ addCols()

addCols ( $sizes = array() )

Parameters

array $sizes array of width of the columns to create

Returns: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 94 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: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 328 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 70 of file HtmlGrid.php.

◆ asContainer()

asContainer ( )

Definition at line 39 of file HtmlGrid.php.

◆ asSegment()

asSegment ( )

Definition at line 35 of file HtmlGrid.php.

◆ colCount()

colCount ( )

Returns the column count.

Returns: int

Definition at line 189 of file HtmlGrid.php.

◆ createItem()

createItem ( $value )

protected

The item factory.

Parameters

mixed $value

See also: \Ajax\common\html\HtmlCollection::createItem()

Reimplemented from HtmlCollection.

Definition at line 280 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 204 of file HtmlGrid.php.

◆ getItem()

getItem ( $index )

Returns: HtmlGridRow

Reimplemented from HtmlCollection.

Definition at line 170 of file HtmlGrid.php.

◆ getRow()

getRow ( $index )

return the row at $index

Parameters

int $index

Returns: HtmlGridRow

Definition at line 163 of file HtmlGrid.php.

◆ hasOnlyCols()

hasOnlyCols ( $count )

protected

Definition at line 128 of file HtmlGrid.php.

◆ rowCount()

rowCount ( )

Returns the row count.

Returns: int

Definition at line 178 of file HtmlGrid.php.

◆ setCelled()

setCelled ( $internally = false )

Divides rows into cells.

Parameters

boolean $internally true for internal cells

Returns: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 229 of file HtmlGrid.php.

◆ setCentered()

setCentered ( )

A grid can have its columns centered.

Definition at line 237 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: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 139 of file HtmlGrid.php.

◆ setColWidth()

setColWidth	(	$numCol,
		$width
	)

Definition at line 306 of file HtmlGrid.php.

◆ setDivided()

setDivided ( $vertically = false )

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

Parameters

boolean $vertically

Returns: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 219 of file HtmlGrid.php.

◆ setEqualWidth()

setEqualWidth ( )

automatically resize all elements to split the available width evenly

Returns: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 245 of file HtmlGrid.php.

◆ setPadded()

setPadded ( $value = NULL )

Adds vertical or/and horizontal gutters.

Parameters

string $value

Returns: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 254 of file HtmlGrid.php.

◆ setRelaxed()

setRelaxed ( $very = false )

Parameters

boolean $very

Returns: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 265 of file HtmlGrid.php.

◆ setRowsCount()

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

Create $rowsCount rows.

Parameters

int	$rowsCount
int	$colsCount

Returns: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 107 of file HtmlGrid.php.

◆ setStretched()

setStretched ( )

stretch the row contents to take up the entire column height

Returns: \Ajax\semantic\html\content\HtmlGridRow

Definition at line 317 of file HtmlGrid.php.

◆ setValues()

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

Sets $values to the grid.

Parameters

array $values

Definition at line 291 of file HtmlGrid.php.

◆ setVerticalAlignment()

setVerticalAlignment ( $value = VerticalAlignment::MIDDLE )

Definition at line 270 of file HtmlGrid.php.

◆ setWide()

setWide ( $wide )

Defines the grid width (alias for setWidth)

Parameters

int $wide

Definition at line 47 of file HtmlGrid.php.

◆ setWidth()

setWidth ( $width )

Defines the grid width.

Parameters

int $width

Returns: \Ajax\semantic\html\collections\HtmlGrid

Definition at line 61 of file HtmlGrid.php.

Field Documentation

◆ $_colSizing

$_colSizing =true

private

Definition at line 20 of file HtmlGrid.php.

◆ $_createCols

$_createCols

private

Definition at line 19 of file HtmlGrid.php.

◆ $_implicitRows

$_implicitRows =false

private

Definition at line 21 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