internal package Foswiki::Configure::UIs::Section

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

Child packagesChild packages

internal package Foswiki::Configure::UIs::Section; is a Foswiki::Configure::UIs::Item

A UI for a collection object. The layout of a configuration page is depth-sensitive, so we have slightly different behaviours for each of level 0 (the root), level 1 (tab sections) and level > 1 (subsection).

ObjectMethod renderHtml($section, $root, $contents) → ($html, \%properties)

Overrides Foswiki::Configure::UIs::Item

Sections are of two types; "plain" and "tabbed". A plain section formats all its subsections inline, in a table. A tabbed section formats all its subsections as tabs.

• $section the Foswiki::Configure::Section
• $root the Foswiki::Configure::UIs::Root
• $contents is the content (a set of table rows) to use for the section if there are no configuration items.

PROTECTED ObjectMethod renderValueBlock($string) -> $html

Render a value block. This is exported so that UIs can render value strings other than those composed of configuration items e.g. the environment.

Only for use by subclasses.