Twitter Bootstrap HTML Navbar component. More...

Inheritance diagram for HtmlNavbar:

Public Member Functions
	__construct ($identifier, $brand="Brand", $brandHref="#")

	setClass ($class)

	setBrand ($brand)

	setBrandHref ($brandHref)

	setBrandTarget ($brandTarget)

	setBrandImage ($imageSrc)

	addZone ($type="nav", $identifier=NULL)
	adds a new zone of type $type

	addElement ($element, HtmlNavzone $zone=NULL)

	addElements ($elements, HtmlNavzone $zone=NULL)

	fromArray ($array)
	/* (non-PHPdoc)

	setNavZones ($navZones)

	getZoneToInsertIn ($zone=NULL)

	getZone ($index)

	run (JsUtils $js)

	cssInverse ()

	scrollspy ($attachTo="body")

	setFluid ($fluid)

	fromDatabaseObject ($object, $function)

Public Member Functions inherited from BaseHtml
	getTagName ()

	setTagName ($tagName)

	fromDatabaseObjects ($objects, $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)

	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)

Protected Attributes
	$navZones

	$class ="navbar-default"

	$brand ="Brand"

	$brandHref ="#"

	$brandTarget ="_self"

	$brandImage =""

	$scrollspy

	$hasScrollspy =false

	$scrollspyId ="body"

	$fluid ="container-fluid"

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

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

Detailed Description

Twitter Bootstrap HTML Navbar component.

Author: jc

Version: 1.001

Definition at line 16 of file HtmlNavbar.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$brand = `"Brand"`,
		$brandHref = `"#"`
	)

Parameters

string $identifier the id

Definition at line 32 of file HtmlNavbar.php.

Member Function Documentation

◆ addElement()

addElement	(		$element,
		HtmlNavzone	$zone = `NULL`
	)

Definition at line 84 of file HtmlNavbar.php.

◆ addElements()

addElements	(		$elements,
		HtmlNavzone	$zone = `NULL`
	)

Definition at line 91 of file HtmlNavbar.php.

◆ addZone()

addZone	(	$type = `"nav"`,
		$identifier = `NULL`
	)

adds a new zone of type $type

Parameters

string	$type	one of nav, form, btn, right, left
string	$identifier

Returns: HtmlNavzone

Definition at line 74 of file HtmlNavbar.php.

◆ cssInverse()

cssInverse ( )

Definition at line 169 of file HtmlNavbar.php.

◆ fromArray()

fromArray ( $array )

/* (non-PHPdoc)

See also: BaseHtml::addProperties()

Reimplemented from BaseHtml.

Definition at line 101 of file HtmlNavbar.php.

◆ fromDatabaseObject()

fromDatabaseObject	(	$object,
		$function
	)

Reimplemented from BaseHtml.

Definition at line 191 of file HtmlNavbar.php.

◆ getZone()

getZone ( $index )

Parameters

int $index

Returns: HtmlNavzone

Definition at line 140 of file HtmlNavbar.php.

◆ getZoneToInsertIn()

getZoneToInsertIn ( $zone = NULL )

Parameters

HtmlNavzone $zone

Returns: HtmlNavzone

Definition at line 124 of file HtmlNavbar.php.

◆ run()

run ( JsUtils $js )

Parameters

JsUtils $js

Returns: SimpleExtComponent

Reimplemented from BaseHtml.

Definition at line 157 of file HtmlNavbar.php.

◆ scrollspy()

scrollspy ( $attachTo = "body" )

Definition at line 174 of file HtmlNavbar.php.

◆ setBrand()

setBrand ( $brand )

Definition at line 47 of file HtmlNavbar.php.

◆ setBrandHref()

setBrandHref ( $brandHref )

Definition at line 52 of file HtmlNavbar.php.

◆ setBrandImage()

setBrandImage ( $imageSrc )

Definition at line 62 of file HtmlNavbar.php.

◆ setBrandTarget()

setBrandTarget ( $brandTarget )

Definition at line 57 of file HtmlNavbar.php.

◆ setClass()

setClass ( $class )

Definition at line 42 of file HtmlNavbar.php.

◆ setFluid()

setFluid ( $fluid )

Definition at line 179 of file HtmlNavbar.php.

◆ setNavZones()

setNavZones ( $navZones )

Definition at line 105 of file HtmlNavbar.php.

Field Documentation

◆ $brand

$brand ="Brand"

protected

Definition at line 19 of file HtmlNavbar.php.

◆ $brandHref

$brandHref ="#"

protected

Definition at line 20 of file HtmlNavbar.php.

◆ $brandImage

$brandImage =""

protected

Definition at line 22 of file HtmlNavbar.php.

◆ $brandTarget

$brandTarget ="_self"

protected

Definition at line 21 of file HtmlNavbar.php.

◆ $class

$class ="navbar-default"

protected

Definition at line 18 of file HtmlNavbar.php.

◆ $fluid

$fluid ="container-fluid"

protected

Definition at line 26 of file HtmlNavbar.php.

◆ $hasScrollspy

$hasScrollspy =false

protected

Definition at line 24 of file HtmlNavbar.php.

◆ $navZones

$navZones

protected

Definition at line 17 of file HtmlNavbar.php.

◆ $scrollspy

$scrollspy

protected

Definition at line 23 of file HtmlNavbar.php.

◆ $scrollspyId

$scrollspyId ="body"

protected

Definition at line 25 of file HtmlNavbar.php.

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

Ajax/bootstrap/html/HtmlNavbar.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addElement()

◆ addElements()

◆ addZone()

◆ cssInverse()

◆ fromArray()

◆ fromDatabaseObject()

◆ getZone()

◆ getZoneToInsertIn()

◆ run()

◆ scrollspy()

◆ setBrand()

◆ setBrandHref()

◆ setBrandImage()

◆ setBrandTarget()

◆ setClass()

◆ setFluid()

◆ setNavZones()

Field Documentation

◆ $brand

◆ $brandHref

◆ $brandImage

◆ $brandTarget

◆ $class

◆ $fluid

◆ $hasScrollspy

◆ $navZones

◆ $scrollspy

◆ $scrollspyId