Overview

Namespaces

  • Nethgui
    • Adapter
    • Authorization
    • Component
    • Controller
      • Collection
      • Table
    • Exception
    • Log
    • Model
    • Module
      • Help
      • Notification
    • Renderer
    • Serializer
    • System
    • Test
      • Tool
      • Unit
        • Nethgui
          • Adapter
            • ParameterSet
          • Authorization
          • Log
          • Module
            • Notification
          • Renderer
          • Serializer
          • System
          • Utility
          • View
        • Test
          • Tool
    • Utility
    • View
    • Widget
      • Xhtml
  • None
  • Test
    • Tool

Classes

  • AbstractRenderer
  • Json
  • ReadonlyView
  • TemplateRenderer
  • Xhtml

Interfaces

  • WidgetFactoryInterface
  • WidgetInterface
  • Overview
  • Namespace
  • Class
  • Deprecated

Interface WidgetInterface

Help in the creation of the view output. A widget

  • is rendered as a string

  • can be nested in a hierarchical way through the insert() method

  • is configured by setting its attributes

Implementations define the attribute semantic.

Direct known implementers

Nethgui\Widget\AbstractWidget

Indirect known implementers

Nethgui\Module\Help\Widget, Nethgui\Widget\Xhtml\Button, Nethgui\Widget\Xhtml\Hidden, Nethgui\Widget\Xhtml\ObjectPicker, Nethgui\Widget\Xhtml\ObjectsCollection, Nethgui\Widget\Xhtml\Panel, Nethgui\Widget\Xhtml\ProgressBar, Nethgui\Widget\Xhtml\RadioButton, Nethgui\Widget\Xhtml\Selector, Nethgui\Widget\Xhtml\Slider, Nethgui\Widget\Xhtml\Tabs, Nethgui\Widget\Xhtml\TextArea, Nethgui\Widget\Xhtml\CheckBox, Nethgui\Widget\Xhtml\TextInput, Nethgui\Widget\Xhtml\TextLabel, Nethgui\Widget\Xhtml\TextList, Nethgui\Widget\XhtmlWidget, Nethgui\Widget\Xhtml\CollectionEditor, Nethgui\Widget\Xhtml\Columns, Nethgui\Widget\Xhtml\ElementList, Nethgui\Widget\Xhtml\Fieldset, Nethgui\Widget\Xhtml\FieldsetSwitch, Nethgui\Widget\Xhtml\FileUpload, Nethgui\Widget\Xhtml\Form
Namespace: Nethgui\Renderer
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
Api
Located at Renderer/WidgetInterface.php
Methods summary
public Nethgui\Renderer\WidgetInterface
# insert( Nethgui\Renderer\WidgetInterface $widget )

Nest $widget into the current object

Nest $widget into the current object

Parameters

$widget
Another widget to be nested inside the current object

Returns

Nethgui\Renderer\WidgetInterface
the current object

Api

public Nethgui\Renderer\WidgetInterface
# setAttribute( string $attribute, mixed $value )

Set the given $attribute to $value

Set the given $attribute to $value

Parameters

$attribute
The attribute name
$value
Any value to be assigned to the attribute

Returns

Nethgui\Renderer\WidgetInterface
the current object

Api

public boolean
# hasAttribute( string $attribute )

Checks if the widget has the given $attribute

Checks if the widget has the given $attribute

Parameters

$attribute
The attribute name

Returns

boolean
TRUE, if the $attribute has been set to any value

Api

public
# getAttribute( string $attribute, mixed $default = NULL )

Read an attribute value.

Read an attribute value.

If the attribute has not been set return the given default value.

The second argument can also be a callable. In this case, it is invoked only if a default value is needed, and is expected to return that value. The attribute name will be passed as first function argument.

Parameters

$attribute
The attribute name
$default
The default value or callable closure/function.

Api

public string
# render( )

Transform the current object in a string value.

Transform the current object in a string value.

Returns

string

Api

Nethgui Framework API documentation generated by ApiGen