You are here: Foswiki>System Web>ReferenceManual>DeveloperDocumentationCategory>PerlDoc (19 Apr 2011, ProjectContributor)EditAttach

internal package Foswiki::Configure::UIs

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

  • Foswiki::Configure::UIs::AUTH - Specialised UI for the AUTH screen. This implements a special method that is used by configure to filter out certain URL parameters (the passwords), and pass through all others as CGI::hidden.
  • Foswiki::Configure::UIs::CGISetup - Specialised UI for the CGI Setup section. This provides a renderHtml method that generates the bespokse screen for this section. This could all be done in a specialised Foswiki::Configure::Section type, but since all the data is read only, it was easier this way (if somewhat less elegant).
  • Foswiki::Configure::UIs::EXTEND - Specialised UI used by configure to generate the extension installation screen (and to actually perform the installation). Does not use the conventional renderHtml interface, instead implementing a special 'install' method.
  • Foswiki::Configure::UIs::EXTENSIONS - Specialised UI; an implementation of the "Find more extensions" UI screen. When this screen is visited, the remote extensions repositories are visited to pull down details of available extensions. These are then presented in custom tabular form.
  • Foswiki::Configure::UIs::FINDEXTENSIONS - This package is a placeholder for creating a UI for the *FINDEXTENSIONS* section. It provides specialised rendering by prepending the normal section rendering with the 'findextensionsinfo' template.
  • Foswiki::Configure::UIs::Introduction - UI used by configure to generate the introduction from a template.
  • Foswiki::Configure::UIs::Item
  • Foswiki::Configure::UIs::LANGUAGES - This package is a placeholder for creating a UI for the *LANGUAGES* section. No special UI behaviour is required - it's just a simple section with standard Value types in the model.
  • Foswiki::Configure::UIs::MSWin32 - Specialised UI for the MSWin32 checks. This provides a renderHtml method that generates the bespoke screen for this section.
  • Foswiki::Configure::UIs::PLUGINS - This package is a placeholder for creating a UI for the *PLUGINS* section. No special UI behaviour is required - it's just a simple section with standard Value types in the model.
  • Foswiki::Configure::UIs::Root - Specialisation of Foswiki::Configure::UIs::Section for the root of the model.
  • Foswiki::Configure::UIs::Section - 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).
  • Foswiki::Configure::UIs::TESTEMAIL - This package is a placeholder for creating a UI for the *TESTEMAIL* section. It provides specialised rendering by prepending the normal section rendering with the 'findextensionsinfo' template.
  • Foswiki::Configure::UIs::UPDATE - Special UI, invoked directly from configure, that implements the save changes screen.
  • Foswiki::Configure::UIs::Value - This is the UI object for a single configuration item. It must not be confused with Foswiki::Configure::Value, which is the value object that models a configuration item. There will be one corresponding Foswiki::Configure::Value for each object of this class.
  • Foswiki::Configure::UIs::Welcome - UI used by configure when a brand spanking new user is detected.

Edit | Attach | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions
Topic revision: r1 - 19 Apr 2011, ProjectContributor
 
This site is powered by FoswikiCopyright © CC-BY-SA by the contributing authors. All material on this collaboration platform is copyrighted under CC-BY-SA by the contributing authors unless otherwise noted.
Ideas, requests, problems regarding Foswiki? Send feedback