Inheritance diagram for HtmlFormField:

Public Member Functions

__construct ($identifier, $field, $label=NULL)

addPointingLabel ($label, $pointing=Direction::NONE)

setLabel ($label)

setField ($field)

getLabel ()

Returns the label or null.

getField ()

Return the field.

getDataField ()

Return the field with data.

swapLabel ()

puts the label before or behind

setWidth ($width)

Defines the field width.

setError ()

Field displays an error state.

setInline ()

jsState ($state)

setContainer ($_container)

setReadonly ()

addRule ($type, $prompt=NULL, $value=NULL)

setOptional ($optional=true)

addRules (array $rules)

setRules (array $rules)

addIcon ($icon, $direction=Direction::LEFT)

getValidation ()

setSize ($size)

run (JsUtils $js)

{{

Parameters

JsUtils $js

Returns: SimpleExtComponent

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

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

}

See also: HtmlDoubleElement::run()

}

Public Member Functions inherited from HtmlSemDoubleElement

__construct ($identifier, $tagName="p", $baseClass="ui", $content=NULL)

setPopupAttributes ($variation=NULL, $popupEvent=NULL)

Defines the popup attributes.

addPopup ($title="", $content="", $variation=NULL, $params=array())

Adds a popup to the element.

addPopupHtml ($html="", $variation=NULL, $params=array())

Adds an html popup to the element.

addDimmer ($params=array(), $content=NULL)

Adds a Dimmer to the element.

addLabel ($label, $before=false, $icon=NULL)

Adds a label to the element.

attachLabel ($label, $side=Side::TOP, $direction=Direction::NONE, $icon=NULL)

Adds an attached label to the element.

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

Transforms the element into a link.

jsShowDimmer ($show=true)

Returns the script displaying the dimmer.

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

{}

addList ($items, $ordered=false)

asToast ($params=NULL)

asSideBar ($classes='')

Public Member Functions inherited from HtmlDoubleElement

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

setContent ($content)

getContent ()

addContent ($content, $before=false)

setValue ($value)

wrapContent ($before, $after="")

wrapWith (HtmlDoubleElement $container)

Wraps the element with a container.

getContentInstances ($class)

getTextContent ()

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

Public Member Functions inherited from HtmlSingleElement

setClass ($classNames)

addClass ($classNames)

setRole ($value)

setTitle ($value)

setStyle ($value)

fromArray ($array)

Public Member Functions inherited from BaseHtml

getTagName ()

setTagName ($tagName)

fromDatabaseObjects ($objects, $function)

fromDatabaseObject ($object, $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 ()

setProperties ($properties)

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)

addSticky ($context="body")

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 FieldTrait

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

addLabel ($caption, $style="label-default", $leftSeparator=" ")

addContent ($content, $before=false)

setFocus ()

addLoading ()

labeled ($label, $direction=Direction::LEFT, $icon=NULL)

labeledCheckbox ($direction=Direction::LEFT, $caption="", $value=NULL, $checkboxType=NULL)

labeledToCorner ($icon, $direction=Direction::LEFT)

addAction ($action, $direction=Direction::RIGHT, $icon=NULL, $labeled=false)

addDropdown ($label="", $items=array(), $direction=Direction::RIGHT)

setTransparent ()

setName ($name)

setFluid ()

setDisabled ($disable=true)

setJsContent ($content)

getJsContent ()

asFile ($caption='', $direction=Direction::RIGHT, $icon='cloud upload alternate', $labeled=false)

Protected Attributes
	$_container

	$_validation

Protected Attributes inherited from HtmlSemDoubleElement
	$_popup = NULL

	$_dimmer = NULL

	$_toast = NULL

	$_sidebar = NULL

	$_params = array()

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

Additional Inherited Members
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="")

Detailed Description

Definition at line 15 of file HtmlFormField.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$field,
		$label = `NULL`
	)

Definition at line 21 of file HtmlFormField.php.

Member Function Documentation

◆ addIcon()

addIcon	(	$icon,
		$direction = `Direction::LEFT`
	)

Reimplemented from BaseTrait.

Definition at line 177 of file HtmlFormField.php.

◆ addPointingLabel()

addPointingLabel	(	$label,
		$pointing = `Direction::NONE`
	)

Definition at line 34 of file HtmlFormField.php.

◆ addRule()

addRule	(	$type,
		$prompt = `NULL`,
		$value = `NULL`
	)

Definition at line 137 of file HtmlFormField.php.

◆ addRules()

addRules ( array $rules )

Definition at line 165 of file HtmlFormField.php.

◆ getDataField()

getDataField ( )

Return the field with data.

Returns: mixed

Reimplemented from FieldTrait.

Reimplemented in HtmlFormDropdown, HtmlFormInput, and HtmlFormTextarea.

Definition at line 79 of file HtmlFormField.php.

◆ getField()

getField ( )

Return the field.

Returns: mixed

Reimplemented from FieldTrait.

Definition at line 70 of file HtmlFormField.php.

◆ getLabel()

getLabel ( )

Returns the label or null.

Returns: mixed

Definition at line 60 of file HtmlFormField.php.

◆ getValidation()

getValidation ( )

Definition at line 182 of file HtmlFormField.php.

◆ jsState()

jsState ( $state )

Definition at line 124 of file HtmlFormField.php.

◆ run()

run ( JsUtils $js )

{{

Parameters

JsUtils $js

Returns: SimpleExtComponent

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

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

}

See also: HtmlDoubleElement::run()

}

See also: HtmlDoubleElement::run()

Reimplemented from HtmlSemDoubleElement.

Definition at line 190 of file HtmlFormField.php.

◆ setContainer()

setContainer ( $_container )

Definition at line 128 of file HtmlFormField.php.

◆ setError()

setError ( )

Field displays an error state.

Returns: \Ajax\semantic\html\collections\form\HtmlFormField

Definition at line 116 of file HtmlFormField.php.

◆ setField()

setField ( $field )

Definition at line 51 of file HtmlFormField.php.

◆ setInline()

setInline ( )

Definition at line 120 of file HtmlFormField.php.

◆ setLabel()

setLabel ( $label )

Definition at line 41 of file HtmlFormField.php.

◆ setOptional()

setOptional ( $optional = true )

Definition at line 155 of file HtmlFormField.php.

◆ setReadonly()

setReadonly ( )

Reimplemented from FieldTrait.

Definition at line 133 of file HtmlFormField.php.

◆ setRules()

setRules ( array $rules )

Definition at line 172 of file HtmlFormField.php.

◆ setSize()

setSize ( $size )

Reimplemented from HtmlSingleElement.

Definition at line 186 of file HtmlFormField.php.

◆ setWidth()

setWidth ( $width )

Defines the field width.

Parameters

int $width

Returns: \Ajax\semantic\html\collections\form\HtmlFormField

Definition at line 98 of file HtmlFormField.php.

◆ swapLabel()

swapLabel ( )

puts the label before or behind

Definition at line 86 of file HtmlFormField.php.

Field Documentation

◆ $_container

$_container

protected

Definition at line 17 of file HtmlFormField.php.

◆ $_validation

$_validation

protected

Definition at line 19 of file HtmlFormField.php.

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

Ajax/semantic/html/collections/form/HtmlFormField.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addIcon()

◆ addPointingLabel()

◆ addRule()

◆ addRules()

◆ getDataField()

◆ getField()

◆ getLabel()

◆ getValidation()

◆ jsState()

◆ run()

◆ setContainer()

◆ setError()

◆ setField()

◆ setInline()

◆ setLabel()

◆ setOptional()

◆ setReadonly()

◆ setRules()

◆ setSize()

◆ setWidth()

◆ swapLabel()

Field Documentation

◆ $_container

◆ $_validation