Class Xhtml

Enanches the abstract renderer with the wiget factory interface

Fragments of the view string representation can be generated through the widget objects returned by the factory interface.

Nethgui\Renderer\ReadonlyView implements Nethgui\View\ViewInterface, Nethgui\Log\LogConsumerInterface

Nethgui\Renderer\AbstractRenderer

Nethgui\Renderer\TemplateRenderer implements Nethgui\Utility\PhpConsumerInterface, Nethgui\Module\ModuleAttributesInterface, Nethgui\Component\DependencyConsumer

Nethgui\Renderer\Xhtml implements Nethgui\Renderer\WidgetFactoryInterface, Nethgui\Component\DependencyInjectorAggregate

Direct known subclasses

Nethgui\Module\Help\Renderer, Nethgui\Widget\Xhtml\ElementRenderer

Namespace: Nethgui\Renderer
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
Api
Located at Renderer/Xhtml.php

Methods summary
`public`	# `__construct( Nethgui\View\ViewInterface $view, callable $templateResolver, string $inheritFlags, string $charset,… )` Parameters `$view` `$templateResolver` `$inheritFlags` $contentType `$charset`,… Overrides `Nethgui\Renderer\TemplateRenderer::__construct()`
`public Nethgui\Renderer\Xhtml`	# `spawnRenderer( Nethgui\View\ViewInterface $view )` Parameters `$view` Returns `Nethgui\Renderer\Xhtml` Api Overrides `Nethgui\Renderer\TemplateRenderer::spawnRenderer()`
`protected`	# `createWidget( $widgetType, $attributes = array() )`
`public Nethgui\Renderer\Xhtml`	# `includeJavascript( string $jsCode )` Append a Javascript code fragment to the global .js temporary file Append a Javascript code fragment to the global .js temporary file Parameters `$jsCode` Raw Javascript code Returns `Nethgui\Renderer\Xhtml` Api
`public Nethgui\Renderer\Xhtml`	# `includeCss( string $cssCode )` Append a CSS code fragment to the global .css temporary file Append a CSS code fragment to the global .css temporary file Parameters `$cssCode` Raw Css code Returns `Nethgui\Renderer\Xhtml` Api
`public Nethgui\Renderer\Xhtml`	# `includeFile( string $fileName )` Append the given file to a global temporary file with the same extension. Append the given file to a global temporary file with the same extension. The file path is relative to the /Resource/ directory. The is assumed to be the same of the module. Parameters `$fileName` Returns `Nethgui\Renderer\Xhtml` Api
`public Nethgui\Renderer\Xhtml`	# `includeTranslations( array\|Traversable $keys )` Transfer the given translation strings to the javascript environment. Transfer the given translation strings to the javascript environment. Parameters `$keys` Returns `Nethgui\Renderer\Xhtml` See $.Nethgui.Translator in jquery.nethgui.base.js
`public Nethgui\Renderer\Xhtml`	# `requireFlag( integer $flags )` $flag bits are ORed on the widget that include this view. $flag bits are ORed on the widget that include this view. Parameters `$flags` Returns `Nethgui\Renderer\Xhtml` Api
`public Nethgui\Renderer\Xhtml`	# `rejectFlag( integer $flags )` $flag bits are masked on the widget that include this view. $flag bits are masked on the widget that include this view. Parameters `$flags` Returns `Nethgui\Renderer\Xhtml` See `Nethgui\Renderer\Xhtml::requireFlag()` Api
`public`	# `calculateIncludeFlags( integer $widgetFlags )` Calculate flags for view inclusion Calculate flags for view inclusion Parameters `$widgetFlags` See \Nethgui\Widget\Xhtml\Inset
`public Nethgui\Renderer\Xhtml`	# `useFile( string $fileName )` Link an external file into the final XHTML document Link an external file into the final XHTML document The XHTML tag generated depends on the file extension. Javascript (.js) needs the SCRIPT tag, External stylesheets (.css) a LINK tag. Parameters `$fileName` Returns `Nethgui\Renderer\Xhtml` Api
`public integer`	# `getDefaultFlags( )` The default flags inherited by widget generated by this factory. The default flags inherited by widget generated by this factory. Returns integer Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::getDefaultFlags()`
`public Nethgui\Renderer\WidgetFactoryInterface`	# `setDefaultFlags( integer $flags )` The default flags inherited by widget generated by this factory. The default flags inherited by widget generated by this factory. Parameters `$flags` Returns `Nethgui\Renderer\WidgetFactoryInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::setDefaultFlags()`
`public Nethgui\Renderer\WidgetInterface`	# `elementList( integer $flags = 0 )` Create a list of elements Create a list of elements Add the actual elements invoking the insert() operation of the returned object. Parameters `$flags` Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::elementList()`
`public Nethgui\Renderer\WidgetInterface`	# `buttonList( integer $flags = 0 )` Create a list of button elements Create a list of button elements Add the actual elements invoking the insert() operation of the returned object. Parameters `$flags` Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::buttonList()`
`public Nethgui\Renderer\WidgetInterface`	# `button( string $name, integer $flags = 0 )` Create a button control Create a button control Parameters `$name` The view member name `$flags` Optional Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::button()`
`public Nethgui\Renderer\WidgetInterface`	# `checkBox( string $name, string $value, integer $flags = 0 )` Create a checkbox control Create a checkbox control Optionally specify the "uncheckedValue" to get a value from the form when the checkbox is unchecked. Parameters `$name` The view member name `$value` The value assigned to the control, when checked. `$flags` Optional {STATE_DISABLED, STATE_CHECKED} Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::checkBox()`
`public Nethgui\Renderer\WidgetInterface`	# `fieldsetSwitch( string $name, string $value, integer $flags = 0 )` Create a selectable fieldset container Create a selectable fieldset container Set FIELDSETSWITCH_CHECKBOX flag to get a checkbox switch, otherwise a radioButton is rendered Set FIELDSETSWITCH_EXPANDABLE flag to fold out the fieldset, when selected Parameters `$name` `$value` `$flags` Returns `Nethgui\Renderer\WidgetInterface` See checkbox(), `Nethgui\Renderer\Xhtml::radioButton()` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::fieldsetSwitch()`
`public Nethgui\Renderer\WidgetInterface`	# `form( integer $flags = 0 )` Create a simple form container. Create a simple form container. Parameters `$flags` Optional - {STATE_DISABLED} Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::form()`
`public Nethgui\Renderer\WidgetInterface`	# `hidden( string $name, integer $flags = 0 )` Create an hidden control Create an hidden control Parameters `$name` The view member name `$flags` Optional {STATE_DISABLED} Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::hidden()`
`public Nethgui\Renderer\WidgetInterface`	# `inset( string $name, integer $flags = 0 )` Include a view element that is a sub-view Include a view element that is a sub-view Parameters `$name` The view member name `$flags` Optional {STATE_DISABLED} Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::inset()`
`public Nethgui\Renderer\WidgetInterface`	# `panel( integer $flags = 0 )` Create a panel container Create a panel container Parameters `$flags` Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::panel()`
`public Nethgui\Renderer\WidgetInterface`	# `radioButton( string $name, string $value, integer $flags = 0 )` Create a radio button control Create a radio button control Parameters `$name` The view member name `$value` The value assigned to the control, when selected. `$flags` Optional {STATE_DISABLED, STATE_CHECKED} Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::radioButton()`
`public Nethgui\Renderer\WidgetInterface`	# `selector( string $name, integer $flags = 0 )` Create a selector control Create a selector control Parameters `$name` The view member name holding the selected value(s) `$flags` Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::selector()`
`public Nethgui\Renderer\WidgetInterface`	# `tabs( integer $flags = 0 )` Create a tabs container. Create a tabs container. Parameters `$flags` {STATE_DISABLED} Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::tabs()`
`public Nethgui\Renderer\WidgetInterface`	# `textInput( string $name, integer $flags = 0 )` Create a text input control Create a text input control Parameters `$name` The view member name `$flags` Optional {STATE_DISABLED} Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::textInput()`
`public Nethgui\Renderer\WidgetInterface`	# `textLabel( string $name, integer $flags = 0 )` Create a text label. Create a text label. Parameters `$name` The view member name to generate the label contents `$flags` Optional {STATE_DISABLED} Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::textLabel()`
`public Nethgui\Renderer\WidgetInterface`	# `fieldset( string $name = NULL, integer $flags = 0 )` Create a fieldset container Create a fieldset container Parameters `$name` OPTIONAL - The view member passed as argument for the "template" attribute. `$flags` OPTIONAL - flags Returns `Nethgui\Renderer\WidgetInterface` See `Nethgui\Renderer\Xhtml::textLabel()` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::fieldset()`
`public Nethgui\Renderer\WidgetInterface`	# `header( string $name = NULL, $flags = 0 )` Create a text header control Create a text header control Parameters `$name` OPTIONAL - The view member passed as argument for the "template" attribute. `$flags` Returns `Nethgui\Renderer\WidgetInterface` See `Nethgui\Renderer\Xhtml::textLabel()` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::header()`
`public Nethgui\Renderer\WidgetInterface`	# `literal( string\|object\|Nethgui\View\ViewInterface $data, $flags = 0 )` Create literal data - helper. Create literal data - helper. Parameters `$data` Can be a string, any object implementing toString() method, or a View. `$flags` Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::literal()`
`public Nethgui\Renderer\WidgetInterface`	# `columns( )` Create a column container - helper. Create a column container - helper. Add the actual columns through the insert() operation of the returned object Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::columns()`
`public`	# `progressBar( $name, $flags = 0 )`
`public Nethgui\Renderer\WidgetInterface`	# `textArea( string $name, integer $flags = 0 )` Create a text area Create a text area Attributes: - dimensions - appendOnly Parameters `$name` `$flags` Returns `Nethgui\Renderer\WidgetInterface` See 556 Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::textArea()`
`public Nethgui\Renderer\WidgetInterface`	# `collectionEditor( string $name, integer $flags = 0 )` A javascript-configurable object collection editor, with a TEXTAREA backend. A javascript-configurable object collection editor, with a TEXTAREA backend. Parameters `$name` `$flags` Returns `Nethgui\Renderer\WidgetInterface` See 1446 Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::collectionEditor()`
`public Nethgui\Renderer\WidgetInterface`	# `console( $name, $flags = 0 )` Create a console-like text area Create a console-like text area Returns `Nethgui\Renderer\WidgetInterface` See `Nethgui\Renderer\Xhtml::textArea()` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::console()`
`public Nethgui\Renderer\WidgetInterface`	# `dateInput( $name, $flags = 0 )` Create a date picker widget: Create a date picker widget: Attributes: - class (string) "Date " plus one of "be" (default), "me", "le". Returns `Nethgui\Renderer\WidgetInterface` See 474 Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::dateInput()`
`public Nethgui\Renderer\WidgetInterface`	# `timeInput( $name, $flags = 0 )` Create a time picker widget: Create a time picker widget: Attributes: - class (string) "Time " plus one of "hm" or "hms" Returns `Nethgui\Renderer\WidgetInterface` Since 1.7 Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::timeInput()`
`public Nethgui\Renderer\WidgetInterface`	# `objectPicker( $name = NULL, $flags = 0 )` Pick/selects objects from a collection Pick/selects objects from a collection Returns `Nethgui\Renderer\WidgetInterface` See WidgetFactoryInterface::selector() Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::objectPicker()`
`public Nethgui\Renderer\WidgetInterface`	# `slider( $name, $flags = 0 )` Select a value in the given range. Select a value in the given range. Set attributes - min - max - step Returns `Nethgui\Renderer\WidgetInterface` See Feature #1242 Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::slider()`
`public Nethgui\Renderer\WidgetInterface`	# `textList( string $name, integer $flags = 0 )` Create a text list widget Create a text list widget Parameters `$name` A view element containing an array value `$flags` Returns `Nethgui\Renderer\WidgetInterface` Api Implementation of `Nethgui\Renderer\WidgetFactoryInterface::textList()`
`public`	# `objectsCollection( string $name, integer $flags = 0 )` Create widget that renders the given collection applying a specific template Create widget that renders the given collection applying a specific template Parameters `$name` A view element containing the collection data source `$flags` Implementation of `Nethgui\Renderer\WidgetFactoryInterface::objectsCollection()`
`public`	# `fileUpload( string $name, integer $flags = 0 )` Create a file upload widget Create a file upload widget Parameters `$name` `$flags` Implementation of `Nethgui\Renderer\WidgetFactoryInterface::fileUpload()`
`public array`	# `getDependencySetters( )` The returned hash is indexed by the model class name and has a callable objects as value. Each callable is invoked with the model instance as only argument. The returned hash is indexed by the model class name and has a callable objects as value. Each callable is invoked with the model instance as only argument. Returns array Overrides `Nethgui\Renderer\TemplateRenderer::getDependencySetters()`
`public`	# `setStaticFilesModel( Nethgui\Model\StaticFiles $model )`
`public Nethgui\Component\DependencyInjectorAggregate`	# `setDependencyInjector( callable $di )` Parameters `$di` Returns `Nethgui\Component\DependencyInjectorAggregate` The object itself Implementation of `Nethgui\Component\DependencyInjectorAggregate::setDependencyInjector()`

Methods inherited from Nethgui\Renderer\TemplateRenderer
`getCategory(), getCharset(), getContentType(), getDescription(), getLanguageCatalog(), getMenuPosition(), getTags(), getTemplateResolver(), getTitle(), render(), renderView(), setPhpWrapper()`

Methods inherited from Nethgui\Renderer\AbstractRenderer
`hashToDatasource()`

Methods inherited from Nethgui\Renderer\ReadonlyView
`copyFrom(), getClientEventTarget(), getCommandList(), getIterator(), getLog(), getModule(), getModulePath(), getModuleUrl(), getPathUrl(), getSiteUrl(), getTargetFormat(), getTemplate(), getTranslator(), getUniqueId(), hasCommandList(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), resolvePath(), setLog(), setTemplate(), spawnView(), translate()`

Methods inherited from Nethgui\Renderer\WidgetFactoryInterface
`progressbar()`

Constants inherited from Nethgui\View\ViewInterface
`TARGET_JSON, TARGET_XHTML`

Constants inherited from Nethgui\Renderer\WidgetFactoryInterface
`BUTTONSET, BUTTON_CANCEL, BUTTON_CUSTOM, BUTTON_DROPDOWN, BUTTON_HELP, BUTTON_LINK, BUTTON_RESET, BUTTON_SUBMIT, FIELDSETSWITCH_CHECKBOX, FIELDSETSWITCH_EXPANDABLE, FIELDSET_EXPANDABLE, FORM_ENC_MULTIPART, INSET_DIALOG, INSET_FORM, INSET_WRAP, LABEL_ABOVE, LABEL_LEFT, LABEL_NONE, LABEL_RIGHT, SELECTOR_DROPDOWN, SELECTOR_MULTIPLE, SLIDER_ENUMERATIVE, STATE_CHECKED, STATE_DISABLED, STATE_READONLY, STATE_UNOBSTRUSIVE, STATE_UNOBTRUSIVE, STATE_VALIDATION_ERROR, TEXTINPUT_PASSWORD`

Properties summary
`protected Nethgui\Model\StaticFiles`	`$staticFiles`	#

Properties inherited from Nethgui\Renderer\TemplateRenderer
`$httpResponse, $phpWrapper`

Properties inherited from Nethgui\Renderer\ReadonlyView
`$view`

Namespaces

Classes

Interfaces

Class Xhtml

Direct known subclasses

Parameters

Overrides

Parameters

Returns

Api

Overrides

Parameters

Returns

Api

Parameters

Returns

Api

Parameters

Returns

Api

Parameters

Returns

See

Parameters

Returns

Api

Parameters

Returns

See

Api

Parameters

See

Parameters

Returns

Api

Returns

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters

Returns

See

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters

Returns

Api

Implementation of

Parameters