Class panel

UIX panel. a holder to contain sections. a panel with multiple sections creates a tabbed interface to switch between sections areas.

uix\ui\uix

uix\data\data

uix\ui\panel

Direct known subclasses

uix\ui\box, uix\ui\metabox, uix\ui\modal, uix\ui\repeat, uix\ui\section

Indirect known subclasses

uix\ui\footer, uix\ui\grid, uix\ui\header, uix\ui\page

Namespace: uix\ui
Package: uix\ui
Author: David Cramer
Located at classes/uix/ui/panel.php

Methods summary

`protected`	# `enqueue_active_assets( )` Enqueues specific tabs assets for the active pages Enqueues specific tabs assets for the active pages Since 1.0.0 Overrides `uix\ui\uix::enqueue_active_assets`
`public`	# `set_assets( )` Define core panel styles ans scripts Define core panel styles ans scripts Since 1.0.0 Overrides `uix\ui\uix::set_assets`
`public array\|null`	# `get_data( )` Get Data from all controls of this section Get Data from all controls of this section Returns array\|null Array of sections data structured by the controls or null if none. Since 1.0.0 See \uix\load Overrides `uix\data\data::get_data`
`public`	# `set_data( mixed $data )` Sets the data for all children Sets the data for all children Parameters `$data` the data to be set Since 1.0.0 Overrides `uix\data\data::set_data`
`public string`	# `render( )` Render the panel Render the panel Returns string HTML of rendered object Since 1.0.0
`public string\|null`	# `navigation( )` Render the panels navigation tabs Render the panels navigation tabs Returns string\|null Html of rendered navigation tabs Since 1.0.0
`public integer`	# `child_count( )` Determines the number of useable children for tab display Determines the number of useable children for tab display Returns integer Number of tabable children Since 1.0.0
`public string\|null`	# `label( )` Render the panels label Render the panels label Returns string\|null rendered html of label Since 1.0.0
`public string\|null`	# `description( )` Render the panels Description Render the panels Description Returns string\|null HTML of rendered description Since 1.0.0
`public string\|null`	# `is_section_object( uix\ui\uix $section )` Check if child is a section object Check if child is a section object Parameters `$section` to test if it is to be rendered in a section Returns string\|null HTML of rendered description Since 1.0.0
`public string\|null`	# `panel_section( )` Render the panels Description Render the panels Description Returns string\|null HTML of rendered description Since 1.0.0
`public string\|null`	# `render_template( )` Render a template based object Render a template based object Returns string\|null HTML of rendered template Since 1.0.0
`public`	# `wrapper_class_names( )` Returns the class names for the tab wrapper Returns the class names for the tab wrapper Since 1.0.0

Methods inherited from uix\data\data

setup()

Methods inherited from uix\ui\uix

__call(), __construct(), actions(), base_color(), build_attributes(), enqueue_core(), id(), init(), is_active(), process_child(), process_children(), register(), render_children(), set_attributes(), set_url()

Properties summary

`public string`	`$type` The type of object The type of object Since 1.0.0	# `'panel'`

Properties inherited from uix\data\data

$data

Properties inherited from uix\ui\uix

$assets, $attributes, $child, $parent, $scripts, $slug, $struct, $styles, $url

`protected`	# `enqueue_active_assets( )` Enqueues specific tabs assets for the active pages Enqueues specific tabs assets for the active pages Since 1.0.0 Overrides `uix\ui\uix::enqueue_active_assets`
`public`	# `set_assets( )` Define core panel styles ans scripts Define core panel styles ans scripts Since 1.0.0 Overrides `uix\ui\uix::set_assets`
`public array\|null`	# `get_data( )` Get Data from all controls of this section Get Data from all controls of this section Returns array\|null Array of sections data structured by the controls or null if none. Since 1.0.0 See \uix\load Overrides `uix\data\data::get_data`
`public`	# `set_data( mixed $data )` Sets the data for all children Sets the data for all children Parameters `$data` the data to be set Since 1.0.0 Overrides `uix\data\data::set_data`
`public string`	# `render( )` Render the panel Render the panel Returns string HTML of rendered object Since 1.0.0
`public string\|null`	# `navigation( )` Render the panels navigation tabs Render the panels navigation tabs Returns string\|null Html of rendered navigation tabs Since 1.0.0
`public integer`	# `child_count( )` Determines the number of useable children for tab display Determines the number of useable children for tab display Returns integer Number of tabable children Since 1.0.0
`public string\|null`	# `label( )` Render the panels label Render the panels label Returns string\|null rendered html of label Since 1.0.0
`public string\|null`	# `description( )` Render the panels Description Render the panels Description Returns string\|null HTML of rendered description Since 1.0.0
`public string\|null`	# `is_section_object( uix\ui\uix $section )` Check if child is a section object Check if child is a section object Parameters `$section` to test if it is to be rendered in a section Returns string\|null HTML of rendered description Since 1.0.0
`public string\|null`	# `panel_section( )` Render the panels Description Render the panels Description Returns string\|null HTML of rendered description Since 1.0.0
`public string\|null`	# `render_template( )` Render a template based object Render a template based object Returns string\|null HTML of rendered template Since 1.0.0
`public`	# `wrapper_class_names( )` Returns the class names for the tab wrapper Returns the class names for the tab wrapper Since 1.0.0

Namespaces

Classes

Class panel

Direct known subclasses

Indirect known subclasses

Methods summary

Since

Overrides

Since

Overrides

Returns

Since

See

Overrides

Parameters

Since

Overrides

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Since

Methods inherited from uix\data\data

Methods inherited from uix\ui\uix

Properties summary

Since

Properties inherited from uix\data\data

Properties inherited from uix\ui\uix