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 WidgetFactoryInterface

Create Widget objects applying default widget flags

The interface methods create and configure widget objects.

Direct known implementers

Nethgui\Renderer\Xhtml

Indirect known implementers

Nethgui\Module\Help\Renderer, Nethgui\Widget\Xhtml\ElementRenderer
Namespace: Nethgui\Renderer
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
See: Nethgui\Renderer\WidgetInterface
Api
Located at Renderer/WidgetFactoryInterface.php
Methods summary
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
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
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
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
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
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\WidgetFactoryInterface::textLabel()

Api
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\WidgetFactoryInterface::textLabel()

Api
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
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
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
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
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
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\WidgetFactoryInterface::radioButton()

Api
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
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
public Nethgui\Renderer\WidgetInterface
# panel( integer $flags = 0 )

Create a panel container

Create a panel container

Parameters

$flags

Returns

Nethgui\Renderer\WidgetInterface

Api
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
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
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
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
public Nethgui\Renderer\WidgetInterface
# progressbar( $name, $flags = 0 )

Create a progress bar

Create a progress bar

  • name View member holding the percent value Int range [0, 100]

Returns

Nethgui\Renderer\WidgetInterface

See

554


Api
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
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
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\WidgetFactoryInterface::textArea()

Api
public Nethgui\Renderer\WidgetInterface
# dateInput( $name, $flags )

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
public Nethgui\Renderer\WidgetInterface
# timeInput( $name, $flags )

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
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
public Nethgui\Renderer\WidgetInterface
# slider( $name, $flags )

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
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
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
public
# fileUpload( string $name, integer $flags = 0 )

Create a file upload widget

Create a file upload widget

Parameters

$name
$flags
Constants summary
integer LABEL_NONE
# 0x1
integer LABEL_LEFT
# 0x2
integer LABEL_RIGHT
# 0x4
integer LABEL_ABOVE
# 0x8
integer STATE_CHECKED
# 0x10
integer STATE_DISABLED
# 0x20
integer STATE_VALIDATION_ERROR
# 0x40
integer STATE_READONLY
# 0x80
integer STATE_UNOBSTRUSIVE

Deprecated

since 1.6
# 0x2000000
integer STATE_UNOBTRUSIVE
# 0x2000000
integer INSET_WRAP
# 0x8000
integer INSET_FORM
# 0x10000
integer INSET_DIALOG
# 0x4000
integer BUTTON_SUBMIT
# 0x100
integer BUTTON_CANCEL
# 0x200
integer BUTTON_RESET
# 0x400
integer BUTTON_LINK
# 0x800
integer BUTTON_CUSTOM
# 0x1000
integer SELECTOR_MULTIPLE
# 0x40000
integer SELECTOR_DROPDOWN
# 0x80000
integer TEXTINPUT_PASSWORD
# 0x100000
integer FIELDSET_EXPANDABLE
# 0x200000
integer BUTTONSET
# 0x400000
integer BUTTON_DROPDOWN
# 0x800000
integer BUTTON_HELP
# 0x1000000
integer FIELDSETSWITCH_CHECKBOX
# 0x4000000
integer FIELDSETSWITCH_EXPANDABLE
# self::FIELDSET_EXPANDABLE
integer SLIDER_ENUMERATIVE
# 0x8000000
integer FORM_ENC_MULTIPART
# 0x10000000
Nethgui Framework API documentation generated by ApiGen