static
hideField
($form, $field, [$speed = 0])
static
showField
($form, $field, [$speed = 0])
Create a field wrapper
static
wrapField
($field, $display, [$default_field_size = null])
-
$field
-
$display
-
$default_field_size
Constructor method
__construct
([$name = 'my_form'])
Add a form action
addAction
($label, $action, [$icon = 'fa:save'])
-
$label: Button label
-
$action: Button action
-
$icon: Button icon
Add a form action link
addActionLink
($label, $action, [$icon = 'fa:save'])
-
$label: Button label
-
$action: Button action
-
$icon: Button icon
Add a form button
addButton
($label, $action, [$icon = 'fa:save'])
-
$label: Button label
-
$action: JS Button action
-
$icon: Button icon
Add a form content
addContent
($content,...)
-
$content,...: Form content
Add expand button
addExpandButton
([$label = null], [$icon = null], [$start_hidden = true])
-
$label
-
$icon
-
$start_hidden
Add form field
addField
($field)
Add form fields
addFields
($fields,...)
Add a form footer widget
addFooterWidget
($widget)
Add a form header action
addHeaderAction
($label, $action, [$icon = 'fa:save'])
-
$label: Button label
-
$action: Button action
-
$icon: Button icon
Add a form header action
addHeaderActionLink
($label, $action, [$icon = 'fa:save'])
-
$label: Button label
-
$action: Button action
-
$icon: Button icon
Add a form header widget
addHeaderWidget
($widget)
Append a notebook page
appendPage
($title)
Clear form
clear
([$keepDefaults = FALSE])
Clear actions row
delActions
()
Del form field
delField
($field)
Enable CSRF Protection
enableCSRFProtection
()
Generate automatic aria-labels
generateAria
()
Return an array with action buttons
getActionButtons
()
Return form actions
getActions
()
Returns the element content as a string
getContents
()
Get form data
getData
([$class = 'StdClass'])
-
$class: Object type of return data
Return form field
getField
($name)
Return form fields
getFields
()
Turn on/off client validation
setClientValidation
($bool)
setColumnClasses
($key, $classes)
Define the current page to be shown
setCurrentPage
($i)
-
$i: An integer representing the page number (start at 0)
Set form data
setData
($object)
Set form fields
setFields
($fields)
-
$fields: Array of Form fields
Set field sizes
setFieldSizes
($size)
Add a form title
setFormTitle
($title)
Define a header style property
setHeaderProperty
($name, $value)
-
$name: Property Name
-
$value: Property Value
Set form name
setName
($name)
Set padding
setPadding
($padding)
Define a style property
setProperty
($name, $value)
-
$name: Property Name
-
$value: Property Value
Define the action for the Notebook tab
setTabAction
($action)
-
$action: Action taken when the user clicks over Notebook tab (A TAction object)
Set tab click function
setTabFunction
($function)
Validate form data
validate
()
Validate argument type
validateInlineArguments
($args, $method)
-
$args: Array of arguments
-
$method: Generator method
Redirect calls to decorated object
__call
($method, $parameters)
Redirect assigns to decorated object
__set
($property, $value)
Converts the object into a string
__toString
()